Repository navigation
docs: describe the ledger node, client and API - #267
Merged
Merged
Conversation
rvolosatovs
force-pushed
the
roman/ledger/docs
branch
from
October 20, 2026 14:10
9effa4d to
aaa9b7e
Compare
rvolosatovs
changed the title
Closed
rvolosatovs
force-pushed
the
roman/ledger/docs
branch
from
October 20, 2026 17:32
aaa9b7e to
a6b077f
Compare
Add a usage-focused page for the development ledger: a quick start that runs a node with a genesis output of the `require_hash_preimage` example and spends it with a wrong and then the right preimage; node flags and the genesis file; the client commands; the digest, account, nonce, UTXO and block model; and a reference of `POST`/`GET /rpc`, the contract and transaction endpoints, and the COSE envelope format. State up front that only genesis outputs need authorization and proofs are not checked, so this is not a secure ledger. Point `docs/cli.md` at the new page for `starstream node` and `starstream ledger`. Assisted-by: anthropic:claude-opus-5-5 Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>
rvolosatovs
force-pushed
the
roman/ledger/docs
branch
from
October 21, 2026 17:39
a6b077f to
ff6140f
Compare
rvolosatovs
marked this pull request as ready for review
October 21, 2026 17:40
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add
docs/ledger.md, a usage-focused page for the development ledger:require_hash_preimageexample, runs anode with a genesis output created by
create-hash 42, and spends it withconsume-hash, first with a wrong preimage (traps, nothing submitted) andthen with the right one;
starstream nodeflags and the genesis TOML format;starstream ledgerclient commands, including theaccount,admin,block getandnetworkqueries from ledger: query accounts, admin, network and blocks #271;POST /rpc(COSE envelopes and wRPC queries againstledger.wit, plus UTXO method calls),GET /rpc(ledger and per-UTXO WIT,from ledger: serve RPC WIT on
/rpc#262),GET /contracts/<digest>,GET /transactions/<digest>, theenvelope format and the error status codes.
A warning near the top says this is not a secure ledger: only genesis outputs
need authorization, proofs are not checked, and state lives in memory.
docs/cli.mdnow has a shortstarstream node/starstream ledgersectionthat links to the new page.