NETSoon

Docs Reference

CLI

The acrux command line. Every command, its options and what it prints.

acrux is the node's binary. Install acrux-node builds it. acrux <command> --help prints the same options.

Commands

CommandDoes
acrux net upruns a New Constellation net: twelve validators in FRA, NYC and TYO, with the gateway and metrics
acrux cluster upthe same net, named by its hubs
acrux keygenwrites a new Solana keypair file
acrux sendsends a transfer, plain or t-of-n, and follows it to finality
acrux node followre-executes a net slot by slot and checks every state hash
acrux hubregister, join, leave, move, release on the Hub Registry
acrux scheduleruns Algorithm 3 on hubs read from stdin
acrux lab runruns one Fault Lab scenario on a sandbox cluster

acrux net up

Terminal
acrux net up [--gateway-port PORT] [--ws-port PORT] [--base-port PORT] [--metrics-port PORT]
             [--traffic-rate N] [--run-seconds N]
             [--crash-window W] [--crash-proposer Q]
             [--program ADDRESS=PATH]... [--genesis FILE] [--store DIR]
OptionDefaultMeaning
--gateway-port4930JSON-RPC port
--ws-port4931event stream port
--base-port4950first of twelve QUIC ports
--metrics-port4989metrics and health port
--traffic-rate50generated transfers per second
--run-secondsnonestop after N seconds
--crash-windownonewindow with a silent proposer
--crash-proposer3that proposer, 1 to 3
--programnonean SBF program to load, repeatable
--genesis../chain/genesis/acrux-net.jsongenesis accounts and programs: the demo pool, its mints and the faucet
--storetarget/runs/netrun directory

Each option, its environment variable and the execution settings read from the environment are on Configuration.

Runs until Ctrl+C or the end of --run-seconds. Run a local cluster

Prints on stop one JSON line: report, the path of last-run.json; finalizedCblocks; skips; slotPacingUs with count, p50, p99 and max. Stop and the report

Exits non-zero when a setting is out of range: a zero ACRUX_BCU, ACRUX_RESERVE or ACRUX_FRAGMENT_EXPIRY, a --crash-proposer outside 1 to 3, a malformed .env line, or a port already in use.

acrux cluster up

Terminal
acrux cluster up --hubs FRA,NYC,TYO
OptionDefaultMeaning
--hubsFRA,NYC,TYOthe cluster's hubs, which are the genesis hubs FRA, NYC and TYO
--gateway-port4930JSON-RPC port
--ws-port4931event stream port
--base-port4950first of twelve QUIC ports
--metrics-port4989metrics and health port
--storetarget/runs/clusterrun directory

The net of acrux net up with its defaults and the genesis at ../chain/genesis/acrux-net.json.

acrux keygen

Terminal
acrux keygen --out key.json
OptionDefaultMeaning
--outacrux-key.jsonwhere to write the keypair, as a Solana keypair file

Prints the new key's address.

acrux send

Terminal
acrux send --keypair key.json --to <address> --lamports 1000000 --n 3 --t 2
OptionDefaultMeaning
--keypairrequiredthe fee payer and sender
--torequiredthe receiving address
--lamportsrequiredthe amount
--n1proposers that receive it, 1 to 3
--t1of those, how many must include it before it is readable
--priority1000priority fee, micro-lamports per compute unit
--rpchttp://127.0.0.1:4930the gateway's JSON-RPC

Builds a transfer with a 20,000 CU limit over the net's latest blockhash, for the slot four after the latest started one, and sends it to proposers 1 to n: in the clear with t of 1, as sealed fragments otherwise (Threshold sends).

Prints sent <id> for slot <slot>, with , <t> of <n> fragments for a threshold send, then each state as the transaction reaches it, until finalized, failed or expired.

acrux node follow

Terminal
acrux node follow http://127.0.0.1:4930
Argument or optionDefaultMeaning
URLrequiredthe gateway's JSON-RPC
--genesis../chain/genesis/acrux-net.jsonthe net's genesis, for its programs

Starts from the latest finalized cblock's state. For every finalized slot it checks the attestations and the agreed set, decrypts the agreed blocks, checks each against its commitment, re-executes them on its own SVM and compares the state hash with the net's. Prints from cblock <n>: <a> accounts loaded, state <hash> matches, then slot <n> re-executed agreed <P> state <hash> matches checked <count> per slot; stops with the slot and reason on a failed check. Follow a net

acrux hub

Terminal
acrux hub register <CODE> --latitude <deg> --longitude <deg> --identity key.json
acrux hub join <CODE> --identity key.json
acrux hub leave <CODE> --identity key.json
acrux hub move <FROM> <TO> --identity key.json
acrux hub release <CODE> --identity key.json
SubcommandSends
register CODE --latitude --longituderegister_hub, the location as WGS84 ECEF at sea level
join CODEjoin_hub, the identity as payer too
leave CODEleave_hub
move FROM TOmove_hub
release CODErelease_hub, with the registrant read from the hub account
OptionDefaultMeaning
--identityacrux-key.jsonthe validator identity, or registrant, that signs and pays
--rpchttp://127.0.0.1:4990the Solana JSON-RPC
--programABjgHL8TcjxUjx6vfwsVQyvxiXR6pFgMkeESgwK6CbDmthe Hub Registry program id

Prints <instruction> confirmed: <signature> once the transaction is confirmed, waiting up to 30 s. Join a hub

acrux schedule

Terminal
acrux schedule < hubs.json

Reads { epoch, seed, windows, totalStake, hubs } as JSON on stdin and runs Algorithm 3, the code path the node's own schedule runs (Proposer schedule). Prints { hubStakes, schedule }: each hub with at least three members and its capped proposer stake, and the drawn windows.

acrux lab run

Terminal
acrux lab run --scenario last-look --seed demo --out runs/last-look
OptionDefaultMeaning
--scenariorequiredlast-look, censorship, crash, equivocation, split-commitments or private-front-run
--seedrequiredthe run's seed; the same seed gives the same schedule
--outrequiredthe run's directory
--base-port5016first of the twelve sandbox QUIC ports
--genesis../chain/genesis/acrux-net.jsongenesis accounts and programs

Runs a twelve-validator sandbox for 12 seconds with the scenario's fault in its fifth window, and writes events.jsonl, the run's events in the event stream's envelope, and outcome.json into --out. Fault Lab