Documentation Index
Fetch the complete documentation index at: https://docs.relay.link/llms.txt
Use this file to discover all available pages before exploring further.
Solidity API
RelayPoolNativeGateway
Gateway contract for depositing and withdrawing native ETH to/from WETH-based RelayPools
Handles wrapping/unwrapping of ETH and provides slippage protection for all operations
EthTransferFailed
error EthTransferFailed()
OnlyWethCanSendEth
error OnlyWethCanSendEth()
RemainingEth
Error when ETH remains in contract after operation
SlippageExceeded
Error when slippage protection is triggered
WETH
The Wrapped ETH (WETH) contract
Used to wrap/unwrap native ETH for pool operations
constructor
constructor(address wethAddress) public
Parameters
| Name | Type | Description |
|---|
| wethAddress | address | Address of the Wrapped Native token contract |
deposit
function deposit(address pool, address receiver, uint256 minSharesOut) external payable returns (uint256 shares)
Parameters
| Name | Type | Description |
|---|
| pool | address | The address of the ERC4626 pool to deposit into |
| receiver | address | The address that will receive the pool shares |
| minSharesOut | uint256 | Minimum amount of shares to receive (slippage protection) |
Return Values
| Name | Type | Description |
|---|
| shares | uint256 | The amount of pool shares minted to the receiver |
mint
function mint(address pool, address receiver, uint256 minSharesOut) external payable returns (uint256 shares)
Parameters
| Name | Type | Description |
|---|
| pool | address | The address of the ERC4626 pool to mint shares from |
| receiver | address | The address that will receive the pool shares |
| minSharesOut | uint256 | Minimum amount of shares to receive (slippage protection) |
Return Values
| Name | Type | Description |
|---|
| shares | uint256 | The amount of pool shares minted to the receiver |
withdraw
function withdraw(address pool, uint256 assets, address receiver, uint256 maxSharesIn) external virtual returns (uint256 shares)
Parameters
| Name | Type | Description |
|---|
| pool | address | The address of the ERC4626 pool to withdraw from |
| assets | uint256 | Amount of native ETH to withdraw |
| receiver | address | The address that will receive the native ETH |
| maxSharesIn | uint256 | Maximum amount of shares to burn (slippage protection) |
Return Values
| Name | Type | Description |
|---|
| shares | uint256 | The amount of pool shares burned |
redeem
function redeem(address pool, uint256 shares, address receiver, uint256 minAssetsOut) external virtual returns (uint256 assets)
Parameters
| Name | Type | Description |
|---|
| pool | address | The address of the ERC4626 pool to redeem from |
| shares | uint256 | Amount of pool shares to redeem |
| receiver | address | The address that will receive the native ETH |
| minAssetsOut | uint256 | Minimum amount of ETH to receive (slippage protection) |
Return Values
| Name | Type | Description |
|---|
| assets | uint256 | The amount of native ETH sent to receiver |
safeTransferETH
function safeTransferETH(address to, uint256 value) internal
Parameters
| Name | Type | Description |
|---|
| to | address | Recipient of the ETH transfer |
| value | uint256 | Amount of ETH to transfer |
receive
receive() external payable
