adding contracts

.github/workflows/solidity.yml

@@ -0,0 +1,15 @@
+
+name: "Olympix Integration"
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  workflow_dispatch:
+
+jobs:
+  call-workflow:
+    uses: pthakur-circle/integrate-repo/.github/workflows/olympix.yml@main
+    secrets:
+      OLYMPIX_API_TOKEN: ${{ secrets.OLYMPIX_API_TOKEN }}
+

Dockerfile

@@ -0,0 +1,11 @@
+# Use fixed foundry image
+
+FROM ghcr.io/foundry-rs/foundry:nightly-4a8c7d0e26a1befa526222e22737740f80a7f1c5
+
+# Copy our source code into the container
+WORKDIR /app
+COPY . .
+
+# Build the source code
+EXPOSE 8545
+RUN forge build

Makefile

@@ -0,0 +1,64 @@
+.PHONY: build test anvil anvil-test anvil-deploy cast-call cast-send clean
+
+FOUNDRY := docker run --rm foundry
+ANVIL 	:= docker run -d -p 8545:8545 --name anvil --rm foundry
+
+build:
+	docker build --no-cache -f Dockerfile -t foundry .
+
+test:
+	@${FOUNDRY} "forge test -vv"
+
+simulate-deploy:
+	forge script scripts/1_deploy.s.sol:DeployScript --rpc-url ${RPC_URL} --sender ${SENDER}
+
+deploy:
+	forge script scripts/1_deploy.s.sol:DeployScript --rpc-url ${RPC_URL} --sender ${SENDER} --broadcast
+
+simulate-setup-second-attester:
+	forge script scripts/2_setupSecondAttester.s.sol:SetupSecondAttesterScript --rpc-url ${RPC_URL} --sender ${SENDER}
+
+setup-second-attester:
+	forge script scripts/2_setupSecondAttester.s.sol:SetupSecondAttesterScript --rpc-url ${RPC_URL} --sender ${SENDER} --broadcast
+
+simulate-setup-remote-resources:
+	forge script scripts/3_setupRemoteResources.s.sol:SetupRemoteResourcesScript --rpc-url ${RPC_URL} --sender ${SENDER}
+
+setup-remote-resources:
+	forge script scripts/3_setupRemoteResources.s.sol:SetupRemoteResourcesScript --rpc-url ${RPC_URL} --sender ${SENDER} --broadcast
+
+simulate-rotate-keys:
+	forge script scripts/4_rotateKeys.s.sol:RotateKeysScript --rpc-url ${RPC_URL} --sender ${SENDER}
+
+rotate-keys:
+	forge script scripts/4_rotateKeys.s.sol:RotateKeysScript --rpc-url ${RPC_URL} --sender ${SENDER} --broadcast
+
+simulate-replace-remote-resources:
+	forge script scripts/5_replaceRemoteResources.s.sol:ReplaceRemoteResourcesScript --rpc-url ${RPC_URL} --sender ${SENDER}
+
+replace-remote-resources:
+	forge script scripts/5_replaceRemoteResources.s.sol:ReplaceRemoteResourcesScript --rpc-url ${RPC_URL} --sender ${SENDER} --broadcast
+
+anvil:
+	docker rm -f anvil || true
+	@${ANVIL} "anvil --host 0.0.0.0 -a 13 --code-size-limit 250000"	
+
+anvil-test: anvil
+	pip3 install -r requirements.txt
+	python3 anvil/crosschainTransferIT.py
+
+deploy-local:
+	@docker exec anvil forge script anvil/scripts/${contract}.s.sol:${contract}Script --rpc-url http://localhost:8545  --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 --broadcast
+
+cast-call:
+	@docker exec anvil cast call ${contract_address} "${function}" --rpc-url http://localhost:8545
+
+cast-send:
+	@docker exec anvil cast send ${contract_address} "${function}" --rpc-url http://localhost:8545 --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
+
+clean:
+	@${FOUNDRY} "forge clean"
+
+analyze:
+	pip3 install -r requirements.txt
+	slither .

README.md

@@ -0,0 +1,150 @@
+# 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)`
+
+![](./pictures/Solidity-Change-Compiler.png)
+
+- Select 0.7.6
+
+![](./pictures/Solidity-Compiler-Version.png)
+
+- Install solhint extension https://marketplace.visualstudio.com/items?itemName=idrabenia.solidity-solhint
+
+### Install Foundry
+Install Foundry CLI (forge 0.2.0) from official [website](https://book.getfoundry.sh/getting-started/installation.html#on-linux-and-macos. ).
+
+- To install a specific verison, see [here](https://github.com/foundry-rs/foundry/blob/3f13a986e69c18ea19ce634fea00f4df6b3666b0/foundryup/README.md#usage).
+
+## 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](.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](https://book.getfoundry.sh/reference/forge/), [anvil](https://book.getfoundry.sh/reference/anvil/) or [cast](https://book.getfoundry.sh/reference/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](https://book.getfoundry.sh/tutorials/foundry-docker).
+
+ℹ️ 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](https://book.getfoundry.sh/tutorials/solidity-scripting). The script is located in [scripts/1_deploy.s.sol](/scripts/1_deploy.s.sol). Follow the below steps to deploy the contracts:
+1. Add the below environment variables to your [env](.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](.env) file and run [scripts/precomputeRemoteMessengerAddress.py](/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-deploy 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
+
+4. Replace the environment variables in your [env](.env) file with:
+    - `MESSAGE_TRANSMITTER_CONTRACT_ADDRESS`
+    - `MESSAGE_TRANSMITTER_DEPLOYER_KEY`
+    - `NEW_ATTESTER_MANAGER_ADDRESS`
+    - `SECOND_ATTESTER_ADDRESS`
+
+5. Run `make simulate-setup-second-attester RPC_URL=<RPC_URL> SENDER=<SENDER>` to perform a dry run of setting up the second attester.
+
+6. Run `make setup-second-attester RPC_URL=<RPC_URL> SENDER=<SENDER>` to setup the second attester.
+
+7. Replace the environment variables in your [env](.env) file with the following. We'll just add one remote resource (e.g. adding remote token messenger and remote usdc contract addresses) at a time, so just pick any and then repeat these steps. This will need to be repeated for each remote chain:
+    - `TOKEN_MESSENGER_DEPLOYER_KEY`
+    - `TOKEN_CONTROLLER_KEY`
+    - `REMOTE_TOKEN_MESSENGER_ADDRESS`
+    - `TOKEN_MINTER_CONTRACT_ADDRESS`
+    - `TOKEN_MESSENGER_CONTRACT_ADDRESS`
+    - `REMOTE_USDC_CONTRACT_ADDRESS`
+    - `USDC_CONTRACT_ADDRESS`
+    - `REMOTE_DOMAIN`
+
+8. Run `make simulate-setup-remote-resources RPC_URL=<RPC_URL> SENDER=<SENDER>` to perform a dry run of adding remote resources.
+
+9. Run `make setup-remote-resources RPC_URL=<RPC_URL> SENDER=<SENDER>` to setup the remote resources.
+
+10. Repeat steps 7-9 for all remote resources. This needs to be done for all existing remote chains at 
+    contract setup except for the initial remote chain used in `1_deploy.s.sol`.
+
+**[Only execute the following if replacing remote resources for an existing chain]**
+
+11. Replace the environment variables in your [env](.env) file with the following. We'll replace one set of remote resources for a given chain (e.g. changing the remote token messenger and remote usdc contract addresses) at a time so it will need to be repeated for each applicable chain.
+    - `TOKEN_MESSENGER_DEPLOYER_KEY`
+    - `TOKEN_CONTROLLER_KEY`
+    - `REMOTE_TOKEN_MESSENGER_ADDRESS`
+    - `REMOTE_TOKEN_MESSENGER_ADDRESS_DEPRECATED`
+    - `TOKEN_MINTER_CONTRACT_ADDRESS`
+    - `TOKEN_MESSENGER_CONTRACT_ADDRESS`
+    - `REMOTE_USDC_CONTRACT_ADDRESS`
+    - `REMOTE_USDC_CONTRACT_ADDRESS_DEPRECATED`
+    - `USDC_CONTRACT_ADDRESS`
+    - `REMOTE_DOMAIN`
+12. Run `make simulate-replace-remote-resources RPC_URL=<RPC_URL> SENDER=<SENDER>` to perform a dry run of replacing remote resources.
+
+13. Run `make replace-remote-resources RPC_URL=<RPC_URL> SENDER=<SENDER>` to replace the remote resources.
+
+**[Remaining steps are only for mainnet]**
+
+14. Replace the environment variables in your [env](.env) file with:
+    - `MESSAGE_TRANSMITTER_CONTRACT_ADDRESS`
+    - `TOKEN_MESSENGER_CONTRACT_ADDRESS`
+    - `TOKEN_MINTER_CONTRACT_ADDRESS`
+    - `MESSAGE_TRANSMITTER_DEPLOYER_KEY`
+    - `TOKEN_MESSENGER_DEPLOYER_KEY`
+    - `TOKEN_MINTER_DEPLOYER_KEY`
+    - `MESSAGE_TRANSMITTER_NEW_OWNER_ADDRESS`
+    - `TOKEN_MESSENGER_NEW_OWNER_ADDRESS`
+    - `TOKEN_MINTER_NEW_OWNER_ADDRESS`
+    - `NEW_TOKEN_CONTROLLER_ADDRESS`
+
+15. Run `make simulate-rotate-keys RPC_URL=<RPC_URL> SENDER=<SENDER>` to perform a dry run of rotating the keys.
+
+16. Run `make rotate-keys RPC_URL=<RPC_URL> SENDER=<SENDER>` to rotate keys.
+
+## Converting Noble Token Denoms to Solidity
+A Noble token denom is represented as an alphanumeric string, for example, `uusdc`. We need to convert this to the Solidity bytes32 type so we
+can reference it from EVM contracts. To compute this value from the scripts/noble directory, run:
+`python3 ./computeHash.py --DENOM <denom>`.
+The script will output the bytes32 value as hex.
+
+A Solidity implementation is also provided for optional additional verification. This can be run by creating an .env file in the scripts/noble directory with a DENOM env var, e.g. `DENOM=uusdc`, and then running:
+`forge script ./computeHash.s.sol`

anvil/Counter.sol

@@ -0,0 +1,20 @@
+pragma solidity >=0.7.6;
+
+contract Counter {
+    int private count;
+
+    constructor(int _count) {
+        count = _count;
+    }
+
+    function incrementCounter() public {
+        count += 1;
+    }
+    function decrementCounter() public {
+        count -= 1;
+    }
+
+    function getCount() public view returns (int) {
+        return count;
+    }
+}