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
| Flag | Environment | Default | Meaning |
|---|---|---|---|
--gateway-port | ACRUX_GATEWAY_PORT | 4930 | the JSON-RPC port, on 127.0.0.1 |
--ws-port | ACRUX_WS_PORT | 4931 | the event stream port, on 127.0.0.1 |
--base-port | ACRUX_BASE_PORT | 4950 | the first of the twelve node-to-node QUIC ports, base to base + 11 |
--metrics-port | ACRUX_METRICS_PORT | 4989 | metrics and health, on 127.0.0.1 |
--traffic-rate | ACRUX_TRAFFIC_RATE | 50 | generated transfers per second; 0 for none |
--run-seconds | runs until stopped | stop after this many seconds and write the report | |
--crash-window | none | the window in which one proposer is silent from its start | |
--crash-proposer | 3 | that window's silent proposer, 1, 2 or 3 | |
--program ADDRESS=PATH | none | load an SBF program at ADDRESS before the first slot; repeatable | |
--genesis | ../chain/genesis/acrux-net.json | genesis accounts and programs loaded before the first slot: the demo pool, its mints and the faucet | |
--store | target/runs/net | the 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.
| Environment | Default | Meaning |
|---|---|---|
ACRUX_BCU | 2000000 CU | compute units per track per slot, bcu; positive |
ACRUX_BASE_FEE | 5000 lamports | lamports per signature; half burned |
ACRUX_INCLUSION_FEE | 1000 lamports | lamports per included copy or fragment, to the including proposer |
ACRUX_RESERVE | 1,000,000 | the fee-payer reserve ρ in lamports, 0.001 SOL SOL; positive |
ACRUX_FRAGMENT_EXPIRY | 8 slots | slots after the first included fragment before an incomplete threshold transaction expires; positive |
ACRUX_RETAIN_SLOTS | 24,000 | slots 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
| Environment | Default | Meaning |
|---|---|---|
RUST_LOG | warn | the 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.
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=50Fixed 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.