v0.1.0

Substreams Google Sheets sink module

substreams-sink-sheets pushes Substreams DatabaseChanges map db_out outputs to Google Sheets.

Further resources

• Substreams documentation
• Substreams DatabaseChanges

CLI

Use pre-built binaries

• MacOS
• Linux
• Windows

Install globally via npm

$ npm install -g substreams-sink-sheets

Run

$ substreams-sink-sheets run [options] <spkg>

Features

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

• List compatible modules from .spkg

• GoogleSheet API support
  • Authenticate via JWT credentials
  • Append row to sheet
  • Work with different credentials (service account, OAuth, etc.)
  • Permission checking for editing
• Select columns to output
  • Time (date,year,month,day,timestamp,seconds)
  • Block (block_num)
  • DatabaseChanges
  • Add missing columns headers to sheet if not present
• Create a new sheet if no spreadsheetId specified
• Set start-block & end-block
• Select outputModule (default db_out)
• Select Substream endpoint (default mainnet.eth.streamingfast.io:443)
• DatabaseChanges support
  • UNSET
  • CREATE
  • UPDATE
  • DELETE
• Rate limiting
  • 1 request per second (Google rate limit is 100 requests per 100 seconds)
  • Batch updates

References

• https://developers.google.com/sheets/api/guides/concepts#cell
• https://developers.google.com/sheets/api/reference/rest/v4/ValueInputOption
• https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/append#insertdataoption