CLI reference

The public ruff-hub 0.2.0 package includes the read-only CLI. Use Node 22 or later:

npx ruff-hub --help

No build or source checkout is needed. Commands below use symbolic argument names; the mainnet quickstart supplies runnable commands with the deployed addresses.

RPC configuration

Pass --rpc-file PATH containing an HTTP(S) RPC URL, or provide RNG_RPC_URL in the process environment. Use a protected file if the URL includes provider credentials. No wallet private key is needed: this CLI reads and verifies; it does not submit transactions.

Commands

npx ruff-hub config --rpc-file ./rpc.txt --hub HUB_PROXY

npx ruff-hub quote --rpc-file ./rpc.txt --hub HUB_PROXY \
  --consumer CONSUMER_ADDRESS --gas 100000

npx ruff-hub status --rpc-file ./rpc.txt --hub HUB_PROXY \
  --sequence SEQUENCE

npx ruff-hub lane --rpc-file ./rpc.txt --hub HUB_PROXY --lane LANE_ID

Command	Output
config	Chain, hub version, owner, tariff, limits, lane information, and pending total.
quote	Fee and resolved callback gas for the supplied consumer. Gas defaults to zero, selecting the tariff default.
status	Stored request, with its status name.
lane	Lane state and remaining links. Omitting --lane selects the active lane.

Strict verification

npx ruff-hub verify --rpc-file ./rpc.txt --hub HUB_PROXY \
  --sequence SEQUENCE --from-block DEPLOYMENT_BLOCK

Option	Meaning	Default
--from-block	Start of the searched history; use the deployment block.	Required
--to-block	Last searched block.	Latest
--chunk	Blocks per log request.	10000
--max-head-steps	Maximum hashes for tying the seed to the published head.	2000000

Current-state verification

npx ruff-hub verify --rpc-file ./rpc.txt --hub HUB_PROXY \
  --sequence SEQUENCE --mode current

This mode reads current getters and may use their checkpoints. It does not require --from-block. Compare the verification modes.

Exit codes

Code	Meaning
0	Command succeeded; strict verification is complete and current state agrees.
1	Invalid arguments or an execution/RPC error.
2	A verification check failed.
3	Strict commitment checking exceeded the hashing budget; no complete proof.
4	Historical verification is complete, but current getters differ.
5	Historical verification is complete, but current state could not be fully checked.

For strict verification, historical failures take precedence, followed by incomplete commitment checking, any getter differences, and unavailable or unchecked getters. Code 0 from verify --mode current means that mode passed; it is not a strict historical proof. Inspect the structured result as well as the exit code. BigInt fields are serialized as decimal strings.