Wrapped Token Gateway#
The Aave Protocol operates exclusively with ERC-20 reserve tokens. To accommodate network gas tokens, the WrappedTokenGateway (previously called WETHGateway) is a helper contract that enables gas tokens (ETH, POL, etc.) to be wrapped or unwrapped to perform Aave Pool methods:
Supply
Borrow
Repay
Withdraw
The smart contract source code is available on GitHub.
Write Methods#
depositETH#
function depositETH( address, address onBehalfOf, uint16 referralCode) external payable overrideWraps and supplies gas tokens to the Aave Protocol. A corresponding amount of the wrapped aTokens are minted to the onBehalfOf address.
msg.value field of the transaction.Input Parameters:#
| Name | Type | Description |
|---|---|---|
| onBehalfOf | address | The address of the user who will receive the aTokens representing the supplied tokens |
| referralCode | uint16 | Inactive, can pass 0 as placeholder |
withdrawETH#
function withdrawETH( address, uint256 amount, address to) external overrideWithdraws amount of the supplied wrapped gas token, unwraps it and transfers to the to address. If the amount is uint(-1), the entire balance is withdrawn.
IERC20(aWETHAddress).approve(wrappedTokenGatewayAddress, amount)Input Parameters:#
| Name | Type | Description |
|---|---|---|
| amount | uint256 | amount of aWETH to withdraw and receive native ETH |
| to | address | The address of the user who will receive native ETH |
repayETH#
function repayETH( address, uint256 amount, uint256 rateMode, address onBehalfOf) external payable overrideRepays a borrow position of onBehalfOf's address for the specified amount (or for the whole amount, if amount of uint256(-1) is passed).
msg.value field of the transaction.Input Parameters:#
| Name | Type | Description |
|---|---|---|
| amount | uint256 | The amount to repay, or uint256(-1) if the user wants to repay everything |
| rateMode | uint256 | Should always be passed a value of 2 (variable rate mode) |
| onBehalfOf | address | The address for which msg.sender is repaying |
borrowETH#
function borrowETH( address, uint256 amount, uint256 interestRateMode, uint16 referralCode) external overrideBorrows amount of unwrapped network gas tokens to msg.sender.
IVariableDebtToken(wethAddress).approveDelegation(wrappedTokenGatewayAddress, amount)Input Parameters:#
| Name | Type | Description |
|---|---|---|
| amount | uint256 | The amount of ETH to borrow |
| interestRateMode | uint256 | Should always be passed a value of 2 (variable rate mode) |
| referralCode | uint16 | Integrators are assigned a referral code and can potentially receive rewards |
withdrawETHWithPermit#
function withdrawETHWithPermit( address, uint256 amount, address to, uint256 deadline, uint8 permitV, bytes32 permitR, bytes32 permitS) external overrideWithdraws amount of the supplied wrapped gas token, unwraps it and transfers to the to address. If the amount is uint(-1), the entire balance is withdrawn.
Input Parameters:#
| Name | Type | Description |
|---|---|---|
| amount | uint256 | The amount of aWETH to withdraw and receive native ETH |
| to | address | The address of the user who will receive native ETH |
| deadline | uint256 | Timestamp of signature expiration |
| permitV | uint8 | V parameter of ERC712 permit sig |
| permitR | bytes32 | R parameter of ERC712 permit sig |
| permitS | bytes32 | S parameter of ERC712 permit sig |
View Methods#
getWETHAddress#
function getWETHAddress() external view returns (address)Get WETH address used by WrappedTokenGatewayV3.
Return Values:#
| Type | Description |
|---|---|
address | The WETH address used by WrappedTokenGatewayV3 |