Get started

Quickstart

Build the programs, run the test suites, and start a local Neuron rollup node you can point Solana tools at. All commands run from the repository root.

Prerequisites

ToolVersionNotes
Solana CLI (Agave)3.0.xIncludes cargo-build-sbf and solana-test-validator
Anchor CLI0.32.1Programs use anchor-lang 0.32
Rustvia rustupThe repo pins the host toolchain in rust-toolchain.toml
Node.js24For the SDK, plugin and tests
Python 3anyOnly to preview the website

Build and test the programs

npm install
anchor build        # programs, IDLs and TypeScript types
anchor test         # local validator: programs, SDK and plugin tests

anchor test starts a validator, loads the three programs as upgradeable (the provider wallet is their upgrade authority, like a real deploy), refreshes the IDLs in sdk/idl, builds the agent plugin and runs every suite.

Why the Rust 1.84 pin? Solana's SBF compiler ships Cargo 1.84, which can't build edition-2024 crates, so the program crates declare rust-version = "1.84" and the lockfile is resolved for it. If you refresh it, run CARGO_RESOLVER_INCOMPATIBLE_RUST_VERSIONS=fallback cargo update, then cargo update -p blake3 --precise 1.8.2.

Test the rollup

npm run rollup:build-programs   # the sol_infer demo program
npm run rollup:test             # sequencer and node: blocks, sol_infer, RPC, replay, security
npm run rollup:smoke            # real @solana/web3.js, spl-token and Anchor against a live node

The rollup test suite includes neuron_allowance running unchanged on the rollup, the bytecode-vs-sol_infer cost comparison (run with -- --nocapture to see it) and a regression test for every security finding.

Run a local rollup node

npm run rollup:node

This starts neuron-node with rollup/node/dev.toml: JSON-RPC on http://127.0.0.1:8999, the WebSocket on port 9000, and blocks every 400 ms when there's work. The faucet and genesis funds come from your Solana CLI wallet. The dev config ships with SPL Token and the ATA program at genesis; uncomment neuron_allowance in it after anchor build.

Solana tools work against it unchanged:

solana -u http://127.0.0.1:8999 cluster-version
solana -u http://127.0.0.1:8999 airdrop 1
solana -u http://127.0.0.1:8999 transfer <address> 0.1 --allow-unfunded-recipient
import { Connection } from "@solana/web3.js";
const connection = new Connection("http://127.0.0.1:8999", "confirmed");
console.log(await connection.getSlot());

To check a chain's history at any time, re-execute it from genesis: neuron-node replay --data-dir rollup/target/dev-chain. See Rollup & sol_infer for configuration, settlement and limits.

Preview the website

npm run site        # http://localhost:4173 (docs at /docs/)

After changing a program, regenerate the programs reference with npm run sync-idl && npm run docs:reference.