Merge #1976: Disallow unconfirmed coinbase

c84035e test(chain): Add scenario: coinbase tx must not become unconfirmed (志宇)
e8da007 fix(chain): Unconfirmed coinbase txs should never be canonical (志宇)

Pull request description:

  ### Description

  The logic in `CanonicalIter` includes transactions anchored to blocks outside the best chain, since they may still appear in the mempool.

  However, coinbase transactions can never be unconfirmed—a case the previous logic failed to exclude.

  ### Notes to the reviewers

  Sorry for my previous oversight on this.

  ### Changelog notice

  ```md
  Fixed:
  - During canonicalization, exclude coinbase transactions when considering txs that are anchored in stale blocks.
  ```

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
  * [x] I ran `cargo +nightly fmt` and `cargo clippy` before committing

  #### Bugfixes:

  ~* [ ] This pull request breaks the existing API~
  * [x] I've added tests to reproduce the issue which are now passing
  * [ ] I'm linking the issue being fixed by this PR

ACKs for top commit:
  evanlinjin:
    self-ACK c84035e

Tree-SHA512: 3aaff032ce390a7a8845c8704727daccab1afa2b0437f6706802f6ec37f7ffd79729407f1cba91b7e5045974a3a627c78a150242e2aaacb04a03b8f47528046b

Author: evanlinjin

crates/chain/src/canonical_iter.rs

@@ -230,6 +230,10 @@ impl<A: Anchor, C: ChainOracle> Iterator for CanonicalIter<'_, A, C> {
             }
 
             if let Some((txid, tx, last_seen)) = self.unprocessed_seen_txs.next() {
+                debug_assert!(
+                    !tx.is_coinbase(),
+                    "Coinbase txs must not have `last_seen` (in mempool) value"
+                );
                 if !self.is_canonicalized(txid) {
                     let observed_in = ObservedIn::Mempool(last_seen);
                     self.mark_canonical(txid, tx, CanonicalReason::from_observed_in(observed_in));
@@ -238,7 +242,7 @@ impl<A: Anchor, C: ChainOracle> Iterator for CanonicalIter<'_, A, C> {
             }
 
             if let Some((txid, tx, height)) = self.unprocessed_leftover_txs.pop_front() {
-                if !self.is_canonicalized(txid) {
+                if !self.is_canonicalized(txid) && !tx.is_coinbase() {
                     let observed_in = ObservedIn::Block(height);
                     self.mark_canonical(txid, tx, CanonicalReason::from_observed_in(observed_in));
                 }

crates/chain/tests/test_tx_graph_conflicts.rs

@@ -943,6 +943,28 @@ fn test_tx_conflict_handling() {
                 confirmed: Amount::ZERO,
             },
         },
+        Scenario {
+            name: "coinbase tx must not become unconfirmed",
+            tx_templates: &[
+                TxTemplate {
+                    tx_name: "coinbase",
+                    inputs: &[TxInTemplate::Coinbase],
+                    outputs: &[TxOutTemplate::new(21_000, Some(0))],
+                    // Stale block
+                    anchors: &[block_id!(1, "B-prime")],
+                    ..Default::default()
+                }
+            ],
+            exp_chain_txs: HashSet::from([]),
+            exp_chain_txouts: HashSet::from([]),
+            exp_unspents: HashSet::from([]),
+            exp_balance: Balance {
+                immature: Amount::ZERO,
+                trusted_pending: Amount::ZERO,
+                untrusted_pending: Amount::ZERO,
+                confirmed: Amount::ZERO,
+            }
+        }
     ];
 
     for scenario in scenarios {