Skip to content

Commit

Permalink
readme update with testing
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthew Lam committed Sep 5, 2023
1 parent 30871f0 commit cc775c2
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,31 @@ The relayer consists of the following components:
<div align="center">
<img src="resources/relayer-diagram.png?raw=true">
</div>

## Testing

---

### Unit tests

Unit tests can be ran locally by running the command in root of the project:

```
go test ./...
```

### E2E tests

E2E tests are ran as part of CI, but can also be ran locally. To run the E2E tests locally, you need to have the `avalanchego` build path and vm binary set up. For example with [subnet-evm](https://github.com/ava-labs/subnet-evm):

```
cd <SUBNET_EVM_PATH>
BASEDIR=/tmp/e2e-test AVALANCHEGO_BUILD_PATH=/tmp/e2e-test/avalanchego ./scripts/install_avalanchego_release.sh
./scripts/build.sh /tmp/e2e-test/avalanchego/plugins/srEXiWaHuhNyGwPUi444Tu47ZEDwxTWrbQiuD7FmgSAQ6X7Dy
```

Then, in the root of the `awm-relayer` project, run:

```
AVALANCHEGO_BUILD_PATH=/tmp/e2e-test/avalanchego DATA_DIR=/tmp/e2e-test/data ./scripts/e2e_test.sh
```

0 comments on commit cc775c2

Please sign in to comment.