CCIP v1.5.0 BurnMintTokenPoolAbstract Contract API Reference
BurnMintTokenPoolAbstract is an abstract contract that extends the TokenPool contract. It defines the common logic for burning tokens in the pool. This contract contains validation mechanisms and logic for burning tokens in the context of a cross-chain token transfer. When allowlist is enabled, it ensures only token-developer specified addresses can transfer tokens.
function _burn(uint256 amount) internal virtual
Contains the specific burn call for a pool.
| Name | Type | Description |
|---|
| amount | uint256 | The amount of tokens to burn. |
function lockOrBurn(struct Pool.LockOrBurnInV1 lockOrBurnIn) external virtual returns (struct Pool.LockOrBurnOutV1)
Burn the token in the pool.
| Name | Type | Description |
|---|
| lockOrBurnIn | Pool.LockOrBurnInV1 | The input parameters for burning tokens. |
| Name | Type | Description |
|---|
| [0] | Pool.LockOrBurnOutV1 | The output data after burning the tokens. |
function releaseOrMint(struct Pool.ReleaseOrMintInV1 releaseOrMintIn) external virtual returns (struct Pool.ReleaseOrMintOutV1)
Mint tokens from the pool to the recipient.
| Name | Type | Description |
|---|
| releaseOrMintIn | Pool.ReleaseOrMintInV1 | The input parameters for minting tokens. |
| Name | Type | Description |
|---|
| [0] | Pool.ReleaseOrMintOutV1 | The output data after minting the tokens. |
