Skip to content

Latest commit

 

History

History
103 lines (84 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

103 lines (84 loc) · 3.12 KB
Raw

Contributing

Prerequisites

  1. substreams binary

    # 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 -
# mkdir ~/.local/bin 
mv substreams ~/.local/bin/substreams
substreams --version # 1.1.1

  2. API key from https://app.streamingfast.io/

    sudo apt-get install jq -y
export STREAMINGFAST_KEY=server_******* # Use your own API key
export SUBSTREAMS_API_TOKEN=$(curl https://auth.streamingfast.io/v1/auth/issue -s --data-binary '{"api_key":"'$STREAMINGFAST_KEY'"}' | jq -r .token)
    substreams run -e mainnet.eth.streamingfast.io:443 https://github.com/streamingfast/substreams-ethereum-quickstart/releases/download/1.0.0/substreams-ethereum-quickstart-v1.0.0.spkg map_block --start-block 12292922 --stop-block +1

  3. Environment deps

    <!-- npm install -g @bufbuild/buf -->
<!-- buf --version # 1.15.0 -->
curl -LO https://github.com/protocolbuffers/protobuf/releases/download/v23.2/protoc-23.2-linux-x86_64.zip
unzip protoc-23.2-linux-x86_64.zip -d $HOME/.local
protoc --version # libprotoc 23.2
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh # install rust
rustc --version # rustc 1.68.2 (9eb3afe9e 2023-03-27) after adding to $PATH
rustup target add wasm32-unknown-unknown
wget https://go.dev/dl/go1.20.4.linux-amd64.tar.gz # install go
sudo tar -C /usr/local -xzf go1.20.4.linux-amd64.tar.gz 
go version # go version go1.20.4 linux/amd64 after adding to $PATH

  4. TheGraph deps:

    npm install -g @graphprotocol/graph-cli
graph --version # @graphprotocol/graph-cli/0.51.0 wsl-x64 node-v20.2.0
npm install -g go-ipfs
ipfs --version # ipfs version 0.20.0
ipfs daemon

Running

Install:

npm i

Build:

make build

Run:

make stream

Deployment

git clone https://github.com/kernelwhisperer/protofun
cd protofun
sudo apt install make -y
sudo apt-get install jq -y
nano ~/.profile
# paste these 2 lines
export STREAMINGFAST_KEY=server_******* # Use your own API key
export SUBSTREAMS_API_TOKEN=$(curl https://auth.streamingfast.io/v1/auth/issue -s --data-binary '{"api_key":"'$STREAMINGFAST_KEY'"}' | jq -r .token)
echo $SUBSTREAMS_API_TOKEN
# create/update port forwarding
make start-graph-node
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh # install rust
source "$HOME/.cargo/env"
rustc --version # rustc 1.68.2 (9eb3afe9e 2023-03-27) after adding to $PATH
rustup target add wasm32-unknown-unknown
sudo apt install build-essential -y
# 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 -
mkdir ~/.local/bin 
mv substreams ~/.local/bin/substreams
# restart shell
substreams --version # 1.1.1
# install nvm
npm install -g @graphprotocol/graph-cli
make deploy-graph