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

CCIP v1.6.1 BurnMintTokenPool Contract API Reference

Integrate Chainlink CCIP v1.6.1 into your project

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

npm install @chainlink/contracts-ccip@1.6.1

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

yarn add @chainlink/contracts-ccip@1.6.1

If you use Foundry, install the package:

forge install smartcontractkit/chainlink-ccip@bbab0601244ce58e2ffac0dbc178a80aab1fa4a3

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:

State Variables

typeAndVersion

string public constant override typeAndVersion = "BurnMintTokenPool 1.6.1";

Returns

Type	Description
`string`	The contract identifier "BurnMintTokenPool 1.6.1"

Functions

_lockOrBurn

Internal function that implements the token burning logic for the BurnMintTokenPool.

function _lockOrBurn(uint256 amount) internal virtual override;

Parameters

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

constructor

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