docs: field-level doc-comments for InvoiceExt struct (#700) - #730
Merged
Kingsman-99 merged 1 commit intoAug 30, 2026
Merged
Conversation
|
@gabrielujelistic-collab Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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 field-level doc-comments to
InvoiceExtSummary
Closes #700
InvoiceExt(contracts/split/src/types.rs) is the primary extension storagestruct for an invoice and holds ~40 optional/extension fields, none of which had
doc comments. This PR adds a concise one-line
///doc comment to everyfield of
InvoiceExt, explaining what the field stores and when it is used.This makes the on-chain storage layout self-documenting for contributors
extending invoices (see also the new "Adding Invoice Options" section in
CONTRIBUTING.md).What changed
Added field-level documentation for:
co_signers,required_signatures,signatures,approver,approved,condition_oracle,condition_met,penalty_bps,penalty_deadline,min_funding_bps,release_stages,released_stages,allowed_payers,price_oracle,base_amounts,swap_tokens,tax_bps,tax_authority,insurance_premium_bps,insurance_fund,smart_route,convert_to_stream,accepted_tokens,forward_to,forward_invoice_id,split_rules,auto_resolve_rules,creator_cosigner,velocity_limit,velocity_window,parent_invoice_id,pause_reason,auto_resume_at,payment_cooldown_secs,max_payments_per_window,payment_window_secs,scheduled_release_at,penalty_tiers,allowed_callers,refund_grace_secs.No field names, types, or ordering changed — this is a documentation-only,
non-breaking change.
Verification
Documentation-only; compiles unaffected by doc comments. (As with the other
split PRs,
cargo checkonmaincurrently fails for unrelated, pre-existingreasons — unimplemented helpers/variants from other open issues — so CI red here
is not introduced by this change.)
closes #700