API Version: v1.6.3

CCIP v1.6.3 BurnMintTokenPoolAbstract Contract API Reference

Integrate Chainlink CCIP v1.6.3 into your project

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

npm install @chainlink/[email protected]

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

yarn add @chainlink/[email protected]

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/[email protected]

Using yarn:
```
yarn add @chainlink/[email protected]
```

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/[email protected]/=node_modules/@openzeppelin/contracts-4.8.3/",
"@openzeppelin/[email protected]/=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@279b542b5c23646fd3dbbde5ca7c46ca501cb6df \
  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/[email protected]/=lib/openzeppelin-contracts/contracts/",
"@openzeppelin/[email protected]/=lib/openzeppelin-contracts/contracts/"

BurnMintTokenPoolAbstract

An abstract contract that implements core token pool functionality for burning and minting operations in cross-chain token transfers.

Git Source

Inherits:

TokenPool

Functions

_releaseOrMint

Internal function that implements the token minting logic for a BurnMintTokenPool.

function _releaseOrMint(address receiver, uint256 amount) internal virtual override;

Parameters

Name	Type	Description
`receiver`	`address`	The address to receive the tokens
`amount`	`uint256`	The number of tokens to mint

CCIP v1.6.3 BurnMintTokenPoolAbstract Contract API Reference

BurnMintTokenPoolAbstract

Functions

_releaseOrMint

Get the latest Chainlink content straight to your inbox.