API Version: v1.6.0 Not using latest version (v1.6.2)

CCIP v1.6.0 BurnFromMintTokenPool Contract API Reference

Integrate Chainlink CCIP v1.6.0 into your project

If you use NPM, install the @chainlink/contracts-ccip NPM package:

npm install @chainlink/contracts-ccip@1.6.0

If you use Yarn, install the @chainlink/contracts-ccip NPM package:

yarn add @chainlink/contracts-ccip@1.6.0

If you use Foundry, install the package:

forge install smartcontractkit/chainlink-ccip@2114b90f39c82c052e05af7c33d42c1ae98f4180

BurnFromMintTokenPool

A specialized token pool contract that manages third-party tokens through minting and burning operations, specifically using the burnFrom function.

Git Source

Inherits:

State Variables

typeAndVersion

string public constant override typeAndVersion = "BurnFromMintTokenPool 1.5.1";

Returns

Type	Description
`string`	The contract identifier "BurnFromMintTokenPool 1.5.1"

Functions

_burn

Internal function that executes the token burning operation.

function _burn(uint256 amount) internal virtual override;

Parameters

Name	Type	Description
`amount`	`uint256`	The quantity of tokens to burn

constructor

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