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

  • Install Substreams CLI, you can either use brew:

    brew install streamingfast/tap/substreams

    use 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 -

    or compile from source:

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

Install Buf

  • Install buf, you can either use brew:

    $ brew install bufbuild/buf/buf

    Or follow alternative instruction from the official 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