Command Reference Guide

List of commands:

Configuration:

 --config string

path to config file to load

---

Filter:

  --filter-address string

specifies address to filter on

  --filter-asset string

specifies the asset fingerprint (asset1xxx) to filter on

  --filter-drep string

specifies DRep ID(s) to filter on (comma-separated, hex or bech32)

  --filter-policy string

specifies asset policy ID to filter on

  --filter-pool string

specifies Pool ID to filter on

  --filter-type string

specifies event type to filter on

4 Event Types:

1. input.block - A new block was observed.
2. input.rollback - A rollback occurred to a previous chain point.
3. input.transaction - A transaction was seen in a block.
4. input.governance - A governance-related event (CIP-1694 era).

---

Input:

  --input list

input plugin to use, ‘list’ to show available (default “chainsync”)

  --input string

input plugin to use, ‘list’ to show available (default “chainsync”)

input-chainsync:

  --input-chainsync-address string

specifies the TCP address of the node to connect to in the form ‘host:port’

 --input-chainsync-auto-reconnect

auto-reconnect if the connection is broken (default true)

  --input-chainsync-delay-confirmations uint

number of confirmations required before emitting events

  --input-chainsync-include-cbor

include original CBOR for block/transaction in events

  --input-chainsync-intersect-point string

start syncing at the specified chain point(s) in ’.’ format

  --input-chainsync-intersect-tip

start syncing at the chain tip (defaults to chain genesis) (default true)

  --input-chainsync-network string

specifies a well-known Cardano network name (default “mainnet”)

  --input-chainsync-network-magic uint

specifies the network magic value to use, overrides ‘network’

  --input-chainsync-ntc-tcp

use the NtC (node-to-client) protocol over TCP, for use when exposing a node’s UNIX socket via socat or similar

  --input-chainsync-socket-path string

specifies the path to the UNIX socket to connect to

---

  --input-chainsync-kupo-url string

kupo-url address

input-mempool:

  --input-mempool-address string

TCP address (host:port); requires ntc-tcp=true

  --input-mempool-include-cbor

include transaction CBOR in events

  --input-mempool-kupo-url string

Kupo API URL for resolving transaction inputs (e.g. http://localhost:1442). Kupo must index the outputs you need (e.g. run with —match ”*”) or resolution will be empty.

  --input-mempool-network string

well-known Cardano network name (e.g. mainnet, preprod) (default “mainnet”)

  --input-mempool-network-magic uint

network magic value (overrides network name)

  --input-mempool-ntc-tcp

use NtC over TCP (e.g. when exposing socket via socat)

  --input-mempool-poll-interval string

how often to poll the mempool (e.g. 5s, 1m) (default “5s”)

  --input-mempool-socket-path string

path to the node’s UNIX socket (NtC)

---

Logging:

  --logging-level string

logging level (debug, info, warn, error) (default “info”)

---

Output:

  --output string

output plugin to use, ‘list’ to show available (default “log”)

  --output-log-format string

specifies the output format: text (human-readable, default) or json (machine-parseable) (default “text”)

  --output-notify-title string

specifies the title to use (default “Adder”)

  --output-push-accessTokenUrl string

specifies the url to get access token from (default https://www.googleapis.com/auth/firebase.messaging)

  --output-push-serviceAccountFilePath string

specifies the path to the service account file

  --output-telegram-bot-token string

Telegram Bot API token (from @BotFather)

  --output-telegram-chat-id string

Telegram chat ID to send messages to (user, group, or channel)

  --output-telegram-disable-preview

disable link preview in messages

  --output-telegram-parse-mode string

message parse mode (HTML, Markdown, MarkdownV2) (default “HTML”)

  --output-webhook-format string

specifies the webhook payload format to use (default “adder”)

  --output-webhook-password string

specifies the password for basic auth

  --output-webhook-tls-skip-verify

skip tls verification (for self-signed certs)

  --output-webhook-url string

specifies the url to use (default http://localhost:3000)

  --output-webhook-username string

specifies the username for basic auth

---

Version:

  --version

show version and exit