Skip to main content

PeripheryPayments

Functions#

receive#

function receive(
) external

unwrapWETH9#

function unwrapWETH9(
uint256 amountMinimum,
address recipient
) external

Unwraps the contract's WETH9 balance and sends it to recipient as ETH.

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

Parameters:#

NameTypeDescription
amountMinimumuint256The minimum amount of WETH9 to unwrap
recipientaddressThe address receiving ETH

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

refundETH#

function refundETH(
) external

Refunds any ETH 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