bitcoindevkit / bdk / 16859984937

79%

push

github

Merge bitcoindevkit/bdk#2008: `IndexedTxGraph`: Transactions that conflict with relevant txs are also relevant.

7ca58b3f6 chore(chain): fix typo in method doc comment (Wei Chen)
c846ad84d test(chain): `relevant_conflicts` (志宇)
7003ad44b feat(chain): Txs that conflict with relevant txs are also relevant (志宇)

Pull request description:

  ## Description

  This PR changes the behavior of `IndexedTxGraph` insert-if-relevant methods to consider relevant-tx-conflicts as relevant.

  Affected methods:
  * `.apply_block_relevant`
  * `.batch_insert_relevant`
  * `.batch_insert_relevant_unconfirmed`

  #### Rationale

  It is useful to be able to determine:

  * Why something is no longer part of the best history.
  * Whether it is possible that something can reappear in the best history.

  In order to do this, we need to track conflicts of spk-relevant transactions.

  For example, an incoming transaction may be evicted from the mempool due to insufficient fees or cancelled (a conflicting transaction is confirmed). The caller may want to handle these two possibilities differently:

  * **Transaction has insufficient fees** - the caller may want to CPFP the transaction.
  * **Transaction is cancelled/replaced** - The user may want to forget about this transaction once the conflict reaches x confirmations.

  The `IntentTracker` will make use of these relevant-conflicts to help determine the course of action.

  #### Side note about chain sources

  For some chain sources, obtaining relevant-conflicts is extremely costly or downright impossible (i.e. Electrum, BIP-158 filters).

  `bdk_bitcoind_rpc::Emitter` is still the most robust chain source to use.

  ### Changelog notice

  ```md
  Changed:
  - Behavior of `IndexedTxGraph` methods (`apply_block_relevant`, `batch_insert_relevant` and `batch_insert_relevant_unconfirmed`) to also consider conflicts of spk-relevant... (continued)

386 of 524 branches covered (73.66%)

Branch coverage included in aggregate %.

13 of 13 new or added lines in 1 file covered. (100.0%)

4302 of 5400 relevant lines covered (79.67%)

2200.17 hits per line