Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 3.31 KB

README.md

File metadata and controls

54 lines (39 loc) · 3.31 KB

Ethereum publisher

Latest release License: MIT GitHub Workflow Status (with event)

Establishes connection with Ethereum blockchain node and publishes blockchain data to Synternet.

Prerequisits

Usage

make dep
make build
./ethereum-publisher --ipc-path /var/lib/ethereum/geth.ipc --prefix synternet

Environment variables and flags

Environment variables can be passed to docker container. Flags can be passed as executable arguments.

Environment variable Flag Description
IPC_PATH ipc-path Ethereum node IPC path, e.g.: /tmp/geth.ipc
NATS_URLS nats-urls (optional) NATS connection URLs to Synternet brokers, e.g.: nats://e.f.g.h. URL to broker. Default: testnet.
NATS_NKEY nats-nkey NATS user NKEY, e.g.: SU..SI (58 chars). See here.
NATS_JWT nats-jwt NATS user JWT, e.g.: eyJ.... See here.
PUBLISHER_PREFIX publisher-prefix Stream prefix, usually your organisation, e.g.: synternet prefix results in synternet.ethereum.<tx,log-even,header,...> stream subjects. Stream prefix should be same as registered wallet alias.
PUBLISHER_NAME publisher-name (optional) Stream publisher infix, e.g.: foo infix results in prefix.foo.<tx,log-even,header,...> stream subjects. Stream publisher infix should be same as registered publisher alias. Default: ethereum.

Auth with NATS credentials

Synternet uses NATS authentication model. NATS has an accounts level with users belonging to those accounts. To publish user level NKEY and JWT have to be used, which are generated from account.

  1. Acquire account level NKEY (in Synternet a.k.a. access token). See here.
  2. Generate user level NATS_NKEY, NATS_JWT from account level NKEY. Can be generated using user generator.
  3. Pass generated NATS_NKEY and NATS_JWT.

Docker

From source

docker build -t ethereum-publisher -f docker/Dockerfile .

Prebuilt image

docker run --rm --env-file=.env -v /tmp/ethereum.ipc:/tmp/ethereum.ipc ghcr.io/synternet/ethereum-publisher:latest