-
Notifications
You must be signed in to change notification settings - Fork 139
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Overhaul README and drop trophies directory #47
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,21 @@ | ||
# 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](https://github.com/strangelove-ventures/ibc-test-framework/pull/7) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please link to #8 also. #7 was the first step of reproducing the halt, and #8 was testing the strategy for bringing the network back online.