docs(signers): document SignOptions and explain feasibility #379#434
Open
lambaaryan011 wants to merge 1 commit intobitcoindevkit:masterfrom
Open
docs(signers): document SignOptions and explain feasibility #379#434lambaaryan011 wants to merge 1 commit intobitcoindevkit:masterfrom
lambaaryan011 wants to merge 1 commit intobitcoindevkit:masterfrom
Conversation
…ations, and infeasible options - Added 'Security Guard' labels for trust_witness_utxo and allow_all_sighashes - Marked try_finalize and assume_height as DEPRECATED with migration guidance - Documented infeasible options with architectural explanations - All tests passing (381 tests) - Resolves issue bitcoindevkit#379
lambaaryan011
requested review from
ValuedMammal and
oleonardolima
as code owners
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
1 participant
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.
Issue #379: Document SignOptions
This PR adds comprehensive documentation to the
SignOptionsstruct, explaining what each option does and what it's used for.Changes
trust_witness_utxoandallow_all_sighashesare pre-flight validations protecting against attackstry_finalizeandassume_heightas deprecated with migration guidance to usefinalize_psbt()separatelytap_leaves_options,sign_with_tap_internal_key, andallow_grindingwith explanations of architectural limitations due to the genericGetKeyabstractionReferences
Testing
cargo buildsucceedscargo testpasses (381 tests)