Files
tycho-protocol-sdk/substreams
Louise Poole 5c38cd6fb3 feat: improve substream release script
Improvements include:
- exit the script if any non-recoverable step fails
- fix bug where cargo version was hardcoded to be detected in balancer package
- allow optional input of substream config file. This is necessary for protocols with forks as they will have multiple configs in one directory
2024-10-17 19:43:07 +02:00
..
2024-10-14 18:16:18 +02:00
2024-03-14 01:24:43 +00:00
2024-10-11 14:24:55 +02:00

Substreams Indexing Integrations

Please refer to the official Substreams Indexing docs.

Release

To release a package simply tag a commit with the package name and its version: e.g. ethereum-balancer-0.1.0. This will create a release and automatically build and push the spkg into our registry.

Note

The CD pipeline will error if the Cargo version is not the same as the version in the tag.

Releases are immutable so do no try to delete tags or build the same release twice since this will error.

Pre release

To create a pre release for testing in dev you can start CD pipeline manually supplying the package you'd like to pre release. This will create a [package]-[semver].pre-[commit-sha] release in our spkg repository which you can use to run the substream´.

Test your implementation

To run a full end-to-end integration test you can refer to the testing script documentation