Fee bumping Package #114
Merged
Fee bumping Package #114
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
Create a new package for fee bumping functionality in Caravan. This package provides modular and reusable utilities for implementing RBF (Replace-By-Fee) and CPFP (Child-Pays-For-Parent) fee bumping strategies. Key additions: - Basic package structure and configuration files - Core modules for RBF and CPFP implementations - Fee estimation utilities - Type definitions for fee bumping operations - Constants and utility functions This package aims to enhance Caravan's transaction management capabilities by providing a flexible and extensible fee bumping solution that can be easily integrated into the Caravan coordinator wallet and other Bitcoin projects.
This commit introduces a new @caravan/fee-bumping package that provides robust functionality for handling Replace-By-Fee (RBF) and Child-Pays-For-Parent (CPFP) fee bumping strategies in Bitcoin transactions. The package is designed to work seamlessly with other Caravan packages and offers a flexible, modular approach to fee bumping. Key features: - Implement RBFHandler for Replace-By-Fee transactions - Implement CPFPHandler for Child-Pays-For-Parent transactions - Create FeeEstimator for dynamic fee rate calculations - Provide utility functions for transaction analysis and manipulation - Define comprehensive types for improved type safety and developer experience - Implement constants for fee-related thresholds and limits The package structure includes: - src/index.ts: Main entry point and FeeBumping class - src/types.ts: TypeScript interfaces and types - src/estimator.ts: FeeEstimator class for fee calculations - src/rbf.ts: RBFHandler class for RBF operations - src/cpfp.ts: CPFPHandler class for CPFP operations - src/utils.ts: Utility functions for transaction handling - src/constants.ts: Constant values used throughout the package This package provides a solid foundation for implementing fee bumping strategies in Caravan-based applications. It offers: 1. Flexible fee estimation based on network conditions 2. Configurable options for both RBF and CPFP operations 3. Built-in safeguards against excessive fees 4. Utility functions for transaction analysis and modification The implementation is designed with extensibility in mind, allowing for easy updates and additions to fee bumping strategies in the future. Next steps: - Implement comprehensive unit tests for all components - Integrate the package with the main Caravan UI - Create documentation and usage examples - Perform thorough testing with various transaction scenarios This addition significantly enhances Caravan's capabilities in handling dynamic fee environments, improving overall user experience and transaction reliability.
- Add new types for UTXO, TransactionOutput, TransactionAnalysis, FeeRate, FeeEstimate, TransactionDetails, BlockchainClientInterface, RBFOptions, and CPFPOptions in types.ts - Create getFeeEstimates function to fetch fee estimates from blockchain client - Implement calculateFee function to compute transaction fee based on vsize and fee rate - Use BigNumber for precise calculations - Import necessary constants and interfaces This commit lays the groundwork for RBF and CPFP implementations by defining essential types and providing core fee estimation functionality.
- Create new file analyzer.ts with analyzeTransaction function - Implement logic to determine if a transaction can use RBF or CPFP - Calculate current fee rate of the transaction - Provide a recommended fee bumping method based on transaction properties - Utilize utility functions isRBFSignaled and calculateEffectiveFeeRate - Return a TransactionAnalysis object with fee bumping options This commit adds crucial functionality for analyzing transactions to determine the best fee bumping strategy, supporting the implementation of RBF and CPFP features in the Caravan wallet.
This commit significantly refactors the fee bumping package to improve its functionality, integration with bitcoinjs-lib, and overall code structure. Key changes include: RBF (Replace-By-Fee): - Updated to work with bitcoinjs-lib Transaction objects - Implemented dynamic input and output handling - Added support for transaction cancellation and fee subtraction from outputs CPFP (Child-Pays-For-Parent): - Refactored to handle multiple parent outputs - Implemented dynamic input and output calculation - Added support for additional outputs in child transactions - Improved fee calculation accuracy Utils: - Added deriveAddress function for working with bitcoinjs-lib Output objects - Updated isRBFSignaled and calculateEffectiveFeeRate functions - Removed estimateVirtualSize in favor of using Transaction.virtualSize() Transaction Analysis: - Implemented analyzeTransaction function for recommending fee bumping strategies - Added logic to compare current fee rate with network fee rate Removed: - Eliminated estimator.ts file, integrating necessary functionality into other modules Tests: - Added comprehensive test suite for analyzeTransaction function - Updated existing tests to reflect new implementations of RBF and CPFP functions Types: - Updated and expanded type definitions to better integrate with bitcoinjs-lib - Added new interfaces for RBFOptions, CPFPOptions, and TransactionAnalysis
🦋 Changeset detectedLatest commit: 8f2335b The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
bucko13
requested changes
Jul 25, 2024
There was a problem hiding this comment.
Really good stuff here so far! Only reviewed cpfp so far, but wanted to submit some comments to start.
High level feedback is that I would be curious to see if you think you could reduce the dependence on a consumer of this package from having to use other external dependencies as much as possible. Right now someone that wants to interact and leverage this package outside of this monorepo MUST have some awareness of the use of bitcoinjs-lib and bignumber library and use the same libraries themselves. Ideally any use of bignumbers is contained to within the functions themselves. This means that any consumer of the function can use whatever BN library they prefer and just convert to/from strings when interacting with the function.
Same with Transaction from bitcoinjs-lib. It would be nice if someone that wanted to estimate fees or construct a CPFP didn't have to first build a bitcoinjs-lib Transaction object (and what happens if they're using a different/incompatible version??)
bucko13
reviewed
Jul 26, 2024
…gnalling functionality to PSBTV2
Key changes:
1. rbf.ts:
- Introduced RbfTransaction class to encapsulate RBF logic
- Implemented methods for preparing accelerated and canceled transactions
- Added helper methods for fee calculations and PSBT manipulations
- Created public functions prepareRbfTransaction and prepareCancelTransaction
as entry points for RBF operations
2. psbtv2.ts:
- Added isRbfSignaled method to check if a transaction is RBF-enabled
Shadouts
requested changes
Jul 29, 2024
There was a problem hiding this comment.
I've only reviewed the PsbtV2 class changes. I like the addition of another value setter and getter. There are so many of these unbuilt which could make this package really powerful. However, I take issue with the bip125-specific changes. See line comments.
Additionally, adding a test for setInputSequence would be good.
bucko13
reviewed
Jul 30, 2024
bucko13
reviewed
Aug 1, 2024
This commit introduces new classes for Child-Pays-for-Parent (CPFP) and refactors majority of Replace-By-Fee (RBF) transaction creation, along with comprehensive tests. Key changes: - Add CPFPTransaction class for creating child transactions - Refactored RbfTransaction class for preparing replacement transactions - Create tests for CPFP, RBF - Update existing transaction utilities to support new classes The new classes support both PSBTv2 and PSBTv0 formats, handle various edge cases, and provide methods for fee calculation and transaction preparation.
bucko13
requested changes
Aug 2, 2024
bucko13
requested changes
Aug 9, 2024
…e calculation - Add state management to track acceleration and cancellation status - Implement caching for fee increase and vsize calculations - Introduce incremental relay fee for accurate fee bump calculations - Refactor fee calculation logic to comply with BIP 125 rules - Optimize input selection by sorting UTXOs before addition - Improve RBF signaling by updating only one input sequence - Added more comments for better code understanding
…(Replace-By-Fee) support - setInputSequence(inputIndex: number, sequence: number): A method for setting the sequence number of a specific input, critical for signaling RBF and handling nLockTime. - get isRBFSignaled(): boolean: A method to check if the transaction signals RBF, as per BIP125 guidelines. - Added tests
bucko13
requested changes
Oct 18, 2024
bucko13
reviewed
Oct 21, 2024
bucko13
reviewed
Oct 21, 2024
bucko13
reviewed
Oct 22, 2024
bucko13
reviewed
Oct 22, 2024
bucko13
reviewed
Oct 22, 2024
bucko13
reviewed
Oct 22, 2024
bucko13
reviewed
Oct 22, 2024
bucko13
approved these changes
Oct 23, 2024
Merged
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.
Fee Bumping Package
Overview
Comprehensive refactor of the fee bumping package to enhance functionality, improve bitcoinjs-lib integration, and streamline code structure.
Key Improvements
Changes
Notes
Significant changes to fee bumping logic. Careful review needed, especially for transaction analysis and RBF/CPFP implementations.