4. Testing

We provide a comprehensive testing suite for Substreams modules. The testing suite is designed to facilitate end-to-end testing, ensuring that your Substreams modules function as expected. For unit tests, please use standard Rust unit testing practices.

Overview

The testing suite builds the .spkg for your Substreams module, indexes a specified block range, and verifies that the expected state has been correctly indexed by Tycho. Additionally, it will also try to simulate some transactions using the SwapAdapter interface.

Prerequisites

  • Latest version of the tycho-indexer binary in your PATH.

  • Access to PropellerHeads' private PyPI repository. Please contact us to obtain access.

  • Docker installed on your machine.

  • Conda and AWS cli installed

Test Configuration

Tests are defined in a yaml file. A documented template can be found at substreams/ethereum-template/integration_test.tycho.yaml. The configuration file should include:

  • The target Substreams config file.

  • The corresponding SwapAdapter and args to build it.

  • The expected protocol types.

  • The tests to be run.

Each test will index all blocks between start-block and stop-block, verify that the indexed state matches the expected state and optionally simulate transactions using SwapAdapter interface.

You will also need the VM Runtime file for the adapter contract. Our testing script should be able to build it using your test config. The script to generate this file manually is available under evm/scripts/buildRuntime.sh.

Setup testing environment

Step 1: Export Environment Variables

DOMAIN_OWNER

  • Description: The domain owner identifier for Propellerhead's AWS account, used to authenticate to the private PyPI repository.

  • Example: export DOMAIN_OWNER=123456789

Step 2: Create python virtual environment for testing

Run setup env script. It will create a conda virtual env and install all dependencies. This script must be run from within the propeller-protocol-lib/testing directory.

Please note that some dependencies require access to our private PyPI repository.

setup_env.sh

Running Tests

Step 1: Export Environment Variables

Export the required environment variables for the execution. You can find the available environment variables in the .env.default file. Please create a .env file in the testing directory and set the required environment variables.

Environment Variables

RPC_URL

  • Description: The URL for the Ethereum RPC endpoint. This is used to fetch the storage data. The node needs to be an archive node, and support debug_storageRangeAt.

  • Example: export RPC_URL="https://ethereum-mainnet.core.chainstack.com/123123123123"

SUBSTREAMS_API_TOKEN

  • Description: The API token for accessing Substreams services. This token is required for authentication.

  • Example: export SUBSTREAMS_API_TOKEN=eyJhbGci...

Step 2: Run tests

Run local postgres database using docker compose

docker compose up -d db

Run tests for your package.

python ./testing/src/runner/cli.py --package "your-package-name"

Example

If you want to run tests for ethereum-balancer, use:

conda activate propeller-protocol-lib-testing
export RPC_URL="https://ethereum-mainnet.core.chainstack.com/123123123123"
export SUBSTREAMS_API_TOKEN=eyJhbGci...
docker compose up -d db
python ./testing/src/runner/cli.py --package "ethereum-balancer"

Testing CLI args

A list and description of all available CLI args can be found using:

python ./testing/src/runner/cli.py --help
Previous3. Substream Package StructureNextCommon Problems & Patterns