Enable your tokens in CCIP (Burn & Mint): Register from an EOA using Foundry

Hardhat (Burn & Mint)

Foundry (Burn & Mint)

This tutorial will guide you through the process of enabling your own tokens in CCIP using Foundry. You will learn how to deploy tokens and set up Burn & Mint token pools. After that, you will register them in CCIP and configure them without needing manual intervention. Finally, you will test the Burn & Mint token handling mechanism, where tokens are burned on the source blockchain and an equivalent amount is minted on the destination blockchain.

We will cover the following key steps:

1. Deploying Tokens: You will deploy your BurnMintERC677 tokens on the Avalanche Fuji and Arbitrum Sepolia testnets.

2. Deploying Token Pools: Once your tokens are deployed, you will deploy BurnMintTokenPool token pools on Avalanche Fuji and Arbitrum Sepolia. These pools are essential for minting and burning tokens during cross-chain transfers. Each token will be linked to a pool, which will manage token transfers and ensure proper handling of assets across chains.

3. Claiming Mint and Burn Roles: You will claim the mint and burn roles for the token pools, allowing your token pools to control how tokens are minted and burned during cross-chain transfers.

4. Claiming and Accepting the Admin Role: This is a two-step process:

   1. You will call the RegistryModuleOwnerCustom contract's registerAdminViaOwner function to register your EOA as the token admin. This role is required to enable your token in CCIP.

   2. Once claimed, you will call the TokenAdminRegistry contract's acceptAdminRole function to complete the registration process.

5. Linking Tokens to Pools: You will call the TokenAdminRegistry contract's setPool function to associate each token with its respective token pool.

6. Configuring Token Pools: You will call the applyChainUpdates function on your token pools to configure each pool by setting cross-chain transfer parameters, such as token pool rate limits and enabled destination chains.

7. Minting Tokens: You will call the mint function to mint tokens on Avalanche Fuji for your EOA. These tokens will later be used to test cross-chain transfers to Arbitrum Sepolia.

8. Transferring Tokens: Finally, you will transfer tokens from Avalanche Fuji to Arbitrum Sepolia using CCIP. You will have the option to pay CCIP fees in either LINK tokens or native gas tokens.

By the end of this tutorial, you will have successfully deployed, registered, configured, and enabled your tokens and token pools for use in CCIP.

Before You Begin

1. Make sure you have Node.js v18 or above installed. If not, install Node.js v18:
   Download Node.js 18 if you don't have it installed. Optionally, you can use the nvm package to switch between Node.js versions:

   nvm use 18
   

   Verify that the correct version of Node.js is installed:

   node -v
   

   Example output:

   $ node -v
   v18.7.0
   

2. Install Foundry: If you haven't already, follow the instructions in the Foundry documentation to install Foundry.

3. Clone the repository and navigate to the project directory:

   git clone https://github.com/smartcontractkit/smart-contract-examples.git
   cd smart-contract-examples/ccip/cct/foundry
   

4. Set up your environment: Create a .env file by copying the .env.example file, and fill in the required values:

   cp .env.example .env
   

   Example .env file:

   PRIVATE_KEY=<your_private_key>
   RPC_URL_FUJI=<your_rpc_url_fuji>
   RPC_URL_ARBITRUM_SEPOLIA=<your_rpc_url_arbitrum_sepolia>
   ETHERSCAN_API_KEY=<your_etherscan_api_key>
   ARBISCAN_API_KEY=<your_arbiscan_api_key>
   

   Variables to configure:

   • PRIVATE_KEY: The private key for your testnet wallet. If you use MetaMask, you can follow this guide to export your private key. Note: This key is required for signing transactions like token transfers.
   • RPC_URL_FUJI: The RPC URL for the Fuji testnet. You can get this from the Alchemy or Infura website.
   • RPC_URL_ARBITRUM_SEPOLIA: The RPC URL for the Arbitrum Sepolia testnet. You can get this from the Alchemy or Infura website.
   • ETHERSCAN_API_KEY: An API key from Etherscan to verify your contracts. You can obtain one from Etherscan.
   • ARBISCAN_API_KEY: An API key from Arbiscan to verify your contracts on Arbitrum. See this guide to get one from Arbiscan.

5. Load the environment variables into the terminal session where you will run the commands:

   source .env
   

6. Install dependencies:

   forge install && npm install
   

7. Compile the contracts:

   forge compile
   

Optional: Configure your config.json file

Before running the scripts, you can customize the config.json within the script folder to your needs.

• By default, this guide and the accompanying scripts are configured to work with Avalanche Fuji (chain ID 43113) and Arbitrum Sepolia (chain ID 421614). If you do not make any changes to the config.json file, you will mint your tokens on Avalanche Fuji and transfer them to Arbitrum Sepolia.

• If you wish to customize the token parameters such as the token name, symbol, decimals, amount to mint, or amount to transfer, you can modify these fields in the config.json file accordingly.

  Note: If you decide to change the chain IDs in the remoteChains section to use different networks, you will also need to update your .env file with the appropriate RPC URLs for those networks.

Example config.json file:

{
  "BnMToken": {
    "name": "BnM KH",
    "symbol": "BnMkh",
    "decimals": 18,
    "initialSupply": 0,
    "withGetCCIPAdmin": false,
    "ccipAdminAddress": "0x0000000000000000000000000000000000000000"
  },
  "tokenAmountToMint": 1000000000000000000000,
  "tokenAmountToTransfer": 10000,
  "feeType": "link",
  "remoteChains": {
    "43113": 421614,
    "421614": 43113
  }
}

The config.json file contains the following parameters:

Tutorial

Deploy Tokens

In this step, you will use the DeployToken.s.sol script to deploy your tokens on two testnets, Avalanche Fuji and Arbitrum Sepolia.

The script reads the config.json file to get the token name, symbol, decimals, initial supply, and whether to include CCIP admin functionality. Based on these configurations, it deploys the appropriate token contract — either with or without CCIP admin features — and optionally sets the CCIP admin. It then deploys the token contract and grants mint and burn roles to your EOA.

1. Deploy tokens on Avalanche Fuji:

   forge script script/DeployToken.s.sol --rpc-url $RPC_URL_FUJI --private-key $PRIVATE_KEY --broadcast --verify
   

   Example output:

   Deployed BurnMintERC677 at: 0x551c05e1C44F5E8e3DDBE824BEEf30695F2915d5
   Granted mint and burn roles to: 0x45C90FBb5acC1a5c156a401B56Fea55e69E7669d
   Writing deployed token address to file: ./script/output/deployedToken_avalancheFuji.json
   

2. Deploy tokens on Arbitrum Sepolia:

   forge script script/DeployToken.s.sol --rpc-url $RPC_URL_ARBITRUM_SEPOLIA --private-key $PRIVATE_KEY --broadcast --verify
   

   Example output:

   Deployed BurnMintERC677 at: 0xC0352e6EB714F29B453d024E1Da1CC713924797F
   Granted mint and burn roles to: 0x45C90FBb5acC1a5c156a401B56Fea55e69E7669d
   Writing deployed token address to file: ./script/output/deployedToken_arbitrumSepolia.json
   

Deploy Token Pools

In this step, you will use the DeployBurnMintTokenPool.s.sol script to deploy Burn & Mint token pools for the tokens on both testnets, Avalanche Fuji and Arbitrum Sepolia and grant mint and burn roles to the token pools.

1. Deploy a Burn & Mint token pool for the deployed token on Avalanche Fuji:

   forge script script/DeployBurnMintTokenPool.s.sol --rpc-url $RPC_URL_FUJI --private-key $PRIVATE_KEY --broadcast --verify
   

   Example output:

   Burn & Mint token pool deployed to: 0x2dAF1364cD12299933ee8616736A7EC2d4448D77
   Granted mint and burn roles to token pool: 0x2dAF1364cD12299933ee8616736A7EC2d4448D77
   Writing deployed token pool address to file: ./script/output/deployedTokenPool_avalancheFuji.json
   

2. Deploy a Burn & Mint token pool for the deployed token on Arbitrum Sepolia:

   forge script script/DeployBurnMintTokenPool.s.sol --rpc-url $RPC_URL_ARBITRUM_SEPOLIA --private-key $PRIVATE_KEY --broadcast --verify
   

   Example output:

   Burn & Mint token pool deployed to: 0xC8dDDcd8595703bb717B266294e1d91Ffb0B5683
   Granted mint and burn roles to token pool: 0xC8dDDcd8595703bb717B266294e1d91Ffb0B5683
   Writing deployed token pool address to file: ./script/output/deployedTokenPool_arbitrumSepolia.json
   

Claim Admin Role

In this step, you will use the ClaimAdmin.s.sol script to register your EOA as the administrator for the deployed tokens on both Avalanche Fuji and Arbitrum Sepolia testnets. This process involves interacting with the RegistryModuleOwnerCustom contract to set up your EOA as the admin.

The script will claim the admin role using using getCCIPAdmin() function if the withGetCCIPAdmin field is set to true in your config.json file. Otherwise, the script will use the standard owner() function to claim the admin role.

1. Claim the Admin role for the token on Avalanche Fuji:

   forge script script/ClaimAdmin.s.sol --rpc-url $RPC_URL_FUJI --private-key $PRIVATE_KEY --broadcast
   

   Example output:

   Current token owner: 0x45C90FBb5acC1a5c156a401B56Fea55e69E7669d
   Claiming admin of the token via owner() for signer: 0x45C90FBb5acC1a5c156a401B56Fea55e69E7669d
   Admin claimed successfully for token: 0x551c05e1C44F5E8e3DDBE824BEEf30695F2915d5
   

2. Claim the Admin role for the token on Arbitrum Sepolia:

   forge script script/ClaimAdmin.s.sol --rpc-url $RPC_URL_ARBITRUM_SEPOLIA --private-key $PRIVATE_KEY --broadcast
   

   Example output:

   Current token owner: 0x45C90FBb5acC1a5c156a401B56Fea55e69E7669d
   Claiming admin of the token via owner() for signer: 0x45C90FBb5acC1a5c156a401B56Fea55e69E7669d
   Admin claimed successfully for token: 0xC0352e6EB714F29B453d024E1Da1CC713924797F
   

Accept Admin Role

In this step, you will use the AcceptAdminRole.s.sol script to accept the admin role for the deployed tokens on both Avalanche Fuji and Arbitrum Sepolia testnets. Once you have claimed the role, accepting the role finalizes your control over the token administration.

1. Accept the admin role for the token on Avalanche Fuji:

   forge script script/AcceptAdminRole.s.sol --rpc-url $RPC_URL_FUJI --private-key $PRIVATE_KEY --broadcast
   

   Example output:

   Accepted admin role for token: 0x551c05e1C44F5E8e3DDBE824BEEf30695F2915d5
   

2. Accept the admin role for the token on Arbitrum Sepolia:

   forge script script/AcceptAdminRole.s.sol --rpc-url $RPC_URL_ARBITRUM_SEPOLIA --private-key $PRIVATE_KEY --broadcast
   

   Example output:

   Accepted admin role for token: 0xC0352e6EB714F29B453d024E1Da1CC713924797F
   

Set Token Pool

In this step, you will use the SetPool.s.sol script to link each token with its respective token pool on both testnets.

1. Link the token to its respective token pool on Avalanche Fuji:

   forge script script/SetPool.s.sol --rpc-url $RPC_URL_FUJI --private-key $PRIVATE_KEY --broadcast
   

   Example output:

   Setting pool for token: 0x551c05e1C44F5E8e3DDBE824BEEf30695F2915d5
   New pool address: 0x2dAF1364cD12299933ee8616736A7EC2d4448D77
   Action performed by admin: 0x45C90FBb5acC1a5c156a401B56Fea55e69E7669d
   Pool set for token 0x551c05e1C44F5E8e3DDBE824BEEf30695F2915d5 to 0x2dAF1364cD12299933ee8616736A7EC2d4448D77
   

2. Link the token to its respective token pool on Arbitrum Sepolia:

   forge script script/SetPool.s.sol --rpc-url $RPC_URL_ARBITRUM_SEPOLIA --private-key $PRIVATE_KEY --broadcast
   

   Example output:

   Setting pool for token: 0xC0352e6EB714F29B453d024E1Da1CC713924797F
   New pool address: 0xC8dDDcd8595703bb717B266294e1d91Ffb0B5683
   Action performed by admin: 0x45C90FBb5acC1a5c156a401B56Fea55e69E7669d
   Pool set for token 0xC0352e6EB714F29B453d024E1Da1CC713924797F to 0xC8dDDcd8595703bb717B266294e1d91Ffb0B5683
   

Configure Token Pools

In this step, you will use the ApplyChainUpdates.s.sol script to initialize the token pool configuration on each blockchain to enable cross-chain transfers between Avalanche Fuji and Arbitrum Sepolia. This involves linking the token pool on one blockchain to a corresponding pool on another blockchain, allowing cross-chain token transfers. You will interact with the TokenPool contract by calling the applyChainUpdates() function to set up cross-chain parameters and rate limits.

Parameters used in pool configuration:

Fields within outboundRateLimiterConfig and inboundRateLimiterConfig:

1. Configure the token pool on Avalanche Fuji:

   forge script script/ApplyChainUpdates.s.sol --rpc-url $RPC_URL_FUJI --private-key $PRIVATE_KEY --broadcast
   

   Example output:

   Chain update applied to pool at address: 0x2dAF1364cD12299933ee8616736A7EC2d4448D77
   

2. Configure the token pool on Arbitrum Sepolia:

   forge script script/ApplyChainUpdates.s.sol --rpc-url $RPC_URL_ARBITRUM_SEPOLIA --private-key $PRIVATE_KEY --broadcast
   

   Example output:

   Chain update applied to pool at address: 0xC8dDDcd8595703bb717B266294e1d91Ffb0B5683
   

Mint Tokens

In this step, you will use the MintTokens.s.sol script to mint tokens to your Externally Owned Account (EOA) on Avalanche Fuji. Since you granted mint and burn privileges to your EOA during the token deployment in the first step, you are authorized to mint tokens for testing purposes. This ensures that your EOA has sufficient tokens to perform cross-chain transfers in the next step.

The script will read the amount to mint from the tokenAmountToMint field in your config.json file and call the mint() function of the BurnMintERC677 token contract to mint the tokens to your EOA.

Mint tokens for your EOA on Avalanche Fuji:

forge script script/MintTokens.s.sol --rpc-url $RPC_URL_FUJI --private-key $PRIVATE_KEY --broadcast

Example output:

Minting 1000000000000000000000 tokens to 0x45C90FBb5acC1a5c156a401B56Fea55e69E7669d
Waiting for confirmations...
Minted 1000000000000000000000 tokens to 0x45C90FBb5acC1a5c156a401B56Fea55e69E7669d
Current balance of receiver is 1000000000000000000000 BnMkh

Transfer Tokens Across Networks

In this step, you will use the TransferTokens.s.sol script to transfer tokens from Avalanche Fuji to Arbitrum Sepolia using CCIP. You can choose to pay CCIP fees using LINK tokens or the native gas token.

The scripts reads the tokenAmountToTransfer, the feeType, and the destinationChainId from your config.json file. It prepares the transfer by approving the token transfer and estimating the CCIP fees based on your feeType. The script then calls the ccipSend() function on the IRouterClient contract to initiate the cross-chain transfer.

Transfer tokens from Avalanche Fuji to Arbitrum Sepolia:

forge script script/TransferTokens.s.sol --rpc-url $RPC_URL_FUJI --private-key $PRIVATE_KEY --broadcast

Example output:

Estimated fees: 35888032945101983
Message ID:
0x18c201689bc0cdc4f19c50af3d693f7ba8fe54b734dc9b322f4f710fc9a038a7
Check status of the message at https://ccip.chain.link/msg/18c201689bc0cdc4f19c50af3d693f7ba8fe54b734dc9b322f4f710fc9a038a7

You can check the status of the message on the Chainlink CCIP Explorer using the message ID provided in the output.