1. Setup

Install Rust

Install Rust. You can do so with the following command:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Install Substreams

You can do so with any of the following:

Using Homebrew:

brew install streamingfast/tap/substreams

Using precompiled binaries

# Use correct binary for your platform
LINK=$(curl -s https://api.github.com/repos/streamingfast/substreams/releases/latest | awk '/download.url.*linux/ {print $2}' | sed 's/"//g')
curl -L  $LINK  | tar zxf -

Compiling from source:

git clone https://github.com/streamingfast/substreams
cd substreams
go install -v ./cmd/substreams

Install Buf

Using Homebrew:

$ brew install bufbuild/buf/buf

For other installation methods, see the official buf website

Fork the SDK repo

  1. Start by making a fork of the Tycho Protocol SDK repository

  2. Clone the fork you just created

  3. Make sure everything compiles fine

    cd substreams
    cargo check --all

Last updated