Skip to content

docs: sync with current server, refactor, and trace format#48

Merged
RaoulSchaffranek merged 1 commit into
mainfrom
docs/sync-with-project
Jul 23, 2026
Merged

docs: sync with current server, refactor, and trace format#48
RaoulSchaffranek merged 1 commit into
mainfrom
docs/sync-with-project

Conversation

@RaoulSchaffranek

Copy link
Copy Markdown
Member

Audits the documentation against the running node and the current code, fixing drift that accumulated since the dependency-inversion / ChainStore refactor and the trace-format change.

How this was verified

Started komet-node on a fresh chain and replayed every end-user example. The README quick-start is fully accurate — all four signed envelopes execute in order, the invoke returns the documented hash (c7099cbe…), and the traceTransaction output matches byte-for-byte. Also confirmed the live response shapes of getHealth, getNetwork, getVersionInfo, getLatestLedger, getFeeStats, getTransaction, getTransactions, getLedgers, getLedgerEntries, simulateTransaction, and the DUPLICATE/NOT_FOUND/null-trace paths against server.md.

Changes

  • README: make build-kdistmake kdist-build (the former target does not exist).
  • server.md: class structure, Startup, and handle_rpc examples rewritten for the injected interpreter/encoder/store; the removed StellarRpcServer(io_dir=…, network_passphrase=…) constructor replaced with build_server(…); mem field added to the trace example; captiveCoreVersionkomet 0.1.86; created-directories list completed.
  • architecture.md: "eleven" → "thirteen" RPC methods (adds simulateTransaction, getEvents); receipt shape gains applicationOrder/feeBump; new ChainStore component + injected-collaborators note; init directory list completed.
  • transaction.md: build_tx_request now documented as a 3-tuple with uploaded_wasms; build_simulate_request documented.
  • interpreter.md: run()'s commit keyword and commit=False dry runs documented.
  • node-semantics.md: mem field added to the trace example and field table.
  • notes.md: dropped the stale "ScMap return values are not yet encoded" note (scval_from_json now decodes vec/map).

Note

captiveCoreVersion is generated at runtime from the installed komet version. pyproject.toml pins v0.1.86, so the docs use that; the local .venv currently has 0.1.84 and would need uv sync to match.

Audited the docs against the running node and the current code, fixing
drift that had accumulated since the DI/ChainStore refactor and the trace
format change.

- README: fix `make build-kdist` -> `make kdist-build` (no such target)
- server.md: rewrite class structure, Startup, and handle_rpc examples for
  the injected interpreter/encoder/store; use build_server() instead of the
  removed StellarRpcServer(io_dir=, network_passphrase=) constructor; add
  the mem field to the trace example; bump captiveCoreVersion to komet 0.1.86;
  complete the created-directories list
- architecture.md: eleven -> thirteen RPC methods (add simulateTransaction,
  getEvents); add applicationOrder/feeBump to the receipt shape; add the
  ChainStore component and the injected-collaborators note; complete the
  init directory list
- transaction.md: build_tx_request returns a 3-tuple with uploaded_wasms;
  document build_simulate_request
- interpreter.md: document run()'s commit keyword and commit=False dry runs
- node-semantics.md: add the mem field to the trace example and table
- notes.md: drop the stale "ScMap return values are not yet encoded" note
  (scval_from_json now decodes vec/map)
@RaoulSchaffranek
RaoulSchaffranek merged commit da3a6c9 into main Jul 23, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant