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
RelayPool
ERC4626 vault that enables cross-chain asset bridging and yield generation
Receives bridged assets via Hyperlane, provides instant liquidity, and deposits idle funds into yield pools
OriginSettings
Configuration for an authorized origin chain and bridge
Parameters
struct OriginSettings {
uint32 chainId;
address bridge;
address curator;
uint256 maxDebt;
uint256 outstandingDebt;
address proxyBridge;
uint32 bridgeFee;
uint32 coolDown;
}
OriginParam
Parameters for adding a new origin
Parameters
struct OriginParam {
address curator;
uint32 chainId;
address bridge;
address proxyBridge;
uint256 maxDebt;
uint32 bridgeFee;
uint32 coolDown;
}
UnauthorizedCaller
error UnauthorizedCaller(address sender)
Parameters
| Name | Type | Description |
|---|
| sender | address | The address that attempted the unauthorized call |
UnauthorizedSwap
error UnauthorizedSwap(address token)
Parameters
| Name | Type | Description |
|---|
| token | address | The token address that was attempted to be swapped |
UnauthorizedOrigin
error UnauthorizedOrigin(uint32 chainId, address bridge)
Parameters
| Name | Type | Description |
|---|
| chainId | uint32 | The chain ID of the unauthorized origin |
| bridge | address | The bridge address of the unauthorized origin |
MessageAlreadyProcessed
error MessageAlreadyProcessed(uint32 chainId, address bridge, uint256 nonce)
Parameters
| Name | Type | Description |
|---|
| chainId | uint32 | The chain ID of the message origin |
| bridge | address | The bridge address of the message origin |
| nonce | uint256 | The nonce of the already processed message |
TooMuchDebtFromOrigin
error TooMuchDebtFromOrigin(uint32 chainId, address bridge, uint256 maxDebt, uint256 nonce, address recipient, uint256 amount)
Parameters
| Name | Type | Description |
|---|
| chainId | uint32 | The chain ID of the origin |
| bridge | address | The bridge address of the origin |
| maxDebt | uint256 | The maximum allowed debt for this origin |
| nonce | uint256 | The nonce of the rejected transaction |
| recipient | address | The intended recipient of the funds |
| amount | uint256 | The amount that would exceed the debt limit |
FailedTransfer
error FailedTransfer(address recipient, uint256 amount)
Parameters
| Name | Type | Description |
|---|
| recipient | address | The intended recipient of the transfer |
| amount | uint256 | The amount that failed to transfer |
InsufficientFunds
error InsufficientFunds(uint256 amount, uint256 balance)
Parameters
| Name | Type | Description |
|---|
| amount | uint256 | The amount available |
| balance | uint256 | The balance required |
NotAWethPool
Error when native currency is sent to a non-WETH pool
MessageTooRecent
error MessageTooRecent(uint32 chainId, address bridge, uint256 nonce, uint256 timestamp, uint32 coolDown)
Parameters
| Name | Type | Description |
|---|
| chainId | uint32 | The chain ID of the message origin |
| bridge | address | The bridge address of the message origin |
| nonce | uint256 | The nonce of the message |
| timestamp | uint256 | The timestamp of the message |
| coolDown | uint32 | The required cooldown period |
error SharePriceTooLow(uint256 actualPrice, uint256 minPrice)
Parameters
| Name | Type | Description |
|---|
| actualPrice | uint256 | The actual share price |
| minPrice | uint256 | The minimum acceptable share price |
SharePriceTooHigh
error SharePriceTooHigh(uint256 actualPrice, uint256 maxPrice)
Parameters
| Name | Type | Description |
|---|
| actualPrice | uint256 | The actual share price |
| maxPrice | uint256 | The maximum acceptable share price |
HYPERLANE_MAILBOX
address HYPERLANE_MAILBOX
WETH
The address of the WETH contract (used for native pools)
Set to WETH address for native currency pools, otherwise can be address(0)
FRACTIONAL_BPS_DENOMINATOR
uint256 FRACTIONAL_BPS_DENOMINATOR
outstandingDebt
Keeping track of the outstanding debt for ERC4626 computations
Represents funds that have been sent but not yet claimed from bridges
authorizedOrigins
mapping(uint32 => mapping(address => struct RelayPool.OriginSettings)) authorizedOrigins
messages
mapping(uint32 => mapping(address => mapping(uint256 => bytes))) messages
yieldPool
The address of the yield pool where funds are deposited
Must be an ERC4626 vault for the same underlying asset
tokenSwapAddress
UniswapV3 wrapper contract for token swaps
pendingBridgeFees
uint256 pendingBridgeFees
totalAssetsToStream
uint256 totalAssetsToStream
lastAssetsCollectedAt
uint256 lastAssetsCollectedAt
endOfStream
Timestamp when current streaming period ends
streamingPeriod
Duration over which collected assets are streamed
LoanEmitted
event LoanEmitted(uint256 nonce, address recipient, contract ERC20 asset, uint256 amount, struct RelayPool.OriginSettings origin, uint256 fees)
Parameters
| Name | Type | Description |
|---|
| nonce | uint256 | The unique identifier of the transaction |
| recipient | address | The address receiving the funds |
| asset | contract ERC20 | The asset being transferred |
| amount | uint256 | The total amount including fees |
| origin | struct RelayPool.OriginSettings | The origin settings for this bridge |
| fees | uint256 | The fee amount collected |
BridgeCompleted
event BridgeCompleted(uint32 chainId, address bridge, uint256 amount, uint256 fees)
Parameters
| Name | Type | Description |
|---|
| chainId | uint32 | The chain ID of the bridge origin |
| bridge | address | The bridge address on the origin chain |
| amount | uint256 | The total amount claimed |
| fees | uint256 | The fee amount collected |
OutstandingDebtChanged
event OutstandingDebtChanged(uint256 oldDebt, uint256 newDebt, struct RelayPool.OriginSettings origin, uint256 oldOriginDebt, uint256 newOriginDebt)
Parameters
| Name | Type | Description |
|---|
| oldDebt | uint256 | Previous total outstanding debt |
| newDebt | uint256 | New total outstanding debt |
| origin | struct RelayPool.OriginSettings | The origin settings involved |
| oldOriginDebt | uint256 | Previous outstanding debt for the origin |
| newOriginDebt | uint256 | New outstanding debt for the origin |
AssetsDepositedIntoYieldPool
event AssetsDepositedIntoYieldPool(uint256 amount, address yieldPool)
Parameters
| Name | Type | Description |
|---|
| amount | uint256 | The amount deposited |
| yieldPool | address | The yield pool address |
AssetsWithdrawnFromYieldPool
event AssetsWithdrawnFromYieldPool(uint256 amount, address yieldPool)
Parameters
| Name | Type | Description |
|---|
| amount | uint256 | The amount withdrawn |
| yieldPool | address | The yield pool address |
TokenSwapChanged
event TokenSwapChanged(address prevAddress, address newAddress)
Parameters
| Name | Type | Description |
|---|
| prevAddress | address | The previous swap contract address |
| newAddress | address | The new swap contract address |
YieldPoolChanged
event YieldPoolChanged(address oldPool, address newPool)
Parameters
| Name | Type | Description |
|---|
| oldPool | address | The previous yield pool address |
| newPool | address | The new yield pool address |
StreamingPeriodChanged
event StreamingPeriodChanged(uint256 oldPeriod, uint256 newPeriod)
Parameters
| Name | Type | Description |
|---|
| oldPeriod | uint256 | The previous streaming period |
| newPeriod | uint256 | The new streaming period |
OriginAdded
event OriginAdded(struct RelayPool.OriginParam origin)
Parameters
| Name | Type | Description |
|---|
| origin | struct RelayPool.OriginParam | The origin parameters |
OriginDisabled
event OriginDisabled(uint32 chainId, address bridge, uint256 maxDebt, uint256 outstandingDebt, address proxyBridge)
Parameters
| Name | Type | Description |
|---|
| chainId | uint32 | The chain ID of the disabled origin |
| bridge | address | The bridge address of the disabled origin |
| maxDebt | uint256 | The previous maximum debt limit |
| outstandingDebt | uint256 | The outstanding debt at time of disabling |
| proxyBridge | address | The proxy bridge address |
constructor
constructor(address hyperlaneMailbox, contract ERC20 asset, string name, string symbol, address baseYieldPool, address weth, address curator) public
Parameters
| Name | Type | Description |
|---|
| hyperlaneMailbox | address | The Hyperlane mailbox contract address |
| asset | contract ERC20 | The underlying asset for this vault |
| name | string | The name of the vault token |
| symbol | string | The symbol of the vault token |
| baseYieldPool | address | The initial yield pool for depositing assets |
| weth | address | The WETH contract address (for native currency pools) |
| curator | address | The address that will own the pool after deployment |
updateStreamingPeriod
function updateStreamingPeriod(uint256 newPeriod) public
Parameters
| Name | Type | Description |
|---|
| newPeriod | uint256 | The new streaming period in seconds |
updateYieldPool
function updateYieldPool(address newPool, uint256 minSharePriceFromOldPool, uint256 maxSharePricePriceFromNewPool) public
Parameters
| Name | Type | Description |
|---|
| newPool | address | The address of the new yield pool |
| minSharePriceFromOldPool | uint256 | The minimum acceptable share price when withdrawing from the old pool |
| maxSharePricePriceFromNewPool | uint256 | The maximum acceptable share price when depositing into the new pool |
addOrigin
function addOrigin(struct RelayPool.OriginParam origin) public
Parameters
| Name | Type | Description |
|---|
| origin | struct RelayPool.OriginParam | The origin parameters including chain ID, addresses, and limits |
disableOrigin
function disableOrigin(uint32 chainId, address bridge) public
Parameters
| Name | Type | Description |
|---|
| chainId | uint32 | The chain ID of the origin to disable |
| bridge | address | The bridge address of the origin to disable |
increaseOutstandingDebt
function increaseOutstandingDebt(uint256 amount, struct RelayPool.OriginSettings origin) internal
Parameters
| Name | Type | Description |
|---|
| amount | uint256 | The amount to increase debt by |
| origin | struct RelayPool.OriginSettings | The origin settings to update |
decreaseOutstandingDebt
function decreaseOutstandingDebt(uint256 amount, struct RelayPool.OriginSettings origin) internal
Parameters
| Name | Type | Description |
|---|
| amount | uint256 | The amount to decrease debt by |
| origin | struct RelayPool.OriginSettings | The origin settings to update |
maxDeposit
function maxDeposit(address) public view returns (uint256 maxAssets)
Parameters
| Name | Type | Description |
|---|
| address | |
Return Values
| Name | Type | Description |
|---|
| maxAssets | uint256 | The maximum amount of assets that can be deposited |
maxWithdraw
function maxWithdraw(address owner) public view returns (uint256 maxAssets)
Parameters
| Name | Type | Description |
|---|
| owner | address | The address to check withdrawal capacity for |
Return Values
| Name | Type | Description |
|---|
| maxAssets | uint256 | The maximum amount of assets that can be withdrawn |
maxMint
function maxMint(address receiver) public view returns (uint256 maxShares)
Parameters
| Name | Type | Description |
|---|
| receiver | address | The address that would receive the shares |
Return Values
| Name | Type | Description |
|---|
| maxShares | uint256 | The maximum amount of shares that can be minted |
maxRedeem
function maxRedeem(address owner) public view returns (uint256 maxShares)
Parameters
| Name | Type | Description |
|---|
| owner | address | The address to check redemption capacity for |
Return Values
| Name | Type | Description |
|---|
| maxShares | uint256 | The maximum amount of shares that can be redeemed |
totalAssets
function totalAssets() public view returns (uint256)
Return Values
| Name | Type | Description |
|---|
| [0] | uint256 | The total assets under management |
depositAssetsInYieldPool
function depositAssetsInYieldPool(uint256 amount) internal
Parameters
| Name | Type | Description |
|---|
| amount | uint256 | The amount of assets to deposit |
withdrawAssetsFromYieldPool
function withdrawAssetsFromYieldPool(uint256 amount, address recipient) internal
Parameters
| Name | Type | Description |
|---|
| amount | uint256 | The amount of assets to withdraw |
| recipient | address | The address to receive the withdrawn assets |
handle
function handle(uint32 chainId, bytes32 bridgeAddress, bytes data) external payable
Parameters
| Name | Type | Description |
|---|
| chainId | uint32 | The origin chain ID |
| bridgeAddress | bytes32 | The origin bridge address (as bytes32) |
| data | bytes | The encoded message data |
remainsToStream
function remainsToStream() internal view returns (uint256)
Return Values
| Name | Type | Description |
|---|
| [0] | uint256 | The amount of assets remaining to be streamed |
updateStreamedAssets
function updateStreamedAssets() public returns (uint256)
Return Values
| Name | Type | Description |
|---|
| [0] | uint256 | The new total assets to stream |
addToStreamingAssets
function addToStreamingAssets(uint256 amount) internal returns (uint256)
Parameters
| Name | Type | Description |
|---|
| amount | uint256 | The amount of assets to add to streaming |
Return Values
| Name | Type | Description |
|---|
| [0] | uint256 | The new total assets to stream |
claim
function claim(uint32 chainId, address bridge) public returns (uint256 amount)
Parameters
| Name | Type | Description |
|---|
| chainId | uint32 | The origin chain ID |
| bridge | address | The origin bridge address |
Return Values
| Name | Type | Description |
|---|
| amount | uint256 | The amount of assets claimed |
sendFunds
function sendFunds(uint256 amount, address recipient) internal
Parameters
| Name | Type | Description |
|---|
| amount | uint256 | The amount to send |
| recipient | address | The address to receive the funds |
setTokenSwap
function setTokenSwap(address newTokenSwapAddress) external
Parameters
| Name | Type | Description |
|---|
| newTokenSwapAddress | address | The new token swap contract address |
swapAndDeposit
function swapAndDeposit(address token, uint256 amount, uint24 uniswapWethPoolFeeToken, uint24 uniswapWethPoolFeeAsset, uint48 deadline, uint256 amountOutMinimum) public
Parameters
| Name | Type | Description |
|---|
| token | address | The token to swap from |
| amount | uint256 | The amount of tokens to swap |
| uniswapWethPoolFeeToken | uint24 | The fee tier for token-WETH pool |
| uniswapWethPoolFeeAsset | uint24 | The fee tier for WETH-asset pool |
| deadline | uint48 | The deadline for the swap |
| amountOutMinimum | uint256 | The minimum amount of assets to receive |
collectNonDepositedAssets
function collectNonDepositedAssets() public
beforeWithdraw
function beforeWithdraw(uint256 assets, uint256) internal
Parameters
| Name | Type | Description |
|---|
| assets | uint256 | The amount of assets to withdraw |
| uint256 | |
afterDeposit
function afterDeposit(uint256 assets, uint256) internal
Parameters
| Name | Type | Description |
|---|
| assets | uint256 | The amount of assets deposited |
| uint256 | |
processFailedHandler
function processFailedHandler(uint32 chainId, address bridge, bytes data) public
Parameters
| Name | Type | Description |
|---|
| chainId | uint32 | The origin chain ID |
| bridge | address | The origin bridge address |
| data | bytes | The encoded message data |
receive
receive() external payable
