StreamingFast Substreams Template

Quick Start (Locally)

Use this quickstart guide to set up your environment to use Substreams locally.

First, copy this repository and clone it.

Quick Start (Gitpod)

Use these steps to conveniently open your repository in a Gitpod.

1. First, copy this repository
2. Grab a StreamingFast key from https://app.streamingfast.io/
3. Create a Gitpod account
4. Configure a STREAMINGFAST_KEY variable in your Gitpod account settings
5. Open your repository as a Gitpod workspace

Install Dependencies & Authentication

Follow Installation Requirements instructions on official Substreams documentation website.

Also make sure that you grabbed your StreamingFast API key and generated a Substreams API token set to environment SUBSTREAMS_API_TOKEN, see authentication instructions for how to do it.

Validation

Ensure that substreams CLI works as expected:

substreams -v
version (...)

Generating Protobuf

substreams protogen ./substreams.yaml --exclude-paths="sf/substreams,google"

We exclude paths that are not required to have locally.

Compile

At this point, we're ready to build our WASM binary and Protobuf definitions.

cargo build --target wasm32-unknown-unknown --release

The resulting WASM artifact will be found at ./target/wasm32-unknown-unknown/release/substreams.wasm

Run your Substreams

We're now ready to run our example Substreams!

Don't forget to be at the root of the project to run the following commands

substreams run -e mumbai.streamingfast:443 substreams.yaml map_transfers --start-block 12292922 --stop-block +1

Let's break down everything happening above.

• substreams is our executable
• -e mumbai.eth.streamingfast.io:443 is the provider going to run our Substreams
• substream.yaml is the path where we have defined our Substreams Manifest
• map_transfers this is the module which we want to run, defined in the manifest (must be of map kind)
• --start-block 12292922 start from block 12292922
• --stop-block +1 only request a single block (stop block will be manifest's start block + 1)

Here is the example of an output of the map_transfers starting at 12292922 block for only 1 block. The [...] was added to abbreviate the JSON output as there was a lot of ERC20 transfers.

----------- IRREVERSIBLE BLOCK #12,292,922 (12292922) ---------------
map_transfers: "message "eth.tx.v1.Transfers": {
  "transfers": [
    {
      "from": "AAAAAAAAAAAAAAAAAAAAAAAAAAA=",
      "to": "q6cWGn+2nIjhbtn0Vc5it5HuTQM=",
      "trxHash": "z7GX9i7Fx/DnGhHsDEoOOUo6pB21OG6FUm+GyEs/J5Y=",
      "ordinal": "85"
    },
    <continued>,
    {
      "from": "AAAAAAAAAAAAAAAAAAAAAAAAAAA=",
      "to": "q6cWGn+2nIjhbtn0Vc5it5HuTQM=",
      "tokenId": "29",
      "trxHash": "z7GX9i7Fx/DnGhHsDEoOOUo6pB21OG6FUm+GyEs/J5Y=",
      "ordinal": "114"
    }
  ]
}

Bytes are rendered with base64 encoding by default, so it might be a little troubling to see q6cWGn+2nIjhbtn0Vc5it5HuTQM= as an Ethereum address, but it's actually aba7161a7fb69c88e16ed9f455ce62b791ee4d03, you can use string instead of bytes if you prefer that in your Protobuf definitions.

Next Steps

Congratulations! You've successfully run a Substreams.

• Read the documentation at https://substreams.streamingfast.io.
• Look at Playground for more learning examples.