Skip to content

Command Reference Guide


--config string

path to config file to load

If the same setting is provided through multiple methods, Adder uses this precedence order: CLI flags > environment variables > YAML configuration file > defaults.


--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

For --filter-address, --filter-asset, --filter-policy, --filter-pool, --filter-drep, and --filter-type, Adder trims surrounding whitespace from comma-separated entries and ignores empty entries.

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).
  5. input.drep-registration - A DRep registration occurred.

--input string

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

Input Types:

  1. chainsync - syncs blocks from a Cardano node using either NtC (node-to-client) or NtN (node-to-node)
  2. mempool - reads unconfirmed transactions from a Cardano node’s mempool via LocalTxMonitor (NtC)
--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

Adder trims whitespace from each comma-separated entry and ignores empty entries.

If the value contains only whitespace or empty entries after trimming, Adder follows the configured --input-chainsync-intersect-tip behavior.

Adder treats malformed non-empty <slot>.<hash> entries as errors.


--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-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)


--output string

output plugin to use, notify-json for notification NDJSON, or list to show available (default “log”)


--output-log-level string

sets the output.log logging threshold. Accepted values are debug, info, warn, and error (default “info”). debug and info emit event records; warn and error suppress event records. The threshold also filters Adder application diagnostics on stderr, even when another output plugin is selected.

Configure the same setting with YAML plugins.output.log.level or the OUTPUT_LOG_LEVEL environment variable. Adder removed the old --logging-level flag and top-level YAML logging.level setting and rejects them when supplied. Adder removed the old LOGGING_LEVEL environment variable and ignores it.


--output-log-format string

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


--output-notify-json-config string

path to the versioned notification JSON configuration used by notify-json

required when --output notify-json is selected


--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. This value must be non-empty when using --output push.

The service-account JSON must contain project_id as a non-empty string. Missing, non-string, or empty project_id values cause startup/configuration failure.


--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


adder notifications validate --config <path> [--json]

validates a notification JSON configuration

--config <path> is required. Normal output reports validity and errors. --json emits the machine-readable validation result.

The configuration uses JSON with schemaVersion set to 1. Adder rejects unknown fields and multiple JSON values in the configuration file.

FieldDescription
schemaVersionRequired value: 1.
network.nameRequired supported Cardano network: mainnet, preprod, or preview.
network.customAddress and network.customPortOptional custom node address and port. Set both fields together; customPort must be between 1 and 65535.
monitor.everythingSet to true to monitor all supported targets. Set this field or configure at least one target in wallets, dreps, pools, assets, or policies.
monitor.walletsWallet addresses to monitor.
monitor.drepsDRep IDs to monitor. monitor.drepMatch accepts any or all.
monitor.poolsPool IDs to monitor. monitor.poolMatch accepts any or all.
monitor.assetsAsset fingerprints to monitor. monitor.assetMatch accepts any or all.
monitor.policiesPolicy IDs to monitor. monitor.policyMatch accepts any or all.
alertsAlert categories to enable: incomingTransactions, outgoingTransactions, tokenTransfers, blocksMinted, chainRollbacks, poolParameterChanges, governanceProposals, votesCast, registrationChanges, assetActivity, policyActivity, and connectionIssues. Enable at least one category.
rateLimit.maxRequired value of -1 to disable rate limiting, or 0 or greater.
rateLimit.windowSecondsRequired positive duration in seconds.
connectionStaleSecondsRequired staleness interval from 30 through 3600 seconds.

Target lists must contain valid, nonduplicate wallet addresses, DRep IDs, pool IDs, asset fingerprints, or policy IDs. The notification network must match --input-chainsync-network. When a custom node is configured, its address and port must match --input-chainsync-address. The notify-json output requires the chainsync input.

The notify-json output writes one JSON object per line to stdout. Each record uses schema version 1. Status records report starting, connected, or stale states and include a timestamp and optional message. Notification records include ruleId, optional eventType, rendered title and body, plus the batching fields batched and count.


--version

show version and exit


Doc Holiday logo

Docs authored by Doc Holiday