Enrich rustdoc across public API surface#50
Open
alltheseas wants to merge 5 commits intolightningdevkit:masterfrom
Open
Enrich rustdoc across public API surface#50alltheseas wants to merge 5 commits intolightningdevkit:masterfrom
alltheseas wants to merge 5 commits intolightningdevkit:masterfrom
Conversation
Add detailed documentation with cross-references, tables, and context to Balances, Seed, StorageConfig, ChainSource, WalletConfig, Tunables, PaymentInfo, PaymentInfoBuildError, InitFailure, WalletError, SingleUseReceiveUri, and all Wallet impl methods. Accurately documents close_channels force-close behavior for non-usable channels, list_transactions exclusion of pending inbound invoices and pending rebalances, and from_trusted semantics for amountless receives. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add event type summary table, persistence semantics, usage guidance, and cross-references to Wallet methods on Event and EventQueue docs. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace generic descriptions with precise documentation covering lifecycle semantics, cross-references to Wallet methods, and string format details for PaymentId. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add module-level docs explaining the graduated custody model and available backends. Enrich TrustedWalletInterface, ExtraConfig, TrustedError, SparkWalletConfig, and CashuConfig with detailed docs, examples, and feature flag guidance. Uses plain backtick references for cfg-gated items (cashu, dummy, ExtraConfig::Cashu, ExtraConfig::Dummy) to avoid broken intra-doc links under default features. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add comprehensive crate-level documentation to graduated-rebalancer explaining the two rebalance paths, trait-based architecture, and relationship to orange-sdk. Add Cashu backend documentation and code examples to the README, which was previously undocumented despite being a first-class feature. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Collaborator
Author
|
gents @benthecarman @danieldaquino docs update ready for your review. |
benthecarman
requested changes
Mar 6, 2026
Collaborator
benthecarman
left a comment
benthecarman
left a comment
There was a problem hiding this comment.
couple nits otherwise looks good
| Spark uses the [Breez Spark SDK](https://breez.technology) for custodial Lightning payments with instant settlement and low fees. This is the default backend and is enabled via the `spark` feature flag. | ||
|
|
||
| ```rust,no_run | ||
| use orange_sdk::trusted_wallet::spark::SparkWalletConfig; |
Collaborator
There was a problem hiding this comment.
nit: this can be use orange_sdk::SparkWalletConfig
| ``` | ||
|
|
||
| ```rust,ignore | ||
| use orange_sdk::trusted_wallet::cashu::CashuConfig; |
Collaborator
There was a problem hiding this comment.
nit: this can be use orange_sdk::CashuConfig
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
2 participants
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.
Summary
orange-sdk,graduated-rebalancer, and the READMEWallet,Balances,Tunables,WalletConfig,Event,Transaction,PaymentId,ExtraConfig,SparkWalletConfig,CashuConfig, and moregraduated-rebalancerexplaining the two rebalance pathsclose_channelsforce-close behavior,list_transactionsexclusions,from_trustedamountless semanticscargo doc --all-features --no-depsandcargo doc -p orange-sdk --no-depsboth pass with zero warnings, including underRUSTDOCFLAGS='-D warnings'Test plan
cargo doc --all-features --no-deps— zero warningscargo doc -p orange-sdk --no-deps(default features) — zero warningsRUSTDOCFLAGS='-D warnings' cargo doc -p orange-sdk --no-deps— passesRUSTDOCFLAGS='-D warnings' cargo doc --all-features --no-deps— passescargo check --all-features— passes🤖 Generated with Claude Code