IFTokenNativeUnderlying
NATIVE_TOKEN_ADDRESS
function NATIVE_TOKEN_ADDRESS() external view returns (address)
address that is mapped to the chain native token at Liquidity
depositNative
function depositNative(address receiver_) external payable returns (uint256 shares_)
deposits msg.value
amount of native token for receiver_
.
msg.value
must be at least minDeposit()
amount; reverts otherwise.
Recommended to use depositNative()
with a minAmountOut_
param instead to set acceptable limit.
Return Values
Name | Type | Description |
---|---|---|
shares_ | uint256 | actually minted shares |
depositNative
function depositNative(address receiver_, uint256 minAmountOut_) external payable returns (uint256 shares_)
same as {depositNative} but with an additional setting for minimum output amount.
reverts with fToken__MinAmountOut()
if minAmountOut_
of shares is not reached
mintNative
function mintNative(uint256 shares_, address receiver_) external payable returns (uint256 assets_)
mints shares_
for receiver_
, paying with underlying native token.
shares_
must at least be minMint()
amount; reverts otherwise.
shares_
set to type(uint256).max not supported.
Note there might be tiny inaccuracies between requested shares_
and actually received shares amount.
Recommended to use depositNative()
over mint because it is more gas efficient and less likely to revert.
Recommended to use mintNative()
with a minAmountOut_
param instead to set acceptable limit.
Return Values
Name | Type | Description |
---|---|---|
assets_ | uint256 | deposited assets amount |
mintNative
function mintNative(uint256 shares_, address receiver_, uint256 maxAssets_) external payable returns (uint256 assets_)
same as {mintNative} but with an additional setting for minimum output amount.
reverts with fToken__MaxAmount()
if maxAssets_
of assets is surpassed to mint shares_
.
withdrawNative
function withdrawNative(uint256 assets_, address receiver_, address owner_) external returns (uint256 shares_)
withdraws assets_
amount in native underlying to receiver_
, burning shares of owner_
.
If assets_
equals uint256.max then the whole fToken balance of owner_
is withdrawn.This does not
consider withdrawal limit at liquidity so best to check with maxWithdraw()
before.
Note there might be tiny inaccuracies between requested assets_
and actually received assets amount.
Recommended to use withdrawNative()
with a maxSharesBurn_
param instead to set acceptable limit.
Return Values
Name | Type | Description |
---|---|---|
shares_ | uint256 | burned shares |
withdrawNative
function withdrawNative(uint256 assets_, address receiver_, address owner_, uint256 maxSharesBurn_) external returns (uint256 shares_)
same as {withdrawNative} but with an additional setting for minimum output amount.
reverts with fToken__MaxAmount()
if maxSharesBurn_
of shares burned is surpassed.
redeemNative
function redeemNative(uint256 shares_, address receiver_, address owner_) external returns (uint256 assets_)
redeems shares_
to native underlying to receiver_
, burning shares of owner_
.
If shares_
equals uint256.max then the whole balance of owner_
is withdrawn.This does not
consider withdrawal limit at liquidity so best to check with maxRedeem()
before.
Recommended to use withdrawNative()
over redeem because it is more gas efficient and can set specific amount.
Recommended to use redeemNative()
with a minAmountOut_
param instead to set acceptable limit.
Return Values
Name | Type | Description |
---|---|---|
assets_ | uint256 | withdrawn assets amount |
redeemNative
function redeemNative(uint256 shares_, address receiver_, address owner_, uint256 minAmountOut_) external returns (uint256 assets_)
same as {redeemNative} but with an additional setting for minimum output amount.
reverts with fToken__MinAmountOut()
if minAmountOut_
of assets is not reached.
withdrawWithSignatureNative
function withdrawWithSignatureNative(uint256 sharesToPermit_, uint256 assets_, address receiver_, address owner_, uint256 maxSharesBurn_, uint256 deadline_, bytes signature_) external returns (uint256 shares_)
withdraw amount of assets_
in native token with ERC-2612 permit signature for fToken approval.
owner_
signs ERC-2612 permit signature_
to give allowance of fTokens to msg.sender
.
Note there might be tiny inaccuracies between requested assets_
and actually received assets amount.
allowance via signature should cover previewWithdraw(assets_)
plus a little buffer to avoid revert.
Inherent trust assumption that msg.sender
will set receiver_
and minAmountOut_
as owner_
intends
(which is always the case when giving allowance to some spender).
Parameters
Name | Type | Description |
---|---|---|
sharesToPermit_ | uint256 | shares amount to use for EIP2612 permit(). Should cover previewWithdraw(assets_) + small buffer. |
assets_ | uint256 | amount of assets to withdraw |
receiver_ | address | receiver of withdrawn assets |
owner_ | address | owner to withdraw from (must be signature signer) |
maxSharesBurn_ | uint256 | maximum accepted amount of shares burned |
deadline_ | uint256 | deadline for signature validity |
signature_ | bytes | packed signature of signing the EIP712 hash for ERC-2612 permit |
Return Values
Name | Type | Description |
---|---|---|
shares_ | uint256 | burned shares amount |
redeemWithSignatureNative
function redeemWithSignatureNative(uint256 shares_, address receiver_, address owner_, uint256 minAmountOut_, uint256 deadline_, bytes signature_) external returns (uint256 assets_)
redeem amount of shares_
as native token with ERC-2612 permit signature for fToken approval.
owner_
signs ERC-2612 permit signature_
to give allowance of fTokens to msg.sender
.
Note there might be tiny inaccuracies between requested shares_
to redeem and actually burned shares.
allowance via signature must cover shares_
plus a tiny buffer.
Inherent trust assumption that msg.sender
will set receiver_
and minAmountOut_
as owner_
intends
(which is always the case when giving allowance to some spender).
Recommended to use withdrawNative()
over redeem because it is more gas efficient and can set specific amount.
Parameters
Name | Type | Description |
---|---|---|
shares_ | uint256 | amount of shares to redeem |
receiver_ | address | receiver of withdrawn assets |
owner_ | address | owner to withdraw from (must be signature signer) |
minAmountOut_ | uint256 | minimum accepted amount of assets withdrawn |
deadline_ | uint256 | deadline for signature validity |
signature_ | bytes | packed signature of signing the EIP712 hash for ERC-2612 permit |
Return Values
Name | Type | Description |
---|---|---|
assets_ | uint256 | withdrawn assets amount |
fTokenNativeUnderlying
Same as the {fToken} contract but with support for native token as underlying asset. Actual underlying asset is the wrapped native ERC20 version (e.g. WETH), which acts like any other fToken. But in addition the fTokenNativeUnderlying also has methods for doing all the same actions via the native token.
constructor
constructor(contract IFluidLiquidity liquidity_, contract IFluidLendingFactory lendingFactory_, contract IWETH9 weth_) public
Parameters
Name | Type | Description |
---|---|---|
liquidity_ | contract IFluidLiquidity | liquidity contract address |
lendingFactory_ | contract IFluidLendingFactory | lending factory contract address |
weth_ | contract IWETH9 | address of wrapped native token (e.g. WETH) |
liquidityCallback
function liquidityCallback(address, uint256, bytes) external virtual
transfers amount_
of token_
to liquidity. Only callable by liquidity contract.
this callback is used to optimize gas consumption (reducing necessary token transfers).
receive
receive() external payable
ErrorTypes
fTokenNativeUnderlying__TransferInsufficient
| | fToken Native Underlying | |********__********
thrown when native deposit is called but sent along msg.value
does not cover the deposit amount
uint256 internal constant fTokenNativeUnderlying__TransferInsufficient = 21001;
fTokenNativeUnderlying__UnexpectedLiquidityCallback
thrown when a liquidity callback is called for a native token operation
uint256 internal constant fTokenNativeUnderlying__UnexpectedLiquidityCallback = 21002;