Appearance

fTokenActions ​

Git Source

Inherits:fTokenActionsCore

fToken public executable actions: deposit, mint, withdraw and redeem. All actions are optionally also available with an additional param to limit the maximum slippage, e.g. maximum assets used for minting x amount of shares.

Functions ​

deposit ​

Deposits assets for receiver and mints shares.

solidity
function deposit(uint256 assets_, address receiver_) public virtual nonReentrant returns (uint256 shares_);

deposit ​

same as fToken-deposit but with an additional setting for minimum output amount. reverts with fToken__MinAmountOut() if minAmountOut_ of shares is not reached

solidity
function deposit(uint256 assets_, address receiver_, uint256 minAmountOut_) external returns (uint256 shares_);

mint ​

Mints shares for receiver using underlying assets.

solidity
function mint(uint256 shares_, address receiver_) public virtual nonReentrant returns (uint256 assets_);

mint ​

same as fToken-mint but with an additional setting for maximum assets input amount. reverts with fToken__MaxAmount() if maxAssets_ of assets is surpassed to mint shares_.

solidity
function mint(uint256 shares_, address receiver_, uint256 maxAssets_) external returns (uint256 assets_);

withdraw ​

Withdraws assets to receiver and burns owner shares.

solidity
function withdraw(uint256 assets_, address receiver_, address owner_)
    public
    virtual
    nonReentrant
    returns (uint256 shares_);

withdraw ​

same as fToken-withdraw but with an additional setting for maximum shares burned. reverts with fToken__MaxAmount() if maxSharesBurn_ of shares burned is surpassed.

solidity
function withdraw(uint256 assets_, address receiver_, address owner_, uint256 maxSharesBurn_)
    external
    returns (uint256 shares_);

redeem ​

Redeems owner shares for assets to receiver.

solidity
function redeem(uint256 shares_, address receiver_, address owner_)
    public
    virtual
    nonReentrant
    returns (uint256 assets_);

redeem ​

same as fToken-redeem but with an additional setting for minimum output amount. reverts with fToken__MinAmountOut() if minAmountOut_ of assets is not reached.

solidity
function redeem(uint256 shares_, address receiver_, address owner_, uint256 minAmountOut_)
    external
    returns (uint256 assets_);