From 55065e020afe50d88d64cb8d06490b4e00e5b24a Mon Sep 17 00:00:00 2001 From: Ian Traas <108365619+itraas@users.noreply.github.com> Date: Mon, 5 Sep 2022 20:02:15 -0500 Subject: [PATCH] Update overview.md Updated formatting for link style and consistency. --- src/projects/evm-messenger/overview.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/projects/evm-messenger/overview.md b/src/projects/evm-messenger/overview.md index be335d1..f7cc758 100644 --- a/src/projects/evm-messenger/overview.md +++ b/src/projects/evm-messenger/overview.md @@ -7,19 +7,23 @@ Before you get started with this project, make sure you have a local Wormhole Gu Let's break down the files you're going to find in the [evm-messenger](https://github.com/certusone/xdapp-book/tree/main/projects/evm-messenger) folder. ### Chains + The `chains/` folder contains the source code that's actually being deployed to the EVM chain. The `evm/` folder found inside was generated using [`forge init`](https://getfoundry.sh). There are two files of note in this folder, `src/Wormhole/IWormhole.sol` and `src/Messenger.sol`. The IWormhole file is the Wormhole Core Bridge interface, and is required if your app wants to talk to the Wormhole Core Bridge. It outlines the functions and return values you can expect from the Wormhole contract. -The second file, Messenger, is covered in our breakdown of the EVM code [here](./messenger.md). +The second file, Messenger, is covered in our breakdown of the EVM code at [./messenger.md](./messenger.md). ### Tests + We have a very simple test script written in bash, but it's less of a test script and more of a happy path walkthrough. It makes uses of Orchestrator.js (see below) to call the functions on our EVM contract in order. To start, deploy the code, register the applications on each chain and then send a message. ### Orchestrator -Orchestrator is a js client that takes arguments from the command line to call various functions on our contract. We'll break down everything orchestator does [here](./client.md). + +Orchestrator is a js client that takes arguments from the command line to call various functions on our contract. We'll break down everything Orchestator does at [./client.md](./client.md). ### xdapp.config.json + This maintains some constants about the chains RPC endpoints, private keys used to deploy code, etc. It also includes the Wormhole RPC endpoint.