v0.2.3

• Updated substreams-sink version to latest

v0.2.2

• Fixed TS.CREATERULE generating errors when already existing

v0.2.1

• Added Timeseries commands
• Added api endpoints

v0.1.1

• Updated substreams and substreams-sink

v0.1.0

Substreams Redis CLI Node.js

substreams-sink-redis is a tool that allows developers to pipe data extracted from a blockchain to a Redis KV store.

📖 Documentation

https://www.npmjs.com/package/substreams-sink-redis

Further resources

• Substreams documentation
• Redis documentation

Protobuf

• sf.substreams.sink.kv.v1.KVOperations

Pre-built binaries**

• MacOS
• Linux
• Windows

Install globally via npm

$ npm install -g substreams-sink-redis

Run

$ substreams-sink-redis run --help

Usage: substreams-sink-redis run [options] [<manifest>] <module_name>

Substreams redis sink module

Arguments:
  <manifest>                              URL or IPFS hash of Substreams package
  module_name                             Name of the output module (declared in the manifest)

Options:
  -e --substreams-endpoint <string>       Substreams gRPC endpoint to stream data from (default:
                                          "https://mainnet.eth.streamingfast.io:443")
  -s --start-block <int>                  Start block to stream from (defaults to -1, which means
                                          the initialBlock of the first module you are streaming)
  -t --stop-block <string>                Stop block to end stream at, inclusively
  --substreams-api-token <string>         API token for the substream endpoint
  --substreams-api-token-envvar <string>  Environnement variable name of the API token for the
                                          substream endpoint (default: "SUBSTREAMS_API_TOKEN")
  --delay-before-start <int>              [OPERATOR] Amount of time in milliseconds (ms) to wait
                                          before starting any internal processes, can be used to
                                          perform to maintenance on the pod before actually letting
                                          it starts (default: "0")
  --cursor-file <string>                  cursor lock file (default: "cursor.lock")
  --production-mode                       Enable Production Mode, with high-speed parallel
                                          processing (default: false)
  --verbose                               Enable verbose logging (default: false)
  --metrics-listen-address                If non-empty, the process will listen on this address for
                                          Prometheus metrics requests
  --metrics-listen-port                   If non-empty, the process will listen on this port for
                                          Prometheus metrics requests
  -p, --params <string...>                Set a params for parameterizable modules. Can be specified
                                          multiple times. Ex: -p module1=valA -p module2=valX&valY
                                          (default: [])
  -H --host <string>                      Redis instance host (default: "localhost")
  -p --port <string>                      Redis instance port number (default: "6379")
  -d --db <string>                        Redis database (default: "0")
  -u --username <string>                  Username to access Redis instance (default: "")
  -P --password <string>                  Password to access Redis instance (default: "")
  -T --tls                                Use TLS to connect to the Redis instance (default: false)
  -i --store-interval <int>               Interval in seconds, based on sf.substreams.v1.Clock, at
                                          which the data is stored in the KV database (default:
                                          "30")
  -h, --help                              display help for command

Features

• Consume *.spkg from:
  • Load URL or IPFS
  • Read from *.spkg local filesystem
  • Read from substreams.yaml local filesystem
• Handle cursor restart

Redis

• set
• mset

v0.0.1

Update Substreams V2