Repository navigation
Conversation
ikripaka
commented
Nov 3, 2026
ikripaka
commented
Collaborator
- 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.
…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>
Add a module overview of `simplex::fuzz`: how a `Scenario` describes the transaction and its programs, what the engine does with each case, and the findings a run can fail with. Document `Expect`'s variants, the engine's public fields and builder methods, what `run` panics on, how witness requirements are violated on purpose, and the undocumented getters of `FuzzCase` and `FuzzProgram`. Correct `mutations()`, which mutates half of the cases that don't violate a requirement, not half of all cases. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Describe what each `ProviderTrait` method returns, including the hex string hashes, the fee estimate keys and units, the fee rate fallback order, and that UTXOs come back without unblinding secrets. Document the Esplora provider's request timeout, its lack of retries, and how long `wait` polls on each network; that `SimplexProvider` mines a block and waits on every broadcast; and which network names `SimplicityNetwork` parses. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Add to `Signer` a description of the wallet model, a table of which methods add wallet inputs, fetch a fee rate, add change and fee outputs, or broadcast, and the rules for fees and change, including when change is dropped or kept. Describe coin selection in `finalize`, what `sign_tx` and `sign_witnesses` return, and the errors each method can return. Correct `WitnessWrappingError::RootTypeMismatch`, which compares the type at the end of the path, not at its root, and describe the other path errors. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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>
Describe how a `Program` compiles and caches, which settings determine its CMR and its address, the shape of its Taproot tree with storage, which getters panic on a compile error, and what `execute` and `finalize` check and return. Correct three doc comments: `ScriptPubkeyMismatch` holds HASH160 script hashes, not CMRs; `Program` reports Bit Machine failures as `Pruning` and never returns `ProgramError::Execution`; and which signer methods print execution output, and when. Also document the verbosity's effect on addresses, the utilities that compute hashes and entropy, and what `DUMMY_SIGNATURE` and `MIN_FEE` are for. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
docs(sdk): fix wrong rustdoc for finalize_strict and UTXO unblinded g…
docs(test): document the scenario-based fuzz engine in rustdoc
docs(sdk): document programs, verbosity and utilities in rustdoc
docs(sdk): document providers and networks in rustdoc
docs(sdk): document the signer's behavior in rustdoc
docs(sdk): document the transaction module's behavior in rustdoc
fix comments and test names
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.