docs: sync with current server, refactor, and trace format#48
Merged
Conversation
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)
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.
Audits the documentation against the running node and the current code, fixing drift that accumulated since the dependency-inversion /
ChainStorerefactor and the trace-format change.How this was verified
Started
komet-nodeon 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 thetraceTransactionoutput matches byte-for-byte. Also confirmed the live response shapes ofgetHealth,getNetwork,getVersionInfo,getLatestLedger,getFeeStats,getTransaction,getTransactions,getLedgers,getLedgerEntries,simulateTransaction, and theDUPLICATE/NOT_FOUND/null-trace paths against server.md.Changes
make build-kdist→make kdist-build(the former target does not exist).handle_rpcexamples rewritten for the injectedinterpreter/encoder/store; the removedStellarRpcServer(io_dir=…, network_passphrase=…)constructor replaced withbuild_server(…);memfield added to the trace example;captiveCoreVersion→komet 0.1.86; created-directories list completed.simulateTransaction,getEvents); receipt shape gainsapplicationOrder/feeBump; newChainStorecomponent + injected-collaborators note; init directory list completed.build_tx_requestnow documented as a 3-tuple withuploaded_wasms;build_simulate_requestdocumented.run()'scommitkeyword andcommit=Falsedry runs documented.memfield added to the trace example and field table.scval_from_jsonnow decodesvec/map).Note
captiveCoreVersionis generated at runtime from the installedkometversion.pyproject.tomlpinsv0.1.86, so the docs use that; the local.venvcurrently has0.1.84and would needuv syncto match.