https://github.com/bunsdev/ccip-avalanche
https://github.com/bunsdev/ccip-avalanche
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/bunsdev/ccip-avalanche
- Owner: BunsDev
- License: mit
- Created: 2024-10-09T03:20:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-21T22:19:13.000Z (over 1 year ago)
- Last Synced: 2025-02-01T09:29:28.258Z (over 1 year ago)
- Language: Solidity
- Size: 662 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ccip-avalanche
Demonstrating how to use Chainlink Cross-Chain Interoperobility Protocol (CCIP) and Avalanche Interchain Messaging (ICM) to send a message from Ethereum Sepolia to Avalanche Fuji (_via CCIP_), then forwarding that message from Avalanche Fuji to Dispatch L1 (_via ICM_).
# Getting Started
In the next section you can see how to send data from one chain to another. But before that, you need to set up some environment variables, install dependencies, setup environment variables, and compile contracts.
## 1. Install Dependencies
```bash
yarn && make
```
## 2. Setup Environment Variables
Run the command below, then update the .env `PRIVATE_KEY` and `ETHERSCAN-API-KEY` variables.
```bash
cp .env.example .env && source .env
```
## 3. Create Wallet
To create a new wallet that is stored in a keystore, issue the following command, which will prompt you to secure the private key with a password.
```bash
cast wallet import --private-key $PRIVATE_KEY -k keystore $ACCOUNT_NAME
```
For ease use of the keystore we already configured a environment variable called `KEYSTORE` pointing to the `keystore` file in the working directory.
You can use the wallet stored in the keystore by adding the `--keystore` flag instead of the `--private-key` flag.
```bash
cast wallet address --keystore $KEYSTORE
```
## 4. Prepare Smart Contracts
### Smart Contract Design
### A. Deploy Contracts
In order to interact with our contracts, we first need to deploy them, which is simplified in the [`script/Deploy.s.sol`](./script/Deploy.s.sol) smart contract.
We have package scripts that enable you to deploy contracts, as follows:
```sh
yarn deploy:sender
```
> [`MessageSender.sol`](./src/MessageSender.sol)
```sh
yarn deploy:broker
```
> [`MessageBroker.sol`](./src/MessageBroker.sol)
```sh
yarn deploy:receiver
```
> [`MessageReceiver.sol`](./src/MessageReceiver.sol)
### B. Fund Sender Contract
After acquiring testnet tokens, you will proceed with funding your [Message Sender Contract](./src/MessageSender.sol) with some native tokens (ETH).
```sh
cast send $MESSAGE_SENDER_ADDRESS --rpc-url ethereumSepolia --value 0.05ether --keystore keystore
```
# Messaging Cross-Chain
> *Before proceeding, please ensure you have completed the steps outlined in the [Setup Messaging Scenario](#setup-messaging-scenario) section above.*
## 1. Ethereum Sepolia → Avalanche Fuji
### Sending Message (Sepolia → Fuji)
Run the following to send a message to Fuji from Sepolia via the `SendMessage` functionality coded in [Send.s.sol](./script/Send.s.sol):
```bash
forge script ./script/Send.s.sol:SendMessage -vvv --broadcast --rpc-url ethereumSepolia --sig \"run(string)\" -- "$CUSTOM_MESSAGE"
```
## 2. Avalanche Fuji → Dispatch Testnet
### Brokering Message (Fuji → Dispatch)
Once the message is finalized on the broker chain (*Fuji*), you may see the details about the latest message via the `BrokerMessage` functionality coded in [Broker.s.sol](./script/Broker.s.sol). After you have confirmed the latest message you received looks good, you may proceed with running the following script to broker the message to Dispatch:
```bash
cast send $MESSAGE_BROKER_ADDRESS --rpc-url avalancheFuji --keystore keystore "brokerMessage(address)" $MESSAGE_RECEIVER_ADDRESS
```
## 3. Dispatch Testnet
### Receiving Message (Dispatch)
After running the script above to broker the message from Fuji to Dispatch, you may confirm the message was received by running the following script:
```bash
forge script ./script/Receive.s.sol:ReceiveMessage -vvv --broadcast --rpc-url dispatchTestnet
```