CCIP v1.5.1 BurnMintTokenPool Contract API Reference

BurnMintTokenPool

A specialized token pool implementation that handles the minting and burning of third-party tokens using the standard burn(amount) function.

Git Source

Inherits:

• BurnMintTokenPoolAbstract
• ITypeAndVersion

State Variables

typeAndVersion

string public constant override typeAndVersion = "BurnMintTokenPool 1.5.1";

Returns

Functions

_burn

Internal function that executes the token burning operation using the standard burn interface.

function _burn(uint256 amount) internal virtual override;

Parameters

constructor

constructor(
  IBurnMintERC20 token,
  uint8 localTokenDecimals,
  address[] memory allowlist,
  address rmnProxy,
  address router
) TokenPool(token, localTokenDecimals, allowlist, rmnProxy, router);

Parameters