ICCIPLiquidityContainer
Title: ICCIPLiquidityContainer
The liquidity container interface of Chainlink CCIP lock/release token pools.
The functions match ILiquidityContainer of Chainlink CCIP 1.6.0, so
type(ICCIPLiquidityContainer).interfaceId equals the identifier that a lock/release
pool advertises through ERC165. Both functions are restricted to the pool's rebalancer.
Functions
provideLiquidity
Transfers amount of the pool token from the caller into the container. The
caller must have approved the container beforehand.
function provideLiquidity(uint256 amount) external;
Parameters
| Name | Type | Description |
|---|---|---|
| amount | uint256 | The amount to provide. |
withdrawLiquidity
Transfers amount of the pool token from the container to the caller.
function withdrawLiquidity(uint256 amount) external;
Parameters
| Name | Type | Description |
|---|---|---|
| amount | uint256 | The amount to withdraw. |
Events
LiquidityAdded
Emitted when liquidity is provided to the container.
event LiquidityAdded(address indexed provider, uint256 indexed amount);
Parameters
| Name | Type | Description |
|---|---|---|
| provider | address | The address that provided the liquidity. |
| amount | uint256 | The amount provided. |
LiquidityRemoved
Emitted when liquidity is withdrawn from the container.
event LiquidityRemoved(address indexed provider, uint256 indexed amount);
Parameters
| Name | Type | Description |
|---|---|---|
| provider | address | The address that received the liquidity. |
| amount | uint256 | The amount withdrawn. |