v0.2.0

What's Changed

• Update webhook signature by @DenisCarriere in #37

Full Changelog: v0.1.10...v0.2.0

v0.1.10

What's Changed

• Update to latest substreams-sink-webhook signature by @DenisCarriere in #35

New Contributors

• @DenisCarriere made their first contribution in #35

Full Changelog: v0.1.9...v0.1.10

v0.1.9

• Improve logging

$ npm start

> substreams-sink-websockets@0.1.8 start
> bun run index.ts

2023-10-07 20:36:13.542 INFO            substreams-sink-websockets      Server listening on http://0.0.0.0:3000
2023-10-07 20:36:13.543 INFO            substreams-sink-websockets      Verifying with PUBLIC_KEY a3cb7366ee8ca77225b4d41772e270e4e831d171d1de71d91707c42e7ba82cc9
2023-10-07 20:36:13.543 INFO            substreams-sink-websockets      Reading SQLITE_FILENAME db.sqlite

v0.1.8

• Add Commander CLI

$ substreams-sink-websockets --help

Usage: substreams-sink-websockets [options]

Substreams Sink Websockets

Options:
  --public-key <string>       (required) Ed25519 public key (env: PUBLIC_KEY)
  --port <int>                Server listen on HTTP port (default: 3000, env: PORT)
  --hostname <string>         Server listen on HTTP hostname (default: "0.0.0.0", env: HOSTNAME)
  --sqlite-filename <string>  SQLite database filename (default: "db.sqlite", env: SQLITE_FILENAME)
  --verbose <boolean>         Enable verbose logging (default: false, env: VERBOSE)
  -V, --version               output the version number
  -h, --help                  display help for command

v0.1.7

Substreams Sink WebSockets

substreams-sink-websockets is a tool that allows developers to pipe data extracted from a blockchain to WebSockets.

Requirements

• Substreams Sink Webhook

Quickstart

$ bun install
$ bun dev

Bun Binary Releases

Linux Only

$ wget https://github.com/pinax-network/substreams-sink-websockets/releases/download/v0.1.7/substreams-sink-websockets
$ chmod +x ./substreams-sink-websockets

Docker environment

Pull from GitHub Container registry

docker pull ghcr.io/pinax-network/substreams-sink-websockets:latest

Build from source

docker build -t substreams-sink-websockets .

Run with .env file

docker run -it --rm --env-file .env ghcr.io/pinax-network/substreams-sink-websockets

.env Environment variables

PORT=3000
PUBLIC_KEY=...

Standalone Bun executable

https://github.com/pinax-network/substreams-sink-websockets/releases

📖 References

• Substreams documentation
• Bun WebSockets

Features

• Accept Substreams Webhook message POST /
• Client connect to WebSocket service
• Verify tweetnacl Substreams Webhook message
• Send WebSocket messages
• Unit testing
• Prometheus Metrics GET /metrics
• Health check GET /health
• Banner GET /
• Commander CLI