core::fmt::Display for UpdateError {
#[cfg(feature = "std")]
impl std::error::Error for UpdateError {}
-impl ChainOracle for SparseChain {
+impl
ChainOracle for SparseChain
{
type Error = Infallible;
fn get_tip_in_best_chain(&self) -> Result, Self::Error> {
@@ -473,7 +473,7 @@ impl ChainOracle for SparseChain {
}
}
-impl SparseChain {
+impl
SparseChain
{
/// Creates a new chain from a list of block hashes and heights. The caller must guarantee they
/// are in the same chain.
pub fn from_checkpoints(checkpoints: C) -> Self
@@ -504,13 +504,6 @@ impl SparseChain {
.map(|&hash| BlockId { height, hash })
}
- /// Return the [`ChainPosition`] of a `txid`.
- ///
- /// This returns [`None`] if the transaction does not exist.
- pub fn tx_position(&self, txid: Txid) -> Option<&P> {
- self.txid_to_pos.get(&txid)
- }
-
/// Return a [`BTreeMap`] of all checkpoints (block hashes by height).
pub fn checkpoints(&self) -> &BTreeMap {
&self.checkpoints
@@ -526,6 +519,47 @@ impl SparseChain {
.map(|(&height, &hash)| BlockId { height, hash })
}
+ /// Returns the value set as the checkpoint limit.
+ ///
+ /// Refer to [`set_checkpoint_limit`].
+ ///
+ /// [`set_checkpoint_limit`]: Self::set_checkpoint_limit
+ pub fn checkpoint_limit(&self) -> Option {
+ self.checkpoint_limit
+ }
+
+ /// Set the checkpoint limit.
+ ///
+ /// The checkpoint limit restricts the number of checkpoints that can be stored in [`Self`].
+ /// Oldest checkpoints are pruned first.
+ pub fn set_checkpoint_limit(&mut self, limit: Option) {
+ self.checkpoint_limit = limit;
+ self.prune_checkpoints();
+ }
+
+ fn prune_checkpoints(&mut self) -> Option> {
+ let limit = self.checkpoint_limit?;
+
+ // find the last height to be pruned
+ let last_height = *self.checkpoints.keys().rev().nth(limit)?;
+ // first height to be kept
+ let keep_height = last_height + 1;
+
+ let mut split = self.checkpoints.split_off(&keep_height);
+ core::mem::swap(&mut self.checkpoints, &mut split);
+
+ Some(split)
+ }
+}
+
+impl SparseChain {
+ /// Return the [`ChainPosition`] of a `txid`.
+ ///
+ /// This returns [`None`] if the transaction does not exist.
+ pub fn tx_position(&self, txid: Txid) -> Option<&P> {
+ self.txid_to_pos.get(&txid)
+ }
+
/// Preview changes of updating [`Self`] with another chain that connects to it.
///
/// If the `update` wishes to introduce confirmed transactions, it must contain a checkpoint
@@ -936,24 +970,6 @@ impl SparseChain {
})
}
- /// Returns the value set as the checkpoint limit.
- ///
- /// Refer to [`set_checkpoint_limit`].
- ///
- /// [`set_checkpoint_limit`]: Self::set_checkpoint_limit
- pub fn checkpoint_limit(&self) -> Option {
- self.checkpoint_limit
- }
-
- /// Set the checkpoint limit.
- ///
- /// The checkpoint limit restricts the number of checkpoints that can be stored in [`Self`].
- /// Oldest checkpoints are pruned first.
- pub fn set_checkpoint_limit(&mut self, limit: Option) {
- self.checkpoint_limit = limit;
- self.prune_checkpoints();
- }
-
/// Return [`Txid`]s that would be added to the sparse chain if this `changeset` was applied.
pub fn changeset_additions<'a>(
&'a self,
@@ -969,20 +985,6 @@ impl SparseChain {
.map(|(&txid, _)| txid)
}
- fn prune_checkpoints(&mut self) -> Option> {
- let limit = self.checkpoint_limit?;
-
- // find the last height to be pruned
- let last_height = *self.checkpoints.keys().rev().nth(limit)?;
- // first height to be kept
- let keep_height = last_height + 1;
-
- let mut split = self.checkpoints.split_off(&keep_height);
- core::mem::swap(&mut self.checkpoints, &mut split);
-
- Some(split)
- }
-
/// Finds the transaction in the chain that spends `outpoint`.
///
/// [`TxGraph`] is used to provide the spend relationships.
diff --git a/crates/chain/src/tx_graph.rs b/crates/chain/src/tx_graph.rs
index 893060ae..620a2dc3 100644
--- a/crates/chain/src/tx_graph.rs
+++ b/crates/chain/src/tx_graph.rs
@@ -55,7 +55,7 @@
//! assert!(additions.is_empty());
//! ```
-use crate::{collections::*, BlockAnchor, ChainOracle, ForEachTxOut, ObservedIn};
+use crate::{collections::*, BlockAnchor, ChainOracle, ForEachTxOut, ObservedAs};
use alloc::vec::Vec;
use bitcoin::{OutPoint, Transaction, TxOut, Txid};
use core::{
@@ -91,10 +91,7 @@ impl Default for TxGraph {
}
}
-// pub type InChainTx<'a, T, A> = (ObservedIn<&'a A>, TxInGraph<'a, T, A>);
-// pub type InChainTxOut<'a, I, A> = (&'a I, FullTxOut>);
-
-/// An outward-facing view of a transaction node that resides in a [`TxGraph`].
+/// An outward-facing representation of a (transaction) node in the [`TxGraph`].
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub struct TxNode<'a, T, A> {
/// Txid of the transaction.
@@ -601,7 +598,7 @@ impl TxGraph {
&self,
chain: C,
txid: Txid,
- ) -> Result>, C::Error>
+ ) -> Result>, C::Error>
where
C: ChainOracle,
{
@@ -614,7 +611,7 @@ impl TxGraph {
for anchor in anchors {
if chain.is_block_in_best_chain(anchor.anchor_block())? {
- return Ok(Some(ObservedIn::Block(anchor)));
+ return Ok(Some(ObservedAs::Confirmed(anchor)));
}
}
@@ -643,10 +640,10 @@ impl TxGraph {
}
}
- Ok(Some(ObservedIn::Mempool(last_seen)))
+ Ok(Some(ObservedAs::Unconfirmed(last_seen)))
}
- pub fn get_chain_position(&self, chain: C, txid: Txid) -> Option>
+ pub fn get_chain_position(&self, chain: C, txid: Txid) -> Option>
where
C: ChainOracle,
{
@@ -658,7 +655,7 @@ impl TxGraph {
&self,
chain: C,
outpoint: OutPoint,
- ) -> Result, Txid)>, C::Error>
+ ) -> Result, Txid)>, C::Error>
where
C: ChainOracle,
{
@@ -678,7 +675,7 @@ impl TxGraph {
Ok(None)
}
- pub fn get_chain_spend(&self, chain: C, outpoint: OutPoint) -> Option<(ObservedIn<&A>, Txid)>
+ pub fn get_chain_spend(&self, chain: C, outpoint: OutPoint) -> Option<(ObservedAs<&A>, Txid)>
where
C: ChainOracle,
{