# Packages
# README
interchaintest
Formerly known as ibctest.
interchaintest orchestrates Go tests that utilize Docker containers for multiple
IBC-compatible blockchains.
It allows users to quickly spin up custom testnets and dev environments to test IBC, chain infrastructures, smart contracts, etc.
Table Of Contents
- Branch Versioning
- Use Cases:
- Importing as a Module
- Running as a Binary
- Building Binary
- Running Conformance Tests - Suite of built-in tests that test high-level IBC compatibility
- Write Custom Tests
- Environment Variable Options
- Retaining Data on Failed Tests
Maintained Branches
| Branch Name | IBC-Go | Cosmos-sdk |
|---|---|---|
| main | v8 | v0.50 |
| v7 | v7 | v0.47 |
Depreciated Branches
These are branches that we no longer actively update or maintain but may be of use if a chain is running older versions of the Cosmos SDK or IBC Go. Please see the Backport Policy below.
| Branch Name | IBC-Go | Cosmos-sdk | Depreciated Date |
|---|---|---|---|
| v6 | v6 | v0.46 | Sept 5 2023 |
| v5 | v5 | v0.46 | Aug 11 2023 |
| v4 | v4 | v0.45 | Aug 11 2023 |
| v4-ics | v4 | v0.45.x-ics | Aug 11 2023 |
| v3 | v3 | v0.45 | June 25 2023 |
| v3-ics | v3 | v0.45.11-ics | April 24 2023 |
Backport Policy:
Strangelove maintains n and n - 1 branches of interchaintest, n being current main.
We strive to keep interchaintest inline with the latest from the ibc-go and cosmos sdk teams. Once an alpha versions of the next major ibc-go version is released, we will discontinue n - 1 and branch off a new n.
Recommendation: Even if your chain uses an older version of ibc-go, try importing from main. This should work unless you are decoding transactions that require a specific ibc-go version.
If there is a feature you would like backported to an older branch, make an issue! We are happy to work with you.
Contributing
Contributing is encouraged.
Please read the logging style guide.
Trophies
Significant bugs that were more easily fixed with interchaintest: