Authentication

To connect to the Substreams server you will need to get a StreamingFast authentication token. The authentication token is essentially a JWT that will give you access to the StreamingFast infrastructure.
The first step is to get a StreamingFast API key that will allow you to get a token. You can sign up at https://app.dfuse.io/ to get a key or you can ask us in discord.
Once you have your key, you can use this one-liner to get your token:
curl https://auth.dfuse.io/v1/auth/issue -s \
    --data-binary \
    '{"api_key":"'$SF_API_KEY'"}' | jq -r .token
Once you have obtained a token, you should set it as an ENV variable:
export SUBSTREAMS_API_TOKEN="your_token"
The substreams run command will check by default the SUBSTREAMS_API_TOKEN environment variable for your StreamingFast authentication token.
Authentication Token Env Flag
You can change the default behavior of the substreams run command and specify your own ENV var name that has the Authentication token with the flag --substreams-api-token-envvar
We suggestion you setup the following bash function that you can call to get a token. Dump this function somewhere like .bashrc:
# Ask us on Discord for a key
export STREAMINGFAST_KEY=server_YOUR_KEY_HERE  
function sftoken {
    export FIREHOSE_API_TOKEN=$(curl https://auth.dfuse.io/v1/auth/issue -s --data-binary '{"api_key":"'$STREAMINGFAST_KEY'"}' | jq -r .token)
	export SUBSTREAMS_API_TOKEN=$FIREHOSE_API_TOKEN
    echo Token set on FIREHOSE_API_TOKEN and SUBSTREAMS_API_TOKEN
}
Then in your shell, load a key into an environment variable with:
sftoken

Reference & Specs - Previous

Using the CLI

Next - Reference & Specs

Rust APIs

Last modified 2mo ago

Copy link