CCIP v1.5.1 BurnFromMintTokenPool Contract API Reference
The BurnFromMintTokenPool contract extends BurnMintTokenPoolAbstract to implement burn/mint functionality for third-party tokens using the burnFrom(from, amount) signature.
Functions
constructor
constructor(
IBurnMintERC20 token,
uint8 localTokenDecimals,
address[] memory allowlist,
address rmnProxy,
address router
) TokenPool(token, localTokenDecimals, allowlist, rmnProxy, router)
Initializes the token pool with the specified parameters and approves the pool to burn from itself.
Parameters
| Name | Type | Description |
|---|---|---|
| token | IBurnMintERC20 | The token managed by this pool |
| localTokenDecimals | uint8 | The number of decimals for the token on the local chain |
| allowlist | address[] | List of addresses allowed to be original senders for token transfers. When allowlist is enabled, it ensures only token-developer specified addresses can transfer tokens |
| rmnProxy | address | Address of the RMN proxy |
| router | address | Address of the router |
_burn
function _burn(
uint256 amount
) internal virtual override
Burns the specified amount of tokens using the burnFrom(from, amount) signature.
Parameters
| Name | Type | Description |
|---|---|---|
| amount | uint256 | Amount of tokens to burn |
typeAndVersion
string public constant override typeAndVersion = "BurnFromMintTokenPool 1.5.1"
Returns the type and version of the contract.
Return Value
| Type | Description |
|---|---|
| string | The string "BurnFromMintTokenPool 1.5.1" |