Command reference

Docs

Every command copies with one click. Fill the angle-bracket placeholders with your own values, then paste into a terminal. Everything targets the public RPC at rpc.sumchain.io — point --rpc-url at a local mirror to run against your own chain.

v0.4.0-rc4release candidaterpc.sumchain.io9 commands

Placeholders

Angle-bracket tokens are yours to fill in before running. Nothing in a command is optional unless a caption says so.

<seed>: Path to a hex-encoded Ed25519 key file (your SUM Chain wallet).
<path>: Local file path to upload, or output path to download into.
<merkle_root>: 64-hex file identity returned by ingest-v2.

Install

Linux x86_64

Prebuilt binaries are published for Linux x86_64. The installer pins a version explicitly; there is no implicit latest.

$ curl -fsSL https://github.com/SUM-INNOVATION/Storage-Node-Interface-Protocol/releases/download/v0.4.0-rc4/install.sh | sh -s -- --version v0.4.0-rc4

Verifies the SHA256 and installs sum-node + e2e-helper into $HOME/.local/bin. Add --prefix /usr/local under your own sudo for a system-wide install.

Build from source

Rust 1.85+

For any target without a prebuilt tarball. Requires the Rust stable toolchain (edition 2024, MSRV 1.85).

$ git clone https://github.com/SUM-INNOVATION/Storage-Node-Interface-Protocol.git
$ cd Storage-Node-Interface-Protocol
$ git checkout v0.4.0-rc4
$ make release-check

Runs fmt, lint, tests, and the release build. Binaries land at target/release/sum-node and target/release/e2e-helper.

Use as a client

--client

File user. No registration, no stake, no daemon: push or pull, then exit.

$ sum-node --client --key-file <seed> --rpc-url https://rpc.sumchain.io ingest-v2 <path> --visibility public

Chunk locally, push to the 3 V2-assigned archives, finalize on chain, clean up local chunks, and exit. Use --visibility private to encrypt first.

$ sum-node --client --key-file <seed> --rpc-url https://rpc.sumchain.io download <merkle_root> --output <path>

Fetch the manifest, download chunks in parallel, verify every CID and the Merkle root, reassemble the file, and exit.

Run an archive node

listen

Long-running operator. Registers on-chain with a 1 Koppa stake, then serves chunks and answers PoR challenges.

$ sum-node --key-file <seed> --rpc-url https://rpc.sumchain.io register-encryption-key

One-time registration of the archive's X25519 encryption pubkey. Required to receive Private V2 shares; recommended for all operators. One tx, no stake.

$ sum-node --key-file <seed> --rpc-url https://rpc.sumchain.io register-node --stake 1000000000

One-time on-chain registration as an ArchiveNode with the 1 Koppa stake commitment (1,000,000,000 base units). Waits for finality.

$ sum-node --key-file <seed> --rpc-url https://rpc.sumchain.io --profile production listen

Serve chunks, enforce ACLs, respond to PoR challenges, and run MarketSync + GC. The production profile fails closed on RPC errors.

Manage a pending upload

Pending

If an ingest fails after on-chain registration, the file is left Pending. Finish it or withdraw.

$ sum-node --key-file <seed> --rpc-url https://rpc.sumchain.io resume <merkle_root> <path>

Re-chunk the path, assert its root matches, and run only the residual work (missing pushes, then activation). No-op if the file is already Active.

$ sum-node --key-file <seed> --rpc-url https://rpc.sumchain.io abandon <merkle_root>

Submit AbandonFileV2. Pre-checks the lifecycle and grace window before spending a fee. On success the file is permanently Abandoned and 90% of the deposit refunds.

Back to protocol Full README ↗