Command Reference Guide
List of commands:
Section titled “List of commands:”Configuration:
Section titled “Configuration:” --config stringpath 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:
Section titled “Filter:” --filter-address stringspecifies address to filter on
--filter-asset stringspecifies the asset fingerprint (asset1xxx) to filter on
--filter-drep stringspecifies DRep ID(s) to filter on (comma-separated, hex or bech32)
--filter-policy stringspecifies asset policy ID to filter on
--filter-pool stringspecifies Pool ID to filter on
--filter-type stringspecifies 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:
input.block- A new block was observed.input.rollback- A rollback occurred to a previous chain point.input.transaction- A transaction was seen in a block.input.governance- A governance-related event (CIP-1694 era).input.drep-registration- A DRep registration occurred.
Input:
Section titled “Input:” --input stringinput plugin to use, ‘list’ to show available (default “chainsync”)
Input Types:
chainsync- syncs blocks from a Cardano node using either NtC (node-to-client) or NtN (node-to-node)mempool- reads unconfirmed transactions from a Cardano node’s mempool via LocalTxMonitor (NtC)
input-chainsync:
Section titled “input-chainsync:” --input-chainsync-address stringspecifies the TCP address of the node to connect to in the form ‘host:port’
--input-chainsync-auto-reconnectauto-reconnect if the connection is broken (default true)
--input-chainsync-delay-confirmations uintnumber of confirmations required before emitting events
--input-chainsync-include-cborinclude original CBOR for block/transaction in events
--input-chainsync-intersect-point stringstart 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-tipbehavior.Adder treats malformed non-empty
<slot>.<hash>entries as errors.
--input-chainsync-intersect-tipstart syncing at the chain tip (defaults to chain genesis) (default true)
--input-chainsync-network stringspecifies a well-known Cardano network name (default “mainnet”)
--input-chainsync-network-magic uintspecifies the network magic value to use, overrides ‘network’
--input-chainsync-ntc-tcpuse 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 stringspecifies the path to the UNIX socket to connect to
--input-chainsync-kupo-url stringkupo-url address
input-mempool:
Section titled “input-mempool:” --input-mempool-address stringTCP address (host:port); requires ntc-tcp=true
--input-mempool-include-cborinclude transaction CBOR in events
--input-mempool-kupo-url stringKupo 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 stringwell-known Cardano network name (e.g. mainnet, preprod) (default “mainnet”)
--input-mempool-network-magic uintnetwork magic value (overrides network name)
--input-mempool-ntc-tcpuse NtC over TCP (e.g. when exposing socket via socat)
--input-mempool-poll-interval stringhow often to poll the mempool (e.g. 5s, 1m) (default “5s”)
--input-mempool-socket-path stringpath to the node’s UNIX socket (NtC)
Output:
Section titled “Output:” --output stringoutput plugin to use,
notify-jsonfor notification NDJSON, orlistto show available (default “log”)
--output-log-level stringsets the
output.loglogging threshold. Accepted values aredebug,info,warn, anderror(default “info”).debugandinfoemit event records;warnanderrorsuppress 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.levelor theOUTPUT_LOG_LEVELenvironment variable. Adder removed the old--logging-levelflag and top-level YAMLlogging.levelsetting and rejects them when supplied. Adder removed the oldLOGGING_LEVELenvironment variable and ignores it.
--output-log-format stringspecifies the output format: text (human-readable, default) or json (machine-parseable) (default “text”)
--output-notify-json-config stringpath to the versioned notification JSON configuration used by
notify-jsonrequired when
--output notify-jsonis selected
--output-notify-title stringspecifies the title to use (default “Adder”)
--output-push-accessTokenUrl stringspecifies the url to get access token from (default
https://www.googleapis.com/auth/firebase.messaging)
--output-push-serviceAccountFilePath stringspecifies the path to the service account file. This value must be non-empty when using
--output push.The service-account JSON must contain
project_idas a non-empty string. Missing, non-string, or emptyproject_idvalues cause startup/configuration failure.
--output-telegram-bot-token stringTelegram Bot API token (from @BotFather)
--output-telegram-chat-id stringTelegram chat ID to send messages to (user, group, or channel)
--output-telegram-disable-previewdisable link preview in messages
--output-telegram-parse-mode stringmessage parse mode (HTML, Markdown, MarkdownV2) (default “HTML”)
--output-webhook-format stringspecifies the webhook payload format to use (default “adder”)
--output-webhook-password stringspecifies the password for basic auth
--output-webhook-tls-skip-verifyskip tls verification (for self-signed certs)
--output-webhook-url stringspecifies the url to use (default
http://localhost:3000)
--output-webhook-username stringspecifies the username for basic auth
Notifications:
Section titled “Notifications:”adder notifications validate --config <path> [--json]validates a notification JSON configuration
--config <path>is required. Normal output reports validity and errors.--jsonemits the machine-readable validation result.
Notification JSON configuration
Section titled “Notification JSON configuration”The configuration uses JSON with schemaVersion set to 1. Adder rejects unknown fields and multiple JSON values in the configuration file.
| Field | Description |
|---|---|
schemaVersion | Required value: 1. |
network.name | Required supported Cardano network: mainnet, preprod, or preview. |
network.customAddress and network.customPort | Optional custom node address and port. Set both fields together; customPort must be between 1 and 65535. |
monitor.everything | Set to true to monitor all supported targets. Set this field or configure at least one target in wallets, dreps, pools, assets, or policies. |
monitor.wallets | Wallet addresses to monitor. |
monitor.dreps | DRep IDs to monitor. monitor.drepMatch accepts any or all. |
monitor.pools | Pool IDs to monitor. monitor.poolMatch accepts any or all. |
monitor.assets | Asset fingerprints to monitor. monitor.assetMatch accepts any or all. |
monitor.policies | Policy IDs to monitor. monitor.policyMatch accepts any or all. |
alerts | Alert categories to enable: incomingTransactions, outgoingTransactions, tokenTransfers, blocksMinted, chainRollbacks, poolParameterChanges, governanceProposals, votesCast, registrationChanges, assetActivity, policyActivity, and connectionIssues. Enable at least one category. |
rateLimit.max | Required value of -1 to disable rate limiting, or 0 or greater. |
rateLimit.windowSeconds | Required positive duration in seconds. |
connectionStaleSeconds | Required 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.
notify-json output
Section titled “notify-json output”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:
Section titled “Version:” --versionshow version and exit
Docs authored by Doc Holiday