Repository navigation
Rewrite the Wallet SDK documentation - #10
Merged
Merged
Conversation
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.
Replaces the Wallet SDK section with conceptual docs that cover the whole public API of
chia-wallet-sdk. That means every crate in the workspace, plus the bindings. Every page has Rust examples that were compiled and run (see Verification).New structure
/sdk)/sdk/action-system)/sdk/primitives)chip-0035), Action Layer (action-layer), Partial Offers (chip-0052), Auctions (auction), Splitter (chip-0008), NFT Fusion (chip-0021), Secure the Bagchia-sdk-client), RPC Clients (chia-sdk-coinset), Daemon (chia-sdk-daemon)/sdk/testing)Redirects
These URLs still exist:
/sdk,/sdk/primitives/{standard,cat,nft},/sdk/offers,/sdk/testing,/sdk/patternsand/sdk/troubleshooting. The pages that moved or were removed redirect through@docusaurus/plugin-client-redirects, the same way the Sage move did:/sdk/spend-context→/sdk/concepts/spend-context/sdk/actions→/sdk/action-system/sdk/connectivity→/sdk/networking/peer/sdk/primitives/other→/sdk/primitivesVerification
pnpm check:sdk-examples(scripts/check-sdk-examples.py) extracts every```rustblock into thesdk-examplescrate, with each block as its own module, and runscargo test. Most examples are#[test]s that run against theSimulator. The networking examples are compiledasync fns, or tests against the peer simulator.--sdk <path>runs the examples against a local SDK checkout.ad7630cb, the SDK commit pinned asrevinsdk-examples/Cargo.toml, with every feature flag enabled.Did::parse_childtrusts the hint, so the DID pages check the parsed puzzle hash against the coin themselves.```rust ignoreand skipped. Everything else is checked..pyistubs.pnpm buildpasses with no broken links or anchors, andprettier --checkpasses.Maintenance
revinsdk-examples/Cargo.tomlrecords which SDK commit the docs are written against./update-sdk-docs <tag>(.claude/skills/update-sdk-docs/SKILL.md) is a Claude Code skill for updating the docs to a new release. It diffs the SDK from thatrev, updates the affected pages, bumps therev, runs the example check, a separate prose review and the build, then opens a PR.Notes for review
main(ad7630cb), and treat everything there as released. That includes the four new feature flags, partial offers, auctions, the splitter, NFT fusion, Secure the Bag, vault signed messages, per-NFT royalty trade prices, and the newer clear signing rules. The pages don't mention versions, and they don't label anything as unreleased.Peerrequests have no timeout.SimulatorConfig::timestamp_modeis never read.CatalogRegistryConstants::getistodo!().Nft::spend_withadds the coin spend before it returnsMissingChild.