Skip to content

Commit 66071de

Browse files
evanlinjinevanlinjin
committed
refactor(chain)!: Rename to CanonicalizationParams
Previous name was `CanonicalizationMods`.
1 parent 0f00cdb commit 66071de

File tree

14 files changed

+61
-61
lines changed

14 files changed

+61
-61
lines changed

‎crates/bitcoind_rpc/tests/test_emitter.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use bdk_chain::{
55
bitcoin::{Address, Amount, Txid},
66
local_chain::{CheckPoint, LocalChain},
77
spk_txout::SpkTxOutIndex,
8-
Balance, BlockId, CanonicalizationMods, IndexedTxGraph, Merge,
8+
Balance, BlockId, CanonicalizationParams, IndexedTxGraph, Merge,
99
};
1010
use bdk_testenv::{anyhow, TestEnv};
1111
use bitcoin::{hashes::Hash, Block, OutPoint, ScriptBuf, WScriptHash};
@@ -309,7 +309,7 @@ fn get_balance(
309309
let balance = recv_graph.graph().balance(
310310
recv_chain,
311311
chain_tip,
312-
CanonicalizationMods::NONE,
312+
CanonicalizationParams::NONE,
313313
outpoints,
314314
|_, _| true,
315315
);

‎crates/chain/benches/canonicalization.rs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use bdk_chain::CanonicalizationMods;
1+
use bdk_chain::CanonicalizationParams;
22
use bdk_chain::{keychain_txout::KeychainTxOutIndex, local_chain::LocalChain, IndexedTxGraph};
33
use bdk_core::{BlockId, CheckPoint};
44
use bdk_core::{ConfirmationBlockTime, TxUpdate};
@@ -94,7 +94,7 @@ fn run_list_canonical_txs(tx_graph: &KeychainTxGraph, chain: &LocalChain, exp_tx
9494
let txs = tx_graph.graph().list_canonical_txs(
9595
chain,
9696
chain.tip().block_id(),
97-
CanonicalizationMods::NONE,
97+
CanonicalizationParams::NONE,
9898
);
9999
assert_eq!(txs.count(), exp_txs);
100100
}
@@ -103,7 +103,7 @@ fn run_filter_chain_txouts(tx_graph: &KeychainTxGraph, chain: &LocalChain, exp_t
103103
let utxos = tx_graph.graph().filter_chain_txouts(
104104
chain,
105105
chain.tip().block_id(),
106-
CanonicalizationMods::NONE,
106+
CanonicalizationParams::NONE,
107107
tx_graph.index.outpoints().clone(),
108108
);
109109
assert_eq!(utxos.count(), exp_txos);
@@ -113,7 +113,7 @@ fn run_filter_chain_unspents(tx_graph: &KeychainTxGraph, chain: &LocalChain, exp
113113
let utxos = tx_graph.graph().filter_chain_unspents(
114114
chain,
115115
chain.tip().block_id(),
116-
CanonicalizationMods::NONE,
116+
CanonicalizationParams::NONE,
117117
tx_graph.index.outpoints().clone(),
118118
);
119119
assert_eq!(utxos.count(), exp_utxos);

‎crates/chain/src/canonical_iter.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ use bitcoin::{Transaction, Txid};
1010

1111
/// Modifies the canonicalization algorithm.
1212
#[derive(Debug, Default, Clone)]
13-
pub struct CanonicalizationMods {
13+
pub struct CanonicalizationParams {
1414
/// Transactions that will supercede all other transactions.
1515
///
1616
/// In case of conflicting transactions within `assume_canonical`, transactions that appear
1717
/// later in the list (have higher index) have precedence.
1818
pub assume_canonical: Vec<Txid>,
1919
}
2020

21-
impl CanonicalizationMods {
21+
impl CanonicalizationParams {
2222
/// No mods.
2323
pub const NONE: Self = Self {
2424
assume_canonical: Vec::new(),
@@ -49,7 +49,7 @@ impl<'g, A: Anchor, C: ChainOracle> CanonicalIter<'g, A, C> {
4949
tx_graph: &'g TxGraph<A>,
5050
chain: &'g C,
5151
chain_tip: BlockId,
52-
mods: CanonicalizationMods,
52+
mods: CanonicalizationParams,
5353
) -> Self {
5454
let anchors = tx_graph.all_anchors();
5555
let unprocessed_assumed_txs = Box::new(

‎crates/chain/src/tx_graph.rs‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ use crate::collections::*;
9494
use crate::BlockId;
9595
use crate::CanonicalIter;
9696
use crate::CanonicalReason;
97-
use crate::CanonicalizationMods;
97+
use crate::CanonicalizationParams;
9898
use crate::ObservedIn;
9999
use crate::{Anchor, Balance, ChainOracle, ChainPosition, FullTxOut, Merge};
100100
use alloc::collections::vec_deque::VecDeque;
@@ -830,7 +830,7 @@ impl<A: Anchor> TxGraph<A> {
830830
&'a self,
831831
chain: &'a C,
832832
chain_tip: BlockId,
833-
mods: CanonicalizationMods,
833+
mods: CanonicalizationParams,
834834
) -> impl Iterator<Item = Result<CanonicalTx<'a, Arc<Transaction>, A>, C::Error>> {
835835
fn find_direct_anchor<A: Anchor, C: ChainOracle>(
836836
tx_node: &TxNode<'_, Arc<Transaction>, A>,
@@ -908,7 +908,7 @@ impl<A: Anchor> TxGraph<A> {
908908
&'a self,
909909
chain: &'a C,
910910
chain_tip: BlockId,
911-
mods: CanonicalizationMods,
911+
mods: CanonicalizationParams,
912912
) -> impl Iterator<Item = CanonicalTx<'a, Arc<Transaction>, A>> {
913913
self.try_list_canonical_txs(chain, chain_tip, mods)
914914
.map(|res| res.expect("infallible"))
@@ -937,7 +937,7 @@ impl<A: Anchor> TxGraph<A> {
937937
&'a self,
938938
chain: &'a C,
939939
chain_tip: BlockId,
940-
mods: CanonicalizationMods,
940+
mods: CanonicalizationParams,
941941
outpoints: impl IntoIterator<Item = (OI, OutPoint)> + 'a,
942942
) -> Result<impl Iterator<Item = (OI, FullTxOut<A>)> + 'a, C::Error> {
943943
let mut canon_txs = HashMap::<Txid, CanonicalTx<Arc<Transaction>, A>>::new();
@@ -1011,7 +1011,7 @@ impl<A: Anchor> TxGraph<A> {
10111011
&'a self,
10121012
chain: &'a C,
10131013
chain_tip: BlockId,
1014-
mods: CanonicalizationMods,
1014+
mods: CanonicalizationParams,
10151015
) -> CanonicalIter<'a, A, C> {
10161016
CanonicalIter::new(self, chain, chain_tip, mods)
10171017
}
@@ -1026,7 +1026,7 @@ impl<A: Anchor> TxGraph<A> {
10261026
&'a self,
10271027
chain: &'a C,
10281028
chain_tip: BlockId,
1029-
mods: CanonicalizationMods,
1029+
mods: CanonicalizationParams,
10301030
outpoints: impl IntoIterator<Item = (OI, OutPoint)> + 'a,
10311031
) -> impl Iterator<Item = (OI, FullTxOut<A>)> + 'a {
10321032
self.try_filter_chain_txouts(chain, chain_tip, mods, outpoints)
@@ -1055,7 +1055,7 @@ impl<A: Anchor> TxGraph<A> {
10551055
&'a self,
10561056
chain: &'a C,
10571057
chain_tip: BlockId,
1058-
mods: CanonicalizationMods,
1058+
mods: CanonicalizationParams,
10591059
outpoints: impl IntoIterator<Item = (OI, OutPoint)> + 'a,
10601060
) -> Result<impl Iterator<Item = (OI, FullTxOut<A>)> + 'a, C::Error> {
10611061
Ok(self
@@ -1073,7 +1073,7 @@ impl<A: Anchor> TxGraph<A> {
10731073
&'a self,
10741074
chain: &'a C,
10751075
chain_tip: BlockId,
1076-
mods: CanonicalizationMods,
1076+
mods: CanonicalizationParams,
10771077
txouts: impl IntoIterator<Item = (OI, OutPoint)> + 'a,
10781078
) -> impl Iterator<Item = (OI, FullTxOut<A>)> + 'a {
10791079
self.try_filter_chain_unspents(chain, chain_tip, mods, txouts)
@@ -1096,7 +1096,7 @@ impl<A: Anchor> TxGraph<A> {
10961096
&self,
10971097
chain: &C,
10981098
chain_tip: BlockId,
1099-
mods: CanonicalizationMods,
1099+
mods: CanonicalizationParams,
11001100
outpoints: impl IntoIterator<Item = (OI, OutPoint)>,
11011101
mut trust_predicate: impl FnMut(&OI, ScriptBuf) -> bool,
11021102
) -> Result<Balance, C::Error> {
@@ -1141,7 +1141,7 @@ impl<A: Anchor> TxGraph<A> {
11411141
&self,
11421142
chain: &C,
11431143
chain_tip: BlockId,
1144-
mods: CanonicalizationMods,
1144+
mods: CanonicalizationParams,
11451145
outpoints: impl IntoIterator<Item = (OI, OutPoint)>,
11461146
trust_predicate: impl FnMut(&OI, ScriptBuf) -> bool,
11471147
) -> Balance {

‎crates/chain/tests/common/tx_template.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use bdk_testenv::utils::DESCRIPTORS;
44
use rand::distributions::{Alphanumeric, DistString};
55
use std::collections::HashMap;
66

7-
use bdk_chain::{spk_txout::SpkTxOutIndex, tx_graph::TxGraph, Anchor, CanonicalizationMods};
7+
use bdk_chain::{spk_txout::SpkTxOutIndex, tx_graph::TxGraph, Anchor, CanonicalizationParams};
88
use bitcoin::{
99
locktime::absolute::LockTime, secp256k1::Secp256k1, transaction, Amount, OutPoint, ScriptBuf,
1010
Sequence, Transaction, TxIn, TxOut, Txid, Witness,
@@ -57,7 +57,7 @@ pub struct TxTemplateEnv<'a, A> {
5757
pub tx_graph: TxGraph<A>,
5858
pub indexer: SpkTxOutIndex<u32>,
5959
pub txid_to_name: HashMap<&'a str, Txid>,
60-
pub canonicalization_mods: CanonicalizationMods,
60+
pub canonicalization_mods: CanonicalizationParams,
6161
}
6262

6363
#[allow(dead_code)]
@@ -79,7 +79,7 @@ pub fn init_graph<'a, A: Anchor + Clone + 'a>(
7979
});
8080
let mut txid_to_name = HashMap::<&'a str, Txid>::new();
8181

82-
let mut canonicalization_mods = CanonicalizationMods::default();
82+
let mut canonicalization_mods = CanonicalizationParams::default();
8383
for (bogus_txin_vout, tx_tmp) in tx_templates.into_iter().enumerate() {
8484
let tx = Transaction {
8585
version: transaction::Version::non_standard(0),

‎crates/chain/tests/test_indexed_tx_graph.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use bdk_chain::{
99
indexed_tx_graph::{self, IndexedTxGraph},
1010
indexer::keychain_txout::KeychainTxOutIndex,
1111
local_chain::LocalChain,
12-
tx_graph, Balance, CanonicalizationMods, ChainPosition, ConfirmationBlockTime, DescriptorExt,
12+
tx_graph, Balance, CanonicalizationParams, ChainPosition, ConfirmationBlockTime, DescriptorExt,
1313
};
1414
use bdk_testenv::{
1515
block_id, hash,
@@ -271,7 +271,7 @@ fn test_list_owned_txouts() {
271271
.filter_chain_txouts(
272272
&local_chain,
273273
chain_tip,
274-
CanonicalizationMods::NONE,
274+
CanonicalizationParams::NONE,
275275
graph.index.outpoints().iter().cloned(),
276276
)
277277
.collect::<Vec<_>>();
@@ -281,15 +281,15 @@ fn test_list_owned_txouts() {
281281
.filter_chain_unspents(
282282
&local_chain,
283283
chain_tip,
284-
CanonicalizationMods::NONE,
284+
CanonicalizationParams::NONE,
285285
graph.index.outpoints().iter().cloned(),
286286
)
287287
.collect::<Vec<_>>();
288288

289289
let balance = graph.graph().balance(
290290
&local_chain,
291291
chain_tip,
292-
CanonicalizationMods::NONE,
292+
CanonicalizationParams::NONE,
293293
graph.index.outpoints().iter().cloned(),
294294
|_, spk: ScriptBuf| trusted_spks.contains(&spk),
295295
);
@@ -592,7 +592,7 @@ fn test_get_chain_position() {
592592
// check chain position
593593
let chain_pos = graph
594594
.graph()
595-
.list_canonical_txs(chain, chain.tip().block_id(), CanonicalizationMods::NONE)
595+
.list_canonical_txs(chain, chain.tip().block_id(), CanonicalizationParams::NONE)
596596
.find_map(|canon_tx| {
597597
if canon_tx.tx_node.txid == txid {
598598
Some(canon_tx.chain_position)

‎crates/chain/tests/test_tx_graph.rs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
#[macro_use]
44
mod common;
5-
use bdk_chain::{collections::*, BlockId, CanonicalizationMods, ConfirmationBlockTime};
5+
use bdk_chain::{collections::*, BlockId, CanonicalizationParams, ConfirmationBlockTime};
66
use bdk_chain::{
77
local_chain::LocalChain,
88
tx_graph::{self, CalculateFeeError},
@@ -953,7 +953,7 @@ fn test_chain_spends() {
953953
.filter_chain_txouts(
954954
chain,
955955
tip.block_id(),
956-
CanonicalizationMods::NONE,
956+
CanonicalizationParams::NONE,
957957
tx_graph.all_txouts().map(|(op, _)| ((), op)),
958958
)
959959
.filter_map(|(_, full_txo)| Some((full_txo.outpoint, full_txo.spent_by?)))
@@ -963,7 +963,7 @@ fn test_chain_spends() {
963963
tx_graph: &TxGraph<ConfirmationBlockTime>|
964964
-> HashMap<Txid, ChainPosition<ConfirmationBlockTime>> {
965965
tx_graph
966-
.list_canonical_txs(chain, tip.block_id(), CanonicalizationMods::NONE)
966+
.list_canonical_txs(chain, tip.block_id(), CanonicalizationParams::NONE)
967967
.map(|canon_tx| (canon_tx.tx_node.txid, canon_tx.chain_position))
968968
.collect()
969969
};
@@ -1132,14 +1132,14 @@ fn transactions_inserted_into_tx_graph_are_not_canonical_until_they_have_an_anch
11321132
.collect();
11331133
let chain = LocalChain::from_blocks(blocks).unwrap();
11341134
let canonical_txs: Vec<_> = graph
1135-
.list_canonical_txs(&chain, chain.tip().block_id(), CanonicalizationMods::NONE)
1135+
.list_canonical_txs(&chain, chain.tip().block_id(), CanonicalizationParams::NONE)
11361136
.collect();
11371137
assert!(canonical_txs.is_empty());
11381138

11391139
// tx0 with seen_at should be returned by canonical txs
11401140
let _ = graph.insert_seen_at(txids[0], 2);
11411141
let mut canonical_txs =
1142-
graph.list_canonical_txs(&chain, chain.tip().block_id(), CanonicalizationMods::NONE);
1142+
graph.list_canonical_txs(&chain, chain.tip().block_id(), CanonicalizationParams::NONE);
11431143
assert_eq!(
11441144
canonical_txs.next().map(|tx| tx.tx_node.txid).unwrap(),
11451145
txids[0]
@@ -1149,7 +1149,7 @@ fn transactions_inserted_into_tx_graph_are_not_canonical_until_they_have_an_anch
11491149
// tx1 with anchor is also canonical
11501150
let _ = graph.insert_anchor(txids[1], block_id!(2, "B"));
11511151
let canonical_txids: Vec<_> = graph
1152-
.list_canonical_txs(&chain, chain.tip().block_id(), CanonicalizationMods::NONE)
1152+
.list_canonical_txs(&chain, chain.tip().block_id(), CanonicalizationParams::NONE)
11531153
.map(|tx| tx.tx_node.txid)
11541154
.collect();
11551155
assert!(canonical_txids.contains(&txids[1]));

‎crates/electrum/tests/test_electrum.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use bdk_chain::{
33
local_chain::LocalChain,
44
spk_client::{FullScanRequest, SyncRequest, SyncResponse},
55
spk_txout::SpkTxOutIndex,
6-
Balance, CanonicalizationMods, ConfirmationBlockTime, IndexedTxGraph, Indexer, Merge, TxGraph,
6+
Balance, CanonicalizationParams, ConfirmationBlockTime, IndexedTxGraph, Indexer, Merge, TxGraph,
77
};
88
use bdk_electrum::BdkElectrumClient;
99
use bdk_testenv::{anyhow, bitcoincore_rpc::RpcApi, TestEnv};
@@ -23,7 +23,7 @@ fn get_balance(
2323
let balance = recv_graph.graph().balance(
2424
recv_chain,
2525
chain_tip,
26-
CanonicalizationMods::NONE,
26+
CanonicalizationParams::NONE,
2727
outpoints,
2828
|_, _| true,
2929
);

‎crates/wallet/src/wallet/mod.rs‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ use alloc::{
1919
sync::Arc,
2020
vec::Vec,
2121
};
22-
use chain::CanonicalizationMods;
22+
use chain::CanonicalizationParams;
2323
use core::{cmp::Ordering, fmt, mem, ops::Deref};
2424

2525
use bdk_chain::{
@@ -817,7 +817,7 @@ impl Wallet {
817817
.filter_chain_unspents(
818818
&self.chain,
819819
self.chain.tip().block_id(),
820-
CanonicalizationMods::NONE,
820+
CanonicalizationParams::NONE,
821821
self.indexed_graph.index.outpoints().iter().cloned(),
822822
)
823823
.map(|((k, i), full_txo)| new_local_utxo(k, i, full_txo))
@@ -832,7 +832,7 @@ impl Wallet {
832832
.filter_chain_txouts(
833833
&self.chain,
834834
self.chain.tip().block_id(),
835-
CanonicalizationMods::NONE,
835+
CanonicalizationParams::NONE,
836836
self.indexed_graph.index.outpoints().iter().cloned(),
837837
)
838838
.map(|((k, i), full_txo)| new_local_utxo(k, i, full_txo))
@@ -886,7 +886,7 @@ impl Wallet {
886886
.filter_chain_unspents(
887887
&self.chain,
888888
self.chain.tip().block_id(),
889-
CanonicalizationMods::NONE,
889+
CanonicalizationParams::NONE,
890890
core::iter::once(((), op)),
891891
)
892892
.map(|(_, full_txo)| new_local_utxo(keychain, index, full_txo))
@@ -1065,7 +1065,7 @@ impl Wallet {
10651065
.list_canonical_txs(
10661066
&self.chain,
10671067
self.chain.tip().block_id(),
1068-
CanonicalizationMods::NONE,
1068+
CanonicalizationParams::NONE,
10691069
)
10701070
.find(|tx| tx.tx_node.txid == txid)
10711071
}
@@ -1088,7 +1088,7 @@ impl Wallet {
10881088
.list_canonical_txs(
10891089
&self.chain,
10901090
self.chain.tip().block_id(),
1091-
CanonicalizationMods::NONE,
1091+
CanonicalizationParams::NONE,
10921092
)
10931093
.filter(|c_tx| tx_index.is_tx_relevant(&c_tx.tx_node.tx))
10941094
}
@@ -1124,7 +1124,7 @@ impl Wallet {
11241124
self.indexed_graph.graph().balance(
11251125
&self.chain,
11261126
self.chain.tip().block_id(),
1127-
CanonicalizationMods::NONE,
1127+
CanonicalizationParams::NONE,
11281128
self.indexed_graph.index.outpoints().iter().cloned(),
11291129
|&(k, _), _| k == KeychainKind::Internal,
11301130
)
@@ -1595,7 +1595,7 @@ impl Wallet {
15951595
let txout_index = &self.indexed_graph.index;
15961596
let chain_tip = self.chain.tip().block_id();
15971597
let chain_positions = graph
1598-
.list_canonical_txs(&self.chain, chain_tip, CanonicalizationMods::NONE)
1598+
.list_canonical_txs(&self.chain, chain_tip, CanonicalizationParams::NONE)
15991599
.map(|canon_tx| (canon_tx.tx_node.txid, canon_tx.chain_position))
16001600
.collect::<HashMap<Txid, _>>();
16011601

@@ -1852,7 +1852,7 @@ impl Wallet {
18521852
let confirmation_heights = self
18531853
.indexed_graph
18541854
.graph()
1855-
.list_canonical_txs(&self.chain, chain_tip, CanonicalizationMods::NONE)
1855+
.list_canonical_txs(&self.chain, chain_tip, CanonicalizationParams::NONE)
18561856
.filter(|canon_tx| prev_txids.contains(&canon_tx.tx_node.txid))
18571857
// This is for a small performance gain. Although `.filter` filters out excess txs, it
18581858
// will still consume the internal `CanonicalIter` entirely. Having a `.take` here

0 commit comments

Comments
 (0)