PeripheryPayments

Last modified:

Functions

receive

  function receive(
  ) external

unwrapWCTN9

  function unwrapWCTN9(
    uint256 amountMinimum,
    address recipient
  ) external

Unwraps the contract's WCTN9 balance and sends it to recipient as CTN.

The amountMinimum parameter prevents malicious contracts from stealing WCTN9 from users.

Parameters:

NameTypeDescription
amountMinimumuint256The minimum amount of WCTN9 to unwrap
recipientaddressThe address receiving CTN

sweepToken

  function sweepToken(
    address token,
    uint256 amountMinimum,
    address recipient
  ) external

Transfers the full amount of a token held by this contract to recipient

The amountMinimum parameter prevents malicious contracts from stealing the token from users

Parameters:

NameTypeDescription
tokenaddressThe contract address of the token which will be transferred to recipient
amountMinimumuint256The minimum amount of token required for a transfer
recipientaddressThe destination address of the token

refundCTN

  function refundCTN(
  ) external

Refunds any CTN balance held by this contract to the msg.sender

Useful for bundling with mint or increase liquidity that uses ether, or exact output swaps that use ether for the input amount

pay

  function pay(
    address token,
    address payer,
    address recipient,
    uint256 value
  ) internal

Parameters:

NameTypeDescription
tokenaddressThe token to pay
payeraddressThe entity that must pay
recipientaddressThe entity that will receive payment
valueuint256The amount to pay