Skip to content

Commit

Permalink
Overhaul README and drop trophies directory (#47)
Browse files Browse the repository at this point in the history
* Overhaul README and drop trophies directory

The trophies directory was becoming quickly outdated, so remove it and
instead add a section to the README to serve roughly the same purpose.

* Fix README trophy links
  • Loading branch information
mark-rushakoff authored Apr 26, 2022
1 parent 4d75508 commit ab20312
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 424 deletions.
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# IBC Test Framework

This repo is going to house a new IBC testing framework based on the following work:
- https://github.com/PeggyJV/sommelier/tree/main/integration_tests
- https://github.com/strangelove-ventures/horcrux/tree/main/test
- https://github.com/cosmos/relayer/tree/main/test
The IBC Test Framework orchestrates Go tests that utilize Docker containers for multiple
[IBC](https://docs.cosmos.network/master/ibc/overview.html)-compatible blockchains.

The goals are to support:
- [ ] Testing complex IBC interactions between arbitrary chains
- [ ] Testing multiple relayer implemenations
- [ ] cosmos/relayer
- [ ] hermes
- [ ] tsrelayer
- [ ] Testing multiple versions of each chain and compatability of new versions
## Contributing

The tests will be run in `go test` and utilize docker to spin up complete chains and utilize only the chain docker images themseleves.
Running `make ibctest` will produce an `ibctest` binary into `./bin`.
Running that binary without any extra arguments will run a simple IBC test suite involving
the [Go Relayer](https://github.com/cosmos/relayer).
Alternatively, you can run `ibctest -matrix path/to/matrix.json` to define a set of chains to IBC-test.
See [`cmd/ibctest/README.md`](cmd/ibctest/README.md) for more details.

This repo will rely on images built from https://github.com/strangelove-ventures/heighliner
Note that `ibc-test-framework` is under active development
and we are not yet ready to commit to any stable APIs around the testing interfaces.

## Trophies

Significant bugs that were more easily fixed with the `ibc-test-framework`:

- [Juno network halt reproduction](https://github.com/strangelove-ventures/ibc-test-framework/pull/7)
- [Juno network halt fix confirmation](https://github.com/strangelove-ventures/ibc-test-framework/pull/8)
Loading

0 comments on commit ab20312

Please sign in to comment.