CCIP v1.5.1 BurnMintTokenPoolAbstract Contract API Reference
The BurnMintTokenPoolAbstract contract extends TokenPool to implement burn/mint functionality for cross-chain token transfers.
function _burn(uint256 amount) internal virtual
Contains the specific burn call for a pool. This function is virtual to allow different burn signatures without duplicating logic.
| Name | Type | Description |
|---|
| amount | uint256 | The amount of tokens to burn |
function lockOrBurn(
Pool.LockOrBurnInV1 calldata lockOrBurnIn
) external virtual override returns (Pool.LockOrBurnOutV1 memory)
Burns tokens in the pool after validating the operation.
| Name | Type | Description |
|---|
| lockOrBurnIn | Pool.LockOrBurnInV1 | Input parameters for the burn operation |
| Type | Description |
|---|
| Pool.LockOrBurnOutV1 | Contains destination token address and pool decimal data |
function releaseOrMint(
Pool.ReleaseOrMintInV1 calldata releaseOrMintIn
) external virtual override returns (Pool.ReleaseOrMintOutV1 memory)
Mints tokens from the pool to the recipient after validating the operation.
| Name | Type | Description |
|---|
| releaseOrMintIn | Pool.ReleaseOrMintInV1 | Input parameters for the mint operation |
| Type | Description |
|---|
| Pool.ReleaseOrMintOutV1 | Contains the final destination amount minted |
