circlefin / evm-cctp-contracts

Official repository for all EVM-compatible smart contracts used by the Cross-Chain Transfer Protocol

evm-cctp-contracts

Prerequisites

Install dependencies

• Run git submodule update --init --recursive to update/download all libraries.
• Run yarn install to install any additional dependencies.

VSCode IDE Setup

• Install solidity extension https://marketplace.visualstudio.com/items?itemName=juanblanco.solidity
• Navigate to a .sol file
• Right-click, select Solidity: Change global compiler version (Remote)

• Select 0.7.6

• Install solhint extension https://marketplace.visualstudio.com/items?itemName=idrabenia.solidity-solhint

Install Foundry

Install Foundry CLI (forge 0.2.0) from official website.

• To install a specific verison, see here.

Testing

Unit tests

Run forge test to run test using installed forge cli or make test to run tests in docker container.

Run unit tests with debug logs

Log level is controlled by the -v flag. For example, forge test -vv displays console.log() statements from within contracts. Highest verbosity is -vvvvv. More info: https://book.getfoundry.sh/forge/tests.html#logs-and-traces. Contracts that use console.log() must import lib/forge-std/src/console.sol.

Integration tests

Run make anvil-test to setup anvil test node in docker container and run integration tests. There is an example in anvil/ folder

Linting

Run yarn lint to lint all .sol files in the src and test directories.

Static analysis

Run make analyze to set up Python dependencies from requirements.txt and run Slither on all source files, requiring the foundry cli to be installed locally. If all dependencies have been installed, alternatively run slither . to run static analysis on all .sol files in the src directory.

Continuous Integration using Github Actions

We use Github actions to run linter and all the tests. The workflow configuration can be found in .github/workflows/ci.yml

Alternative Installations

Docker + Foundry

Use Docker to run Foundry commands. Run make build to build Foundry docker image. Then run docker run --rm foundry "<COMMAND>" to run any forge, anvil or cast commands. There are some pre defined commands available in Makefile for testing and deploying contract on anvil. More info on Docker and Foundry here.

ℹ️ Note

• Some machines (including those with M1 chips) may be unable to build the docker image locally. This is a known issue.

Deployment

The contracts are deployed using Forge Scripts. The script is located in scripts/deploy.s.sol. Follow the below steps to deploy the contracts:

1. Add the below environment variables to your env file

   • MESSAGE_TRANSMITTER_DEPLOYER_KEY
   • TOKEN_MESSENGER_DEPLOYER_KEY
   • TOKEN_MINTER_DEPLOYER_KEY
   • TOKEN_CONTROLLER_DEPLOYER_KEY
   • ATTESTER_ADDRESS
   • USDC_CONTRACT_ADDRESS
   • REMOTE_USDC_CONTRACT_ADDRESS
   • MESSAGE_TRANSMITTER_PAUSER_ADDRESS
   • TOKEN_MINTER_PAUSER_ADDRESS
   • MESSAGE_TRANSMITTER_RESCUER_ADDRESS
   • TOKEN_MESSENGER_RESCUER_ADDRESS
   • TOKEN_MINTER_RESCUER_ADDRESS
   • TOKEN_CONTROLLER_ADDRESS
   • DOMAIN
   • REMOTE_DOMAIN
   • BURN_LIMIT_PER_MESSAGE

   In addition, to link the remote bridge, one of two steps needs to be followed:

   • Add the REMOTE_TOKEN_MESSENGER_DEPLOYER address to your env file and run scripts/precomputeRemoteMessengerAddress.py with argument --REMOTE_RPC_URL for the remote chain, which will automatically add the REMOTE_TOKEN_MESSENGER_ADDRESS to the .env file
   • Manually add the REMOTE_TOKEN_MESSENGER_ADDRESS to your .env file.

2. Run make simulate RPC_URL=<RPC_URL> SENDER=<SENDER> to perform a dry run. Note: Use address from one of the private keys (used for deploying) above as sender. It is used to deploy the shared libraries that contracts use

3. Run make deploy RPC_URL=<RPC_URL> SENDER=<SENDER> to deploy the contracts

License

For license information, see LICENSE and additional notices stored in NOTICES.

evm-cctp-contracts's Issues

Registering a new _domain

Hello,

I have read the whole documentation, smart contracts code and interaction code. I am very impressed by the solution that is being built. Circle is going to significantly improve stablecoin access on blockchains and increase the strengh of USDC.

From my understanding, if a Blockchain wants to start integrating the devnet mint/burn bridge of Circle, it needs a few actions from Circle:

• for integrating the Ethereum -> Blockchain devnet bridge, the Blockchain needs to be associated a _domain in the remoteTokenMessengers storage of TokenMessenger.sol,

• for integrating the Blockchain -> Ethereum devnet bridge, the Blockchain needs either that Circle attesters work with the Blockchain or that Circle whitelists the attesters made by the Blockchain, in the enabledAttesters storage of MessageTransmitter.sol.

How to register a new _domain in the remoteTokenMessengers storage of TokenMessenger.sol? This way, the Blockchain could already start the integration of the Ethereum -> Blockchain devnet bridge.

Add license notice re: reproduced code

This repo contains code derived from Nomad contracts without proper attribution and license information. As an author of the code involved, I'm happy that you found the work useful. Reuse of our code is praise

However, to use our work in compliance with the license, please add the appropriate MIT or Apache-2.0 license text (at your option) information to the files containing reproduced or derived code as well as a note in the README that some work is reproduced under the appropriate license

I have not done a full compliance audit of the code base, and do not have a full list of files in need of license notices. However, here is a simple example:

• This code region is a slightly modified version of this code region, but the file contains no indication that the work is used under either available FLOSS license.

TODOs

• Add license notice to files containing derivative or reproduced code
• Add note to README describing source and authorship of reproduced code
• Notify etherscan verification team of incomplete license information in hosted source files
• Optional: cite our work in public comms and/or documentation

support for more testnets, like sepolia, etc

Hi there,
As we know that goerli ethereum testnet is deprecated and also tx fees are high in that network, I want to know when will be CCTP deployed on Sepolia testnet?

Circle

evm-cctp-contracts/src/messages/Message.sol

Lines 145 to 157 in 4011160

	function addressToBytes32(address addr) external pure returns (bytes32) {
	return bytes32(uint256(uint160(addr)));
	}
	/**
	* @notice converts bytes32 to address (alignment preserving cast.)
	* @dev Warning: it is possible to have different input values _buf map to the same address.
	* For use cases where this is not acceptable, validate that the first 12 bytes of _buf are zero-padding.
	* @param _buf the bytes32 to convert to address
	*/
	function bytes32ToAddress(bytes32 _buf) public pure returns (address) {
	return address(uint160(uint256(_buf)));
	}

CCTP Contracts on non-EVM Contract Platforms: WASM and Other Smart Contract Platforms

We would like to increase CCTP [thus USDC] adoption in chains which do not have EVM: Substrate [Polkadot/Kusama, WASM - 75 chains], Cosmos [59 chains], Stellar [1 chain], by us contributing code for WASM Contracts in non-EVM smart contract platforms, starting with Substrate. With your support, we imagine others can contribute CCTP smart contracts in other "domains" (Hedera, Cardano, Algorand, among others) with other non-EVM CCTP smart contracts, ideally resulting in CCTP contracts supporting every token.

We believe any such execution should be supported by

1. Circle-led audits
2. a growing registry of CCTP assets and domains covered
3. a business model to support and maintain CCTP contracts across all the domains covered
   Can you suggest a mechanism and means to address this generally, and for WASM Contracts specifically?

Fixing my wallet

https://github.com/ethereum/EIPs/actions/runs/8751677361/job/24017779761#step:3:1

Add ABI for Contracts by Contract Address

Please upload the ABI for the Smart Contracts with the Contract Address by Blockchain.