v2.0.0 - Improved usability #26
Merged
Conversation
This file contains 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
…rings instead of expression. And use output to denote Output instances (instead of descriptor). Adapt all the methods for this new signatures, while maintaining backwards compatibility. Rename updatePsbt to updatePsbtAsInput (while maintaining the old signature for backwards compatibility) and add updatePsbtAsInput.
…uts. New approach for finalizers: now uses a returned function when setting an input. Better docs
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.
Summary of Changes in v2.0.0
Major Renaming & Refactoring: Transitioned the main class name from "Descriptor" to "Output". Shifted primary input parameters from "expression" to "descriptor" for better alignment with library principles.
Finalizers & Ledger Improvements: Introduced notable improvements for Ledger Hardware Wallet usage and PSBT finalizers. Notably, deprecated
updatePsbtin favor ofupdatePsbtAsInputto streamline and simplify operations. Consolidated Ledger function parameters into theLedgerManagertype for enhanced usability.Deprecated Functionality: While deprecated functionalities remain in 2.0.0 for backward compatibility, it's recommended to transition to the new functions and classes to avoid potential warnings.
Testing Enhancements: Maintained old test cases (with a
-deprecatedsuffix) and introduced new tests to validate the functionality of the updated API.Documentation Overhaul: Conducted extensive documentation using typedoc and updated the README.md for better clarity and ease of reference.
Bug Fixes: Resolved a critical bug concerning buffer comparisons in
src/descriptors.tsthat ensures accurate descriptor comparisons. For more details, refer to issue-20.