Skip to content

docs(sdk): document the transaction module's behavior in rustdoc - #197

Open
schoen wants to merge 46 commits into
BlockstreamResearch:devfrom
schoen:docs/rustdoc-transaction
Open

schoen wants to merge 46 commits into
BlockstreamResearch:devfrom
schoen:docs/rustdoc-transaction

Conversation

@schoen

@schoen schoen commented Oct 29, 2026

Copy link
Copy Markdown
Contributor

Describe what each part of FinalTransaction does rather than restating signatures: input and output order, what the signer adds, how the transaction-wide sequence and locktime reach each input, how the default sequence enforces a locktime, the change target's blinding rule, and what is_balanced, calculate_fee_delta and extract_pst count and return.

Also document the witness path syntax of ProgramSignature::at_path and its errors, the issuance and reissuance entropy arguments, derivation path form, and the receipt's wait behavior, and add a module overview.

  • This PR suggests a bug fix and I've added the necessary tests.
  • This PR introduces a new feature and I've discussed the update in an Issue or with the team.
  • This PR is just a minor change like a typo fix.

Arvolear and others added 16 commits October 21, 2026 18:55
* add errors instead of panic
* add additional tests to catch this behaviour
fix:
* hash collisions on deps installation
* overlapping cloning behaviour (tag and branch)
* dependency escaping issue
Describe what each part of `FinalTransaction` does rather than restating
signatures: input and output order, what the signer adds, how the
transaction-wide sequence and locktime reach each input, how the
default sequence enforces a locktime, the change target's blinding
rule, and what `is_balanced`, `calculate_fee_delta` and `extract_pst`
count and return.

Also document the witness path syntax of `ProgramSignature::at_path`
and its errors, the issuance and reissuance entropy arguments, derivation
path form, and the receipt's wait behavior, and add a module overview.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@schoen
schoen requested a review from Arvolear as a code owner October 29, 2026 00:11
@Arvolear
Arvolear deleted the branch BlockstreamResearch:dev October 30, 2026 16:28
@Arvolear Arvolear closed this Oct 30, 2026
@Arvolear Arvolear reopened this Oct 30, 2026
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.

3 participants