Skip to content

Commit 6a27084

Browse files
committed
evm: update README with deployment instructions
1 parent 5b3ccb1 commit 6a27084

File tree

2 files changed

+53
-8
lines changed

2 files changed

+53
-8
lines changed

evm/README.md

+53-8
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ https://book.getfoundry.sh/
1818
### Build
1919

2020
```shell
21-
$ cd evm && forge build
21+
$ forge build
2222
```
2323

2424
### Test
2525

2626
```shell
27-
$ cd evm && forge test
27+
$ forge test
2828
```
2929

3030
### Format
@@ -45,12 +45,6 @@ $ forge snapshot
4545
$ anvil
4646
```
4747

48-
### Deploy
49-
50-
```shell
51-
$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
52-
```
53-
5448
### Cast
5549

5650
```shell
@@ -64,4 +58,55 @@ $ forge --help
6458
$ anvil --help
6559
$ cast --help
6660
```
61+
62+
### Deploy Wormhole NTT
63+
64+
#### Environment Setup
65+
66+
Copy the sample environment file located in `env/` into the target subdirectory of your choice (currently `testnet` or `mainnet`) and prefix the filename with your blockchain of choice:
67+
68+
```
69+
cp env/.env.sample env/testnet/sepolia.env
70+
```
71+
72+
Do this for each blockchain network that the `NTTManager` and `WormholeTransceiver` contracts will be deployed to. Then configure each `.env` file and set the `RPC` variables.
73+
74+
#### Config Setup
75+
76+
Before deploying the contracts, navigate to the `cfg` directory and copy the sample file. Make sure to preserve the existing name:
77+
78+
```
79+
cd cfg
80+
81+
cp WormholeNttConfig.json.sample WormholeNttConfig.json
82+
```
83+
84+
Configure each network to your liking (including adding/removing networks). We will eventually add the addresses of the deployed contracts to this file.
85+
86+
#### Deploy
87+
88+
Deploy the `NttManager` and `WormholeTransceiver` contracts by running the following command for each target network:
89+
90+
```
91+
bash sh/deploy_wormhole_ntt.sh -n NETWORK_TYPE -c CHAIN_NAME -k PRIVATE_KEY
92+
93+
# Argument examples
94+
-n testnet, mainnet
95+
-c avalanche, ethereum, sepolia
96+
```
97+
98+
Save the deployed proxy contract addresses in the `WormholeNttConfig.json` file.
99+
100+
#### Configuration
101+
102+
Once all of the contracts have been deployed and the addresses have been saved, run the following command for each target network:
103+
104+
```
105+
bash sh/configure_wormhole_ntt.sh -n NETWORK_TYPE -c CHAIN_NAME -k PRIVATE_KEY
106+
107+
# Argument examples
108+
-n testnet, mainnet
109+
-c avalanche, ethereum, sepolia
110+
```
111+
67112
# example-native-token-transfers
File renamed without changes.

0 commit comments

Comments
 (0)