Skip to main content

Module node

Module node 

Source
Expand description

Arguments for the decdn node subcommand group.

node is the operator-local admin namespace: subcommands talk to the loopback admin HTTP surface (adr/appendix-local-admin-http.md) exposed by a running node.

Structs§

BondArgs
decdn node bond — stake to a capacity tier via CapacityBond.bond + declareMbps (ADR 019 § Step 2.1–2.2). Idempotent: it tops the active bond up to max(minBond, bondRequired(mbps)), approving and bonding only the shortfall, so a re-run after a partial failure converges instead of over-bonding. A precondition for decdn node register.
ChainArgs
Shared blockchain coordinates + keys for the on-chain node subcommands (register, bond). Flattened into each command’s args so they expose an identical flag group. The common coordinates live in CommonChainArgs; this struct adds the CapacityBond address. Each field is taken from a flag when present, otherwise the [blockchain] / [identity] tables of the TOML config (same file the daemon reads). rpc_url and capacity_bond_address are required (no default — the command errors if neither flag nor config supplies them); chain_id, keystore, and data_dir fall back to built-in defaults.
DeregisterArgs
decdn node deregister — leave the active set via CapacityBond.deregisterNode (ADR 003 § Node Registry, #1359).
DoctorArgs
decdn node doctor arguments.
DrainArgs
decdn node drain — trigger graceful shutdown of the running node via admin_v1_drain (issue #244, adr/appendix-local-admin-http.md). Fires the same runtime shutdown path as SIGTERM without needing the process PID.
EvictArgs
decdn node evict — forcibly remove a blob from the local cache via admin_v1_evict (issue #279).
HealthArgs
decdn node health — report identity (hex node_id) and process uptime via admin_v1_health.
LanesArgs
decdn node lanes — list open payment lanes via admin_v1_lanes (issue #749). Same admin-URL resolution and timeout semantics as decdn node health.
LookupArgs
decdn node lookup — unpaid client-side discovery of active nodes via CapacityBond.getRegisteredNodes (#1481). See NodeCommand::Lookup for the full description.
NodeArgs
Operator-local admin commands that query a running deCDN node.
PoolsArgs
decdn node pools — read the node’s buyer-side PaymentPool state via admin_v1_pools (#2078). Same admin-URL resolution and timeout semantics as decdn node health.
RegisterArgs
decdn node register — submit CapacityBond.registerNode (ADR 019 § Step 2.3). Performs an on-chain transaction rather than talking to a running node’s admin RPC.
ReloadArgs
decdn node reload — re-read the running node’s config file via admin_v1_reload (issue #373) and print the post-reload log_level.
RotateKeyArgs
decdn node rotate-key — the operator key-rotation runbook (adr/appendix-operator-key-rotation.md) as a command (#1034).
SlashesArgs
decdn node slashes — list detected slashes against this node’s operator via admin_v1_slashes (#1032). Same admin-URL resolution and timeout semantics as decdn node health.
StatusArgs
decdn node status — report DHT participation health via admin_v1_status (issue #741). Same admin-URL resolution and timeout semantics as decdn node health.
TopArgs
decdn node top — live metrics view (issue #275).
UnbondArgs
decdn node unbond — lower the bond via CapacityBond.requestUnbond + unbond (ADR 026 § Capacity-bond curve). One command covers all three phases of the window; which one runs is read from chain state, not from a flag. A run that lost its requestUnbond after declareMbps landed resumes on re-run, the way BondArgs converges; once requestUnbond HAS landed a re-run with an amount flag is a deliberate error, since the request can no longer be changed.
UpdateMultiaddrsArgs
decdn node update-multiaddrs — (re)publish the operator’s dialable QUIC addresses via CapacityBond.updateMultiaddrs (#1908). See NodeCommand::UpdateMultiaddrs for the full description. Performs an on-chain transaction rather than talking to a running node’s admin RPC.
UpdateRegionArgs
decdn node update-region — (re)attest the operator’s region via CapacityBond.updateRegion (ADR 030). See NodeCommand::UpdateRegion for the full description. Performs an on-chain transaction rather than talking to a running node’s admin RPC.

Enums§

NodeCommand
Subcommands under decdn node.
RotateKeyTarget
Which of the operator’s keys decdn node rotate-key rotates.