NETSoon

Docs Run a node

Configuration

Every acrux-node setting, its flag, its environment variable and its default, and how the node reads .env.

acrux net up reads its settings from flags, from the environment, and from a .env file in its working directory. A flag wins over the environment; the environment wins over .env; a setting given nowhere takes its default.

Ports and run

FlagEnvironmentDefaultMeaning
--gateway-portACRUX_GATEWAY_PORT4930the JSON-RPC port, on 127.0.0.1
--ws-portACRUX_WS_PORT4931the event stream port, on 127.0.0.1
--base-portACRUX_BASE_PORT4950the first of the twelve node-to-node QUIC ports, base to base + 11
--metrics-portACRUX_METRICS_PORT4989metrics and health, on 127.0.0.1
--traffic-rateACRUX_TRAFFIC_RATE50generated transfers per second; 0 for none
--run-secondsruns until stoppedstop after this many seconds and write the report
--crash-windownonethe window in which one proposer is silent from its start
--crash-proposer3that window's silent proposer, 1, 2 or 3
--program ADDRESS=PATHnoneload an SBF program at ADDRESS before the first slot; repeatable
--genesis../chain/genesis/acrux-net.jsongenesis accounts and programs loaded before the first slot: the demo pool, its mints and the faucet
--storetarget/runs/netthe run's directory, relative to the working directory (The store)

Execution and fees

Read from the environment or .env only. Each must be a positive integer where marked.

EnvironmentDefaultMeaning
ACRUX_BCU2000000 CUcompute units per track per slot, bcu; positive
ACRUX_BASE_FEE5000 lamportslamports per signature; half burned
ACRUX_INCLUSION_FEE1000 lamportslamports per included copy or fragment, to the including proposer
ACRUX_RESERVE1,000,000the fee-payer reserve ρ in lamports, 0.001 SOL SOL; positive
ACRUX_FRAGMENT_EXPIRY8 slotsslots after the first included fragment before an incomplete threshold transaction expires; positive
ACRUX_RETAIN_SLOTS24,000slots of history the store keeps, 20 minutes; older slot and transaction records are deleted

How the fees are charged and split is on Fees and the reserve.

Logs

EnvironmentDefaultMeaning
RUST_LOGwarnthe log filter, in tracing filter syntax: info, acrux_node=debug

The .env file

The node reads .env from its working directory when one is there: one KEY=value per line, blank lines and lines starting with # skipped, no quotes or shell expansion. A variable already set in the process environment is kept.

.env
ACRUX_GATEWAY_PORT=4930
ACRUX_WS_PORT=4931
ACRUX_BCU=2000000
ACRUX_INCLUSION_FEE=1000
ACRUX_BASE_FEE=5000
ACRUX_RESERVE=1000000
ACRUX_FRAGMENT_EXPIRY=8
ACRUX_TRAFFIC_RATE=50

Fixed by the protocol

The protocol's own parameters are compiled in: k, κ, w, δlocal, δblock, δglobal, Δtimeout, m, α, and the 64-of-32 shred coding. Their values are on Parameters, and the gateway serves them in getSnapshot's parameters.

Allowed origins

The gateway answers browser requests from http://127.0.0.1:4910, http://localhost:4910, http://127.0.0.1:4911 and http://localhost:4911. A request from another origin is refused with ORIGIN_NOT_ALLOWED; a request with no Origin header, from a script or a server, is served.