Skip to content

docs(sdk): fix wrong rustdoc for finalize_strict and UTXO unblinded g… - #192

Merged
Arvolear merged 1 commit into
BlockstreamResearch:devfrom
schoen:docs/rustdoc-fixes
Nov 5, 2026
Merged

Arvolear merged 1 commit into
BlockstreamResearch:devfrom
schoen:docs/rustdoc-fixes

Conversation

@schoen

@schoen schoen commented Oct 29, 2026

Copy link
Copy Markdown
Contributor

…etters

Signer::finalize_strict was described as working against a "confirmation window (in blocks)", but its fee_rate argument is a fee rate in sats/kvb. Describe what it does and list its errors.

UTXO::unblinded_amount was documented to panic "if the UTXO is not confidential". Both unblinded getters panic when secrets is None.

  • 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.

@schoen
schoen requested a review from Arvolear as a code owner October 29, 2026 00:09
@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
…etters

`Signer::finalize_strict` was described as working against a
"confirmation window (in blocks)", but its `fee_rate` argument is a fee
rate in sats/kvb. Describe what it does and list its errors.

`UTXO::unblinded_amount` was documented to panic "if the UTXO is not
confidential". Both unblinded getters panic when `secrets` is `None`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@schoen
schoen force-pushed the docs/rustdoc-fixes branch from 6d24a95 to 357f23e Compare November 2, 2026 21:57
@schoen

schoen commented Nov 2, 2026

Copy link
Copy Markdown
Contributor Author

I don't understand why this CI test failed (with an upstream 403 for simplexup)?

@schoen schoen closed this Nov 2, 2026
@schoen schoen reopened this Nov 2, 2026
@schoen

schoen commented Nov 2, 2026

Copy link
Copy Markdown
Contributor Author

Let's see if the CI passes on reopen.

@Arvolear Arvolear left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@Arvolear
Arvolear merged commit 00f3ab9 into BlockstreamResearch:dev Nov 5, 2026
13 of 18 checks passed
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.

2 participants