CCIP v1.5.0 BurnFromMintTokenPool Contract API Reference
BurnFromMintTokenPool
BurnFromMintTokenPool is a concrete implementation that inherits from BurnMintTokenPoolAbstract. It is designed to mint and burn a 3rd-party token, using the burnFrom(address, amount) function for burning tokens, where the contract burns tokens from its own balance. When allowlist is enabled, it ensures only token-developer specified addresses can transfer tokens.
Variables
typeAndVersion
string typeAndVersion
Functions
constructor
constructor(contract IBurnMintERC20 token, address[] allowlist, address rmnProxy, address router) public
Parameters
| Name | Type | Description |
|---|---|---|
| token | IBurnMintERC20 | The token that will be burned and minted. |
| allowlist | address[] | List of addresses allowed to be original senders for token transfers. |
| rmnProxy | address | The RMN proxy address. |
| router | address | The router address. |
_burn
function _burn(uint256 amount) internal virtual
Contains the specific burn call for a pool using the token's burnFrom(address, amount) function.
Parameters
| Name | Type | Description |
|---|---|---|
| amount | uint256 | The amount of tokens to burn. |