API Version: v1.6.2

CCIP v1.6.2 BurnFromMintTokenPool Contract API Reference

Integrate Chainlink CCIP v1.6.2 into your project

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

npm install @chainlink/contracts-ccip@1.6.2

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

yarn add @chainlink/contracts-ccip@1.6.2

In your Foundry project, for easier integration, if you want to avoid installing the dependencies that are only used by the chainlink-ccip package, you can use either NPM or Yarn to install the chainlink-ccip package:

Using npm:

npm install @chainlink/contracts-ccip@1.6.2

Using yarn:

yarn add @chainlink/contracts-ccip@1.6.2

Then, add the following remappings to your remappings.txt or foundry.toml file:

"@chainlink/contracts-ccip/contracts/=node_modules/@chainlink/contracts-ccip/contracts/",
"@chainlink/contracts/=node_modules/@chainlink/contracts/",
"@openzeppelin/contracts@4.8.3/=node_modules/@openzeppelin/contracts-4.8.3/",
"@openzeppelin/contracts@5.0.2/=node_modules/@openzeppelin/contracts-5.0.2/"

Alternatively, if you prefer to use only forge install, install the chainlink-ccip package along with its dependencies:

forge install \
  smartcontractkit/chainlink-ccip@0e3e0fc5c0f70f0d50dca66b139142ddf3009294 \
  smartcontractkit/chainlink-evm@86aa5a1d34b20eda8d18fe6eb0e4882948e545ba  \
  openzeppelin/openzeppelin-contracts@0a25c1940ca220686588c4af3ec526f725fe2582 \
  openzeppelin/openzeppelin-contracts@dbb6104ce834628e473d2173bbc9d47f81a9eec3

Then set the remappings as follows:

"@chainlink/contracts-ccip/contracts/=lib/chainlink-ccip/chains/evm/contracts/",
"@chainlink/contracts/=lib/chainlink-evm/contracts/",
"@openzeppelin/contracts@4.8.3/=lib/openzeppelin-contracts/contracts/",
"@openzeppelin/contracts@5.0.2/=lib/openzeppelin-contracts/contracts/"

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.6.1";

Returns

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

Functions

_lockOrBurn

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

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);