wallet: Track no-longer-spendable TXOs separately #27865

pull achow101 wants to merge 28 commits into bitcoin:master from achow101:wallet-unspent-txos changing 18 files +653 −380
  1. achow101 commented at 6:40 pm on June 12, 2023: member

    In #27286, the wallet keeps track of all of its transaction outputs, even if they are already spent or are otherwise unspendable. This TXO set is iterated for balance checking and coin selection preparation, which can still be slow for wallets that have had a lot of activity. This PR aims to improve the performance of such wallets by moving UTXOs that are definitely no longer spendable to a different map in the wallet so that far fewer TXOs need to be iterated for the aforementioned functions.

    Unspendable TXOs (not to be confused with Unspent TXOs) are those which have a spending transaction that has been confirmed, or are no longer valid due to reorgs. TXOs that are spent in unconfirmed transactions remain in the primary TXO set, and are filtered out of balance and coin selection as before.

    Depends on #27286

  2. DrahtBot commented at 6:40 pm on June 12, 2023: contributor

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    Code Coverage & Benchmarks

    For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/27865.

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    Concept ACK remyers, murchandamus, jonatack

    If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

    Conflicts

    Reviewers, this pull request conflicts with the following ones:

    • #32238 (qt, wallet: Convert uint256 to Txid by marcofleon)
    • #32189 (refactor: Txid type safety (parent PR) by marcofleon)
    • #30221 (wallet: Ensure best block matches wallet scan state by achow101)
    • #29415 (Broadcast own transactions only via short-lived Tor or I2P connections by vasild)
    • #29062 (Wallet: (Refactor) GetBalance to calculate used balance by BrandonOdiwuor)
    • #28710 (Remove the legacy wallet and BDB dependency by achow101)
    • #28201 (Silent Payments: sending by josibake)

    If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

    LLM Linter (✨ experimental)

    Possible typos and grammar issues:

    wallt → wallet
    tranasctions → transactions

  3. DrahtBot added the label Wallet on Jun 12, 2023
  4. DrahtBot added the label CI failed on Jun 12, 2023
  5. DrahtBot added the label Needs rebase on Jun 28, 2023
  6. achow101 force-pushed on Jun 28, 2023
  7. DrahtBot removed the label Needs rebase on Jun 28, 2023
  8. achow101 force-pushed on Jun 28, 2023
  9. achow101 force-pushed on Jun 28, 2023
  10. DrahtBot added the label Needs rebase on Sep 6, 2023
  11. achow101 force-pushed on Sep 7, 2023
  12. DrahtBot removed the label Needs rebase on Sep 7, 2023
  13. achow101 commented at 9:32 pm on September 7, 2023: member
    @t-bast You may be interested in this for very large wallets.
  14. t-bast commented at 12:26 pm on September 11, 2023: contributor
    Neat, thanks @achow101, @remyers will give that a try and will review the related PRs!
  15. remyers commented at 7:49 pm on September 12, 2023: contributor

    Concept ACK - on a large synthetic test wallet I’m seeing a 250x speed up.

    I created a large wallet in regtest with many fanout style transactions - 100,000 blocks each creating 1000 utxos. There are only 117 utxos currently, but the wallet.dat file is 370M.

    Using the same wallet.dat file and (transaction history) fundrawtransaction saw a substantial speedup: ~5 seconds using v25.99.0-a36134fcc7b4 ~20 milliseconds using v25.99.0-d9c4dcfe68c5 (latest wallet-unspent-txos)

    I will try to recreate my large test wallet.dat file tomorrow so I can confirm the steps to reproduce it. Is there anything in particular I can do to help? Would you like more testing? code review?

    NB: I had to export my original wallet descriptors and re-import them to work around the issue fixed in #27920. Before the export/import the wallet.dat file was 1.1G, but the speed of fundrawtransaction was 5 sec both in the original file and the tested one created via importing descriptors.

  16. achow101 commented at 8:55 pm on September 12, 2023: member

    Is there anything in particular I can do to help? Would you like more testing? code review?

    The prerequisite PR (#27286) will need review and testing before this can be merged. That should also provide some speed up.

  17. remyers commented at 9:53 am on September 13, 2023: contributor

    The prerequisite PR (#27286) will need review and testing before this can be merged. That should also provide some speed up.

    Will do. I’m getting 400-500ms for the same test using just #27286, so indeed also ~100x speed-up.

  18. DrahtBot added the label Needs rebase on Sep 14, 2023
  19. achow101 force-pushed on Sep 14, 2023
  20. DrahtBot removed the label Needs rebase on Sep 14, 2023
  21. achow101 force-pushed on Sep 15, 2023
  22. achow101 force-pushed on Sep 15, 2023
  23. DrahtBot added the label Needs rebase on Sep 19, 2023
  24. achow101 force-pushed on Sep 27, 2023
  25. DrahtBot removed the label Needs rebase on Sep 27, 2023
  26. DrahtBot added the label Needs rebase on Oct 16, 2023
  27. achow101 force-pushed on Oct 16, 2023
  28. DrahtBot removed the label Needs rebase on Oct 16, 2023
  29. DrahtBot added the label Needs rebase on Oct 23, 2023
  30. achow101 force-pushed on Oct 24, 2023
  31. DrahtBot removed the label Needs rebase on Oct 24, 2023
  32. achow101 force-pushed on Oct 24, 2023
  33. DrahtBot added the label Needs rebase on Oct 29, 2023
  34. achow101 force-pushed on Nov 13, 2023
  35. DrahtBot removed the label Needs rebase on Nov 13, 2023
  36. DrahtBot added the label Needs rebase on Nov 15, 2023
  37. achow101 force-pushed on Nov 15, 2023
  38. DrahtBot removed the label Needs rebase on Nov 15, 2023
  39. DrahtBot added the label Needs rebase on Nov 24, 2023
  40. achow101 force-pushed on Nov 28, 2023
  41. DrahtBot removed the label Needs rebase on Nov 28, 2023
  42. DrahtBot added the label Needs rebase on Dec 8, 2023
  43. achow101 force-pushed on Dec 8, 2023
  44. DrahtBot removed the label Needs rebase on Dec 8, 2023
  45. DrahtBot added the label Needs rebase on Dec 11, 2023
  46. achow101 force-pushed on Dec 11, 2023
  47. DrahtBot removed the label Needs rebase on Dec 11, 2023
  48. DrahtBot added the label Needs rebase on Dec 12, 2023
  49. achow101 force-pushed on Dec 19, 2023
  50. DrahtBot removed the label Needs rebase on Dec 19, 2023
  51. murchandamus commented at 7:47 pm on December 28, 2023: contributor
    Concept ACK
  52. DrahtBot added the label Needs rebase on Feb 3, 2024
  53. achow101 force-pushed on Feb 3, 2024
  54. DrahtBot removed the label Needs rebase on Feb 3, 2024
  55. DrahtBot added the label Needs rebase on Feb 20, 2024
  56. achow101 force-pushed on Feb 20, 2024
  57. DrahtBot removed the label Needs rebase on Feb 21, 2024
  58. DrahtBot added the label Needs rebase on Mar 27, 2024
  59. achow101 force-pushed on Apr 1, 2024
  60. DrahtBot removed the label Needs rebase on Apr 1, 2024
  61. DrahtBot added the label Needs rebase on Apr 8, 2024
  62. achow101 force-pushed on Apr 25, 2024
  63. DrahtBot removed the label Needs rebase on Apr 25, 2024
  64. achow101 force-pushed on Jun 6, 2024
  65. DrahtBot added the label Needs rebase on Aug 27, 2024
  66. achow101 force-pushed on Aug 29, 2024
  67. DrahtBot removed the label Needs rebase on Aug 29, 2024
  68. achow101 force-pushed on Sep 10, 2024
  69. DrahtBot added the label Needs rebase on Oct 24, 2024
  70. achow101 force-pushed on Oct 24, 2024
  71. DrahtBot removed the label Needs rebase on Oct 25, 2024
  72. achow101 force-pushed on Oct 28, 2024
  73. achow101 force-pushed on Oct 28, 2024
  74. achow101 force-pushed on Oct 28, 2024
  75. DrahtBot removed the label CI failed on Oct 28, 2024
  76. jonatack commented at 12:35 pm on November 26, 2024: member
    Concept ACK, pending #27286, if this improves performance for wallets with many transactions.
  77. DrahtBot added the label Needs rebase on Mar 13, 2025
  78. achow101 force-pushed on Apr 10, 2025
  79. DrahtBot removed the label Needs rebase on Apr 10, 2025
  80. DrahtBot added the label Needs rebase on Apr 25, 2025
  81. walletdb: Load Txs last 
    Need to load txs last so that IsMine works.
    d906e4bbf1
  82. wallet: Keep track of transaction outputs owned by the wallet 
    When loading transactions to the wallet, check the outputs, and keep
track of the ones that are IsMine.
    f8cdfabd1b
  83. wallet: Exit IsTrustedTx early if wtx is already in trusted_parents a5c21738f7
  84. wallet: Change balance calculation to use m_txos 
    Since we track the outputs owned by the wallet with m_txos, we can now
calculate the balance of the wallet by iterating m_txos and summing up
the amounts of the unspent txos.

As ISMINE_USED is not an actual isminetype that we attach to outputs and
was just passed into `CachedTxGetAvailableCredit` for convenience, we
pull the same determining logic from that function into `GetBalances` in
order to preserve existing behavior.
    0ba694307b
  85. wallet: Recalculate the wallet's txos after any imports 93563ecef5
  86. test: Test for balance update due to watchonly becoming spendable e14e3c9177
  87. wallet: Use wallet's TXO set in AvailableCoins 
    Instead of iterating every transaction and every output stored in wallet
when trying to figure out what outputs can be spent, iterate the TXO set
which should be a lot smaller.
    0ada5f703e
  88. wallet: Retrieve TXO directly in FetchSelectedInputs 
    Instead of searching mapWallet for the preselected inputs, search
m_txos.

wallet_fundrawtransaction.py spends external inputs and needs the change
output to also belong to the test wallet for the oversized tx test.
    0fd61de1b1
  89. wallet: Recompute wallet TXOs after descriptor migration 
    When a legacy wallet has been migrated to contain descriptors, but
before the transactions have been updated to match, we need to recompute
the wallet TXOs so that the transaction update will work correctly.
    2e8fe94bfa
  90. wallet: Have GetDebit use the wallet's TXO set 
    Instead of looking up the previous tx in mapWallet, and then calling
IsMine on the specified output, use the TXO set and its cached IsMine
value.
    0cb0da34a8
  91. wallet: Remove unused CachedTxGet{Available,Immature}Credit 
    These two functions are no longer used as GetBalances now uses the TXO
set rather than per-tx cached balances
    3d0f7ce956
  92. bench: Have AvailableCoins benchmark include a lot of unrelated utxos 
    One of the main issues with AvailableCoins is its performance when txs
have unrelated outputs, so update the benchmark to check the performance
of that.
    26014804bb
  93. achow101 force-pushed on Apr 25, 2025
  94. wallet: Store the TxState in each WalletTXO as well a59ba74c29
  95. wallet: Get the depth in main chain for a TxState 2534b816a3
  96. wallet: Get the coinbase maturity state for a TXO and TxState e07ec6798c
  97. wallet: Use WalletTXO stored state and coinbase rather than wtx b9f010555c
  98. wallet: Replace CWalletTx::fFromMe with m_from_me for "from me" status 
    fFromMe was an unused variable in CWalletTx that did not accurately
track the "from me" status of the transaction as the name would imply.
m_from_me is a replacement which does track this status and can be used
to determine whether a transaction is "from me" with the different
ismine filters that we use.
    352a0ed6e9
  99. wallet: Replace CachedTxIsFromMe with CheckIsFromMeMap 
    Instead of looking at the cached amounts or searching every input of a
transaction each time we want to determine whether it is "from me", use
the m_from_me map which stores this value for us.
    d65cc870e6
  100. wallet: Store a copy of m_from_me in WalletTXOs and use for "from me" 
    Since we need to know whether the transaction that creates a WalletTXO
is "from me", we should store this state in the WalletTXO too, copied
from its parent CWalletTx.
    b045a05dec
  101. wallet: Have WalletTXOs also store parent tx time 
    WalletTXOs need to know their parent tx's timestamp for AvailableCoins
to work.
    190ffa49aa
  102. wallet: Make CWalletTx::m_state private with {get,set}ters a89edfd0db
  103. wallet: have CWalletTx also be aware of it's WalletTXOs 711315c0b2
  104. wallet: Also update a CWalletTx's WalletTXOs states 
    When the state of a CWalletTx changes, we need to change the state in
the WalletTXOs too.
    e5f5eaf877
  105. wallet: Remove unused WalletTXO::GetWalletTx() 3f247ff748
  106. wallet: Have IsSpent take a min_conf 
    A min_conf parameter is added to IsSpent so that it can set a
confirmation threshold for whether something is considered spent.
    c39daf8adb
  107. wallet: Iterate block txs in reverse on blockDisconnected 
    When a block is disconnected, we need to process the transactions in
reverse order so that the wallet's TXO set is updated in the correct
order.
    20ec19ccce
  108. wallet, tests: Have CreateSyncedWallet use CWallet::Create 
    CWallet::Create will properly connect the wallet to the chain, so we
should be doing that rather than ad-hoc chain connection.
    db39896446
  109. wallet: Move definintely unusable TXOs to a separate container 
    Definitely unusable TXOs are those that are spent by a confirmed
transaction or were produced by a now conflicted transaction. However,
we still need them for GetDebit, so we store them in a separate
m_unusable_txos container. MarkConflicted, AbandonTransaction, and
loading (via PruneSpentTXOs) will ensure that these unusable TXOs are
properly moved.
    6fac290996
  110. DrahtBot removed the label Needs rebase on Apr 25, 2025


achow101 DrahtBot t-bast remyers murchandamus jonatack

Labels
Wallet

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2025-04-29 03:12 UTC
This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me