frost/bdk
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[chain_redesign] Various LocalChain improvements

Browse Source 
* Introduce `LocalChain::inner` method to get the inner map of block
  height to hash.
* Replace `LocalChain::get_block` (which outputted `BlockId`, thus able
  to return invalid representation) with `get_blockhash` that just
returns a `BlockHash`.
* Remove `TODO` comments that should be github tickets.
This commit is contained in:
志宇 2023-05-05 16:55:21 +08:00
parent 2ccc116eda
commit a56d289eef
No known key found for this signature in database
GPG Key ID: F6345C9837C2BDE8
2 changed files with 32 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
crates/chain/src/local_chain.rs
View File

@ -6,13 +6,6 @@ use bitcoin::BlockHash;
use crate::{BlockId, ChainOracle}; use crate::{BlockId, ChainOracle};
/// This is a local implementation of [`ChainOracle`]. /// This is a local implementation of [`ChainOracle`].
///
/// TODO: We need a cache/snapshot thing for chain oracle.
/// * Minimize calls to remotes.
/// * Can we cache it forever? Should we drop stuff?
/// * Assume anything deeper than (i.e. 10) blocks won't be reorged.
/// * Is this a cache on txs or block? or both?
/// TODO: Parents of children are confirmed if children are confirmed.
#[derive(Debug, Default, Clone, PartialEq, Eq, PartialOrd, Ord)] #[derive(Debug, Default, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub struct LocalChain { pub struct LocalChain {
blocks: BTreeMap<u32, BlockHash>, blocks: BTreeMap<u32, BlockHash>,
@ -71,6 +64,11 @@ impl LocalChain {
} }
} }
/// Get a reference to the inner map of block height to hash.
pub fn inner(&self) -> &BTreeMap<u32, BlockHash> {
&self.blocks
}
pub fn tip(&self) -> Option<BlockId> { pub fn tip(&self) -> Option<BlockId> {
self.blocks self.blocks
.iter() .iter()
@ -78,11 +76,9 @@ impl LocalChain {
.map(|(&height, &hash)| BlockId { height, hash }) .map(|(&height, &hash)| BlockId { height, hash })
} }
/// Get a block at the given height. /// Get a [`BlockHash`] at the given height.
pub fn get_block(&self, height: u32) -> Option<BlockId> { pub fn get_blockhash(&self, height: u32) -> Option<BlockHash> {
self.blocks self.blocks.get(&height).cloned()
.get(&height)
.map(|&hash| BlockId { height, hash })
} }
/// This is like the sparsechain's logic, expect we must guarantee that all invalidated heights /// This is like the sparsechain's logic, expect we must guarantee that all invalidated heights

30
crates/chain/tests/test_indexed_tx_graph.rs
View File

@ -8,7 +8,7 @@ use bdk_chain::{
keychain::{Balance, DerivationAdditions, KeychainTxOutIndex}, keychain::{Balance, DerivationAdditions, KeychainTxOutIndex},
local_chain::LocalChain, local_chain::LocalChain,
tx_graph::Additions, tx_graph::Additions,
ConfirmationHeightAnchor, ObservedAs, BlockId, ConfirmationHeightAnchor, ObservedAs,
}; };
use bitcoin::{secp256k1::Secp256k1, BlockHash, OutPoint, Script, Transaction, TxIn, TxOut}; use bitcoin::{secp256k1::Secp256k1, BlockHash, OutPoint, Script, Transaction, TxIn, TxOut};
use miniscript::Descriptor; use miniscript::Descriptor;
@ -208,10 +208,12 @@ fn test_list_owned_txouts() {
let _ = graph.insert_relevant_txs( let _ = graph.insert_relevant_txs(
[&tx1, &tx2, &tx3, &tx6].iter().enumerate().map(|(i, tx)| { [&tx1, &tx2, &tx3, &tx6].iter().enumerate().map(|(i, tx)| {
let height = i as u32;
( (
*tx, *tx,
local_chain local_chain
.get_block(i as u32) .get_blockhash(height)
.map(|hash| BlockId { height, hash })
.map(|anchor_block| ConfirmationHeightAnchor { .map(|anchor_block| ConfirmationHeightAnchor {
anchor_block, anchor_block,
confirmation_height: anchor_block.height, confirmation_height: anchor_block.height,
@ -225,18 +227,34 @@ fn test_list_owned_txouts() {
// A helper lambda to extract and filter data from the graph. // A helper lambda to extract and filter data from the graph.
let fetch = let fetch =
|ht: u32, graph: &IndexedTxGraph<ConfirmationHeightAnchor, KeychainTxOutIndex<String>>| { |height: u32,
graph: &IndexedTxGraph<ConfirmationHeightAnchor, KeychainTxOutIndex<String>>| {
let txouts = graph let txouts = graph
.list_owned_txouts(&local_chain, local_chain.get_block(ht).unwrap()) .list_owned_txouts(
&local_chain,
local_chain
.get_blockhash(height)
.map(|hash| BlockId { height, hash })
.unwrap(),
)
.collect::<Vec<_>>(); .collect::<Vec<_>>();
let utxos = graph let utxos = graph
.list_owned_unspents(&local_chain, local_chain.get_block(ht).unwrap()) .list_owned_unspents(
&local_chain,
local_chain
.get_blockhash(height)
.map(|hash| BlockId { height, hash })
.unwrap(),
)
.collect::<Vec<_>>(); .collect::<Vec<_>>();
let balance = graph.balance( let balance = graph.balance(
&local_chain, &local_chain,
local_chain.get_block(ht).unwrap(), local_chain
.get_blockhash(height)
.map(|hash| BlockId { height, hash })
.unwrap(),
|spk: &Script| trusted_spks.contains(spk), |spk: &Script| trusted_spks.contains(spk),
); );