CCIP v1.5.0 BurnMintTokenPool Contract API Reference
BurnMintTokenPool
BurnMintTokenPool is a concrete implementation that inherits from BurnMintTokenPoolAbstract. It is designed to mint and burn a 3rd-party token, using the burn(amount) function for burning tokens. Pool whitelisting mode is set during the contract's deployment and cannot be modified later.
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 burn(amount) function.
Parameters
| Name | Type | Description |
|---|---|---|
| amount | uint256 | The amount of tokens to burn. |