added readme for evm-messenger
This commit is contained in:
parent
c2280791eb
commit
f2c071fc55
|
@ -0,0 +1,25 @@
|
|||
# EVM Messenger
|
||||
Simple messenger project that sends a "Hello World" message between two EVM chains using Wormhole.
|
||||
|
||||
## Dependencies
|
||||
This project uses Foundry to compile and deploy EVM contracts. You can find install instructions at [`https://getfoundry.sh`](http://getfoundry.sh)
|
||||
|
||||
The javascript dependencies can be installed via `npm install` in this folder.
|
||||
|
||||
You will also need Docker; you can get either [Docker Desktop](https://docs.docker.com/get-docker/) if you're developing on your computer or if you're in a headless vm, install [Docker Engine](https://docs.docker.com/engine/)
|
||||
|
||||
## Run Guardiand
|
||||
After you have the dependencies installed, we'll need to spin up the EVM chains, deploy the Wormhole contracts to them, then startup a Wormhole Guardian to observe and sign VAAs. We have provided a script to automate this all for you.
|
||||
|
||||
Simply run `npm run guardiand` and wait while the Wormhole Guardian builds a docker image. The first time you run this command, it might take a while (up to 550 seconds on a modern laptop!). After the image is built however, it'll be relatively fast to bring it up and down.
|
||||
|
||||
## Test Scripts
|
||||
After you have Guardiand running, you can run the basic test with `npm run test`. This will:
|
||||
- Deploy a simple Messenger contract (found in chains/evm/src/Messenger.sol) to each EVM chain
|
||||
- Register each contract with the other chain
|
||||
- Send a message from each contract
|
||||
- Fetch the VAA from the Guardian
|
||||
- Submit the VAA to each contract
|
||||
- Print out the Message
|
||||
|
||||
If everything goes correctly, you should get a printout with the Hello World messages on each chain.
|
Loading…
Reference in New Issue