Skip to content

feat: add psbtbumpfee support #632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 5, 2025
Merged

feat: add psbtbumpfee support #632

merged 1 commit into from
Jun 5, 2025

Conversation

nakul1010
Copy link
Contributor

@nakul1010 nakul1010 commented Jun 5, 2025

Reference: https://developer.bitcoin.org/reference/rpc/psbtbumpfee.html

Summary by CodeRabbit

  • New Features
    • Added support for fee bumping and signing/finalizing Partially Signed Bitcoin Transactions (PSBT).
  • Tests
    • Introduced a new test to verify the PSBT fee bumping workflow, including transaction replacement and confirmation checks.

Copy link

vercel bot commented Jun 5, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
bob-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 5, 2025 9:58am

Copy link
Contributor

coderabbitai bot commented Jun 5, 2025

Walkthrough

The changes add PSBT (Partially Signed Bitcoin Transaction) fee bumping and signing/finalization capabilities to the BitcoinClient. New methods and data structures are introduced to support these operations, and an asynchronous test is added to verify the PSBT fee bumping workflow, including transaction replacement and confirmation checks.

Changes

File(s) Change Summary
crates/utils/src/bitcoin_client.rs Added PSBT fee bumping and signing/finalization support: new struct, error variant, and two methods.
crates/utils/src/bitcoin_core.rs Added async test for PSBT fee bumping, signing, broadcasting, and confirmation verification.

Sequence Diagram(s)

sequenceDiagram
    participant Test as test_psbt_bump_fee
    participant AliceClient as BitcoinClient (Alice)
    participant Core as Bitcoin Core RPC

    Test->>AliceClient: psbt_bump_fee(txid, options)
    AliceClient->>Core: psbtbumpfee RPC
    Core-->>AliceClient: PsbtBumpFeeResult (PSBT, origfee, fee, errors)
    AliceClient-->>Test: PsbtBumpFeeResult

    Test->>AliceClient: sign_and_finalize_psbt(psbt, ...)
    AliceClient->>Core: wallet_process_psbt RPC
    Core-->>AliceClient: processed PSBT
    AliceClient->>Core: finalize_psbt RPC
    Core-->>AliceClient: finalized PSBT (with hex)
    AliceClient-->>Test: Transaction

    Test->>Core: sendrawtransaction (broadcast)
    Test->>Core: generate(100) (confirm blocks)
    Test->>Core: gettransaction (for both txs)
Loading

Possibly related PRs

  • bob-collective/bob#571: Adds general fee bumping support to BitcoinClient, related as both PRs extend fee management functionality in the same client.

Suggested reviewers

  • gregdhill

Poem

In the warren where PSBTs hop,
Fee bumps and signatures never stop.
Alice and Bob, with wallets so neat,
Test their transactions, never admit defeat.
With every block mined, confirmations grow—
A rabbit’s delight as the new features flow! 🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
crates/utils/src/bitcoin_client.rs (1)

475-506: Replace debug println! with proper logging.

The method implementation is solid and follows the established pattern, but the debug println! statement should be replaced with proper logging.

Apply this diff to improve logging:

-                    println!("Failed to deserialize into PsbtBumpFeeResult");
+                    error!("Failed to deserialize into PsbtBumpFeeResult: {}", err);
crates/utils/src/bitcoin_core.rs (1)

253-327: Comprehensive integration test for PSBT bump fee workflow.

The test effectively validates the end-to-end PSBT bump fee functionality, including transaction creation, fee bumping, signing, finalization, and confirmation verification.

Consider adding an assertion to verify the PSBT is not None before unwrapping:

+        assert!(psbt_bump_fee.psbt.is_some(), "PSBT should be present in bump fee result");
         let tx = bitcoin_client.sign_and_finalize_psbt(
             &psbt_bump_fee.psbt.unwrap(),
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9db3923 and e901cb6.

📒 Files selected for processing (2)
  • crates/utils/src/bitcoin_client.rs (4 hunks)
  • crates/utils/src/bitcoin_core.rs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test
🔇 Additional comments (4)
crates/utils/src/bitcoin_client.rs (4)

12-12: LGTM! Import is necessary for PSBT functionality.

The json import is correctly added to support json::SigHashType used in the new PSBT signing method.


185-197: Well-designed struct for PSBT bump fee results.

The struct correctly omits the txid field (since PSBTs aren't broadcast yet) and includes all necessary fields matching Bitcoin Core's psbtbumpfee response format.


234-235: Appropriate error variant for PSBT finalization.

The error variant correctly handles the case where finalized PSBT doesn't return raw transaction hex, with a clear and descriptive message.


508-521: Excellent PSBT signing and finalization implementation.

The method correctly implements the two-step process of signing with wallet_process_psbt and finalizing with finalize_psbt. Error handling is robust and the optional parameters provide necessary flexibility.

@nakul1010 nakul1010 requested a review from gregdhill June 5, 2025 10:11
@nakul1010 nakul1010 enabled auto-merge (squash) June 5, 2025 10:11
@nakul1010 nakul1010 merged commit ba89b2a into master Jun 5, 2025
8 checks passed
@nakul1010 nakul1010 deleted the feat/psbtBumpFee branch June 5, 2025 15:54
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