Struct bdk::wallet::signer::SignerWrapper

impl<S: Sized + Debug + Clone> SignerWrapper<S>

pub fn new(signer: S, ctx: SignerContext) -> Self

Create a wrapped signer from a signer and a context

Trait ImplementationsÂ§

impl<S: Clone + Sized + Debug + Clone> Clone for SignerWrapper<S>

fn clone(&self) -> SignerWrapper<S>

Returns a copy of the value. Read more

1.0.0 Â· sourceÂ§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl<S: Debug + Sized + Debug + Clone> Debug for SignerWrapper<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<S: Sized + Debug + Clone> Deref for SignerWrapper<S>

type Target = S

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl InputSigner for SignerWrapper<DescriptorMultiXKey<ExtendedPrivKey>>

fn sign_input(
    &self,
    psbt: &mut PartiallySignedTransaction,
    input_index: usize,
    sign_options: &SignOptions,
    secp: &Secp256k1<All>
) -> Result<(), SignerError>

Sign a single psbt input

impl InputSigner for SignerWrapper<DescriptorXKey<ExtendedPrivKey>>

fn sign_input(
    &self,
    psbt: &mut PartiallySignedTransaction,
    input_index: usize,
    sign_options: &SignOptions,
    secp: &Secp256k1<All>
) -> Result<(), SignerError>

Sign a single psbt input

impl InputSigner for SignerWrapper<PrivateKey>

fn sign_input(
    &self,
    psbt: &mut PartiallySignedTransaction,
    input_index: usize,
    sign_options: &SignOptions,
    secp: &Secp256k1<All>
) -> Result<(), SignerError>

Sign a single psbt input

impl SignerCommon for SignerWrapper<DescriptorMultiXKey<ExtendedPrivKey>>

fn id(&self, secp: &Secp256k1<All>) -> SignerId

Return the SignerId for this signer Read more

fn descriptor_secret_key(&self) -> Option<DescriptorSecretKey>

Return the secret key for the signer Read more

impl SignerCommon for SignerWrapper<DescriptorXKey<ExtendedPrivKey>>

fn id(&self, secp: &Secp256k1<All>) -> SignerId

Return the SignerId for this signer Read more

fn descriptor_secret_key(&self) -> Option<DescriptorSecretKey>

Return the secret key for the signer Read more

impl SignerCommon for SignerWrapper<PrivateKey>

fn id(&self, secp: &Secp256k1<All>) -> SignerId

Return the SignerId for this signer Read more

fn descriptor_secret_key(&self) -> Option<DescriptorSecretKey>

Return the secret key for the signer Read more

Auto Trait ImplementationsÂ§

impl<S> UnwindSafe for SignerWrapper<S>where
S: UnwindSafe,

Blanket ImplementationsÂ§

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable Â· sourceÂ§

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable Â· sourceÂ§

fn into(self) -> U

Calls U::from(self).

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.Wallet.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.Wallet.html index 8886152980..f498ecb385 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.Wallet.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.Wallet.html @@ -1,6 +1,6 @@ Wallet in bdk::wallet - Rust

Struct bdk::wallet::Wallet

source Â·

pub struct Wallet<D = ()> { /* private fields */ }

Expand description

A Bitcoin wallet

The Wallet struct acts as a way of coherently interfacing with output descriptors and related transactions. +

The Wallet acts as a way of coherently interfacing with output descriptors and related transactions. Its main components are:

output descriptors from which it can derive addresses.

Emitter::next_block

Emitter::next_header

Ok(None)

Emitter::mempool

Re-exports

pub use bitcoincore_rpc;

Structs

Emitter

A structure that emits data sourced from [bitcoincore_rpc::Client].

Traits

BitcoindRpcErrorExt

Extends [bitcoincore_rpc::Error].

\ No newline at end of file +

Re-exports

pub use bitcoincore_rpc;

Structs

Emitter

The Emitter is used to emit data sourced from [bitcoincore_rpc::Client].

Traits

BitcoindRpcErrorExt

Extends [bitcoincore_rpc::Error].

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/sidebar-items.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/sidebar-items.js index 92fe49950d..37c38906e2 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/sidebar-items.js +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/sidebar-items.js @@ -1 +1 @@ -window.SIDEBAR_ITEMS = {"struct":[["Emitter","A structure that emits data sourced from [`bitcoincore_rpc::Client`]."]],"trait":[["BitcoindRpcErrorExt","Extends [`bitcoincore_rpc::Error`]."]]}; \ No newline at end of file +window.SIDEBAR_ITEMS = {"struct":[["Emitter","The [`Emitter`] is used to emit data sourced from [`bitcoincore_rpc::Client`]."]],"trait":[["BitcoindRpcErrorExt","Extends [`bitcoincore_rpc::Error`]."]]}; \ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/struct.Emitter.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/struct.Emitter.html index f73836f4af..ea481561db 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/struct.Emitter.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/struct.Emitter.html @@ -1,4 +1,4 @@ -Emitter in bdk_bitcoind_rpc - Rust

Struct bdk_bitcoind_rpc::Emitter

source Â·

pub struct Emitter<'c, C> { /* private fields */ }

Expand description

A structure that emits data sourced from [bitcoincore_rpc::Client].

+Emitter in bdk_bitcoind_rpc - Rust

Struct bdk_bitcoind_rpc::Emitter

source Â·

pub struct Emitter<'c, C> { /* private fields */ }

Expand description

The Emitter is used to emit data sourced from [bitcoincore_rpc::Client].

Refer to module-level documentation for more.

ImplementationsÂ§

impl<'c, C: RpcApi> Emitter<'c, C>

ConfirmationTimeHeightAnchor

pub fn new(client: &'c C, last_cp: CheckPoint, start_height: u32) -> Self

Construct a new Emitter with the given RPC client, last_cp and start_height.

COINBASE_MATURITY in bdk_chain - Rust

Constant bdk_chain::COINBASE_MATURITY

source Â·

pub const COINBASE_MATURITY: u32 = 100;

Expand description

How many confirmations are needed f or a coinbase output to be spent.

+COINBASE_MATURITY in bdk_chain - Rust

Constant bdk_chain::COINBASE_MATURITY

source Â·

pub const COINBASE_MATURITY: u32 = 100;

Expand description

How many confirmations are needed f or a coinbase output to be spent.

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/index.html index 930cfb14db..1bcaeaacfb 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/index.html @@ -1,4 +1,4 @@ -bdk_chain - Rust

Crate bdk_chain

source Â·

Expand description

This crate is a collection of core structures for Bitcoin Dev Kit (alpha release).

+bdk_chain - Rust

Crate bdk_chain

source Â·

Expand description

This crate is a collection of core structures for Bitcoin Dev Kit (alpha release).

The goal of this crate is to give wallets the mechanisms needed to:

Figure out what data they need to fetch.

bdk_chain

Error-free APIs.
Data persistence agnostic â bdk_chain does not care where you cache on-chain data, what you -cache or how you fetch it.

Re-exports

pub extern crate serde_crate as serde;

pub use bitcoin;

pub use indexed_tx_graph::IndexedTxGraph;

pub use tx_graph::TxGraph;

pub use miniscript;

Modules

indexed_tx_graph

Contains the IndexedTxGraph structure and associated types.

keychain

Module for keychain related structures.

local_chain

The LocalChain is a local implementation of ChainOracle.

tx_graph

Module for structures that store and traverse transactions.

Structs

BlockId

A reference to a block in the canonical chain.

ConfirmationHeightAnchor

An Anchor implementation that also records the exact confirmation height of the transaction.

An Anchor implementation that also records the exact confirmation time and height of the +

Re-exports

pub extern crate serde_crate as serde;

pub use bitcoin;

pub use indexed_tx_graph::IndexedTxGraph;

pub use tx_graph::TxGraph;

pub use miniscript;

Modules

indexed_tx_graph

Contains the IndexedTxGraph and associated types. Refer to the +IndexedTxGraph documentation for more.

keychain

Module for keychain related structures.

local_chain

The LocalChain is a local implementation of ChainOracle.

tx_graph

Module for structures that store and traverse transactions.

Structs

BlockId

A reference to a block in the canonical chain.

ConfirmationHeightAnchor

An Anchor implementation that also records the exact confirmation height of the transaction.

ConfirmationTimeHeightAnchor

An Anchor implementation that also records the exact confirmation time and height of the transaction.

FullTxOut

A TxOut with as much data as we can retrieve about it

Persist

Persist wraps a PersistBackend (B) to create a convenient staging area for changes (C) before they are persisted.

SpkIterator

An iterator for derived script pubkeys.

SpkTxOutIndex

An index storing TxOuts that have a script pubkey that matches those in a list.

Enums

ChainPosition

Represents the observed position of some chain data.

ConfirmationTime

Block height and timestamp at which a transaction is confirmed.

Constants

BIP32_MAX_INDEX

Maximum BIP32 derivation index.

COINBASE_MATURITY

How many confirmations are needed f or a coinbase output to be spent.

Traits

Anchor

Trait that âanchorsâ blockchain data to a specific block of height and hash.

AnchorFromBlockPosition

An Anchor that can be constructed from a given block, block height and transaction position within the block.

Append

Trait that makes an object appendable.

ChainOracle

Represents a service that tracks the blockchain.

DescriptorExt

A trait to extend the functionality of a miniscript descriptor.

PersistBackend

A persistence backend for Persist.

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/index.html index 5add11263e..52a512dfa2 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/index.html @@ -1,3 +1,3 @@ -bdk_chain::indexed_tx_graph - Rust

Module bdk_chain::indexed_tx_graph

source Â·

Expand description

Contains the IndexedTxGraph structure and associated types.

This is essentially a TxGraph combined with an indexer.

Structs

ChangeSet

A structure that represents changes to an IndexedTxGraph.

IndexedTxGraph

A struct that combines TxGraph and an Indexer implementation.

Traits

Indexer

Utilities for indexing transaction data.

\ No newline at end of file +bdk_chain::indexed_tx_graph - Rust

Module bdk_chain::indexed_tx_graph

source Â·

Expand description

Contains the IndexedTxGraph and associated types. Refer to the +IndexedTxGraph documentation for more.

Structs

ChangeSet

Represents changes to an IndexedTxGraph.

IndexedTxGraph

The IndexedTxGraph combines a TxGraph and an Indexer implementation.

Traits

Indexer

Utilities for indexing transaction data.

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/sidebar-items.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/sidebar-items.js index 781f324bba..8c785945b0 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/sidebar-items.js +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/sidebar-items.js @@ -1 +1 @@ -window.SIDEBAR_ITEMS = {"struct":[["ChangeSet","A structure that represents changes to an [`IndexedTxGraph`]."],["IndexedTxGraph","A struct that combines [`TxGraph`] and an [`Indexer`] implementation."]],"trait":[["Indexer","Utilities for indexing transaction data."]]}; \ No newline at end of file +window.SIDEBAR_ITEMS = {"struct":[["ChangeSet","Represents changes to an [`IndexedTxGraph`]."],["IndexedTxGraph","The [`IndexedTxGraph`] combines a [`TxGraph`] and an [`Indexer`] implementation."]],"trait":[["Indexer","Utilities for indexing transaction data."]]}; \ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/struct.ChangeSet.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/struct.ChangeSet.html index 28f3ed08d9..393bc610e5 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/struct.ChangeSet.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/struct.ChangeSet.html @@ -1,12 +1,12 @@ -ChangeSet in bdk_chain::indexed_tx_graph - Rust

Struct bdk_chain::indexed_tx_graph::ChangeSet

source Â·

pub struct ChangeSet<A, IA> {
+ChangeSet in bdk_chain::indexed_tx_graph - Rust
ChangeSet
Fields
graph
indexer
Trait Implementations
Append
Clone
Debug
Default
Deserialize<'de>
From<ChangeSet<A>>
From<ChangeSet<K>>
PartialEq<ChangeSet<A, IA>>
Serialize
StructuralPartialEq
Auto Trait Implementations
RefUnwindSafe
Send
Sync
Unpin
UnwindSafe
Blanket Implementations
Any
Borrow<T>
BorrowMut<T>
DeserializeOwned
From<T>
Into<U>
ToOwned
TryFrom<U>
TryInto<U>
VZip<V>
In bdk_chain::indexed_tx_graph?
Struct bdk_chain::indexed_tx_graph::ChangeSet
source Â· 
pub struct ChangeSet<A, IA> {
     pub graph: ChangeSet<A>,
     pub indexer: IA,
-}Expand descriptionA structure that represents changes to an IndexedTxGraph.
+}

Expand description

Represents changes to an IndexedTxGraph.

FieldsÂ§

Â§graph: ChangeSet<A>

TxGraph changeset.

Â§indexer: IA

Indexer changeset.

Trait ImplementationsÂ§

impl<A: Anchor, IA: Append> Append for ChangeSet<A, IA>

fn append(&mut self, other: Self)

Append another object of the same type onto self.

fn is_empty(&self) -> bool

Returns whether the structure is considered empty.

impl<A: Clone, IA: Clone> Clone for ChangeSet<A, IA>

fn clone(&self) -> ChangeSet<A, IA>

Returns a copy of the value. Read more

1.0.0 Â· sourceÂ§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl<A: Debug, IA: Debug> Debug for ChangeSet<A, IA>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<A, IA: Default> Default for ChangeSet<A, IA>

fn default() -> Self

Returns the âdefault valueâ for a type. Read more

impl<'de, A, IA> Deserialize<'de> for ChangeSet<A, IA>where
A: Ord + Deserialize<'de>,
IA: Deserialize<'de>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl<A, IA: Default> From<ChangeSet<A>> for ChangeSet<A, IA>

fn from(graph: ChangeSet<A>) -> Self

Converts to this type from the input type.

impl<A, K> From<ChangeSet<K>> for ChangeSet<A, ChangeSet<K>>

fn from(indexer: ChangeSet<K>) -> Self

Converts to this type from the input type.

impl<A: PartialEq, IA: PartialEq> PartialEq<ChangeSet<A, IA>> for ChangeSet<A, IA>

fn eq(&self, other: &ChangeSet<A, IA>) -> bool

This method tests for self and other values to be equal, and is used +

Trait ImplementationsÂ§

impl<A: Anchor, IA: Append> Append for ChangeSet<A, IA>

fn append(&mut self, other: Self)

Append another object of the same type onto self.

fn is_empty(&self) -> bool

Returns whether the structure is considered empty.

impl<A: Clone, IA: Clone> Clone for ChangeSet<A, IA>

fn clone(&self) -> ChangeSet<A, IA>

Returns a copy of the value. Read more

1.0.0 Â· sourceÂ§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl<A: Debug, IA: Debug> Debug for ChangeSet<A, IA>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<A, IA: Default> Default for ChangeSet<A, IA>

fn default() -> Self

Returns the âdefault valueâ for a type. Read more

impl<'de, A, IA> Deserialize<'de> for ChangeSet<A, IA>where
A: Ord + Deserialize<'de>,
IA: Deserialize<'de>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl<A, IA: Default> From<ChangeSet<A>> for ChangeSet<A, IA>

fn from(graph: ChangeSet<A>) -> Self

Converts to this type from the input type.

impl<A, K> From<ChangeSet<K>> for ChangeSet<A, ChangeSet<K>>

fn from(indexer: ChangeSet<K>) -> Self

Converts to this type from the input type.

impl<A: PartialEq, IA: PartialEq> PartialEq<ChangeSet<A, IA>> for ChangeSet<A, IA>

fn eq(&self, other: &ChangeSet<A, IA>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 Â· sourceÂ§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason. Read more

impl<A, IA> Serialize for ChangeSet<A, IA>where
A: Ord + Serialize,
IA: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl<A, IA> StructuralPartialEq for ChangeSet<A, IA>

Auto Trait ImplementationsÂ§

impl<A, IA> RefUnwindSafe for ChangeSet<A, IA>where
A: RefUnwindSafe,
IA: RefUnwindSafe,

impl<A, IA> Send for ChangeSet<A, IA>where
A: Send,
IA: Send,

impl<A, IA> Sync for ChangeSet<A, IA>where
A: Sync,
IA: Sync,

impl<A, IA> Unpin for ChangeSet<A, IA>where
IA: Unpin,

impl<A, IA> UnwindSafe for ChangeSet<A, IA>where
A: RefUnwindSafe,
IA: UnwindSafe,

Blanket ImplementationsÂ§

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable Â· sourceÂ§

fn from(t: T) -> T

Returns the argument unchanged.

+sufficient, and should not be overridden without very good reason. Read more

impl<A, IA> Serialize for ChangeSet<A, IA>where
A: Ord + Serialize,
IA: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl<A, IA> StructuralPartialEq for ChangeSet<A, IA>

Auto Trait ImplementationsÂ§

impl<A, IA> RefUnwindSafe for ChangeSet<A, IA>where
A: RefUnwindSafe,
IA: RefUnwindSafe,

impl<A, IA> Send for ChangeSet<A, IA>where
A: Send,
IA: Send,

impl<A, IA> Sync for ChangeSet<A, IA>where
A: Sync,
IA: Sync,

impl<A, IA> Unpin for ChangeSet<A, IA>where
IA: Unpin,

impl<A, IA> UnwindSafe for ChangeSet<A, IA>where
A: RefUnwindSafe,
IA: UnwindSafe,

Blanket ImplementationsÂ§

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable Â· sourceÂ§

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable Â· sourceÂ§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/struct.IndexedTxGraph.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/struct.IndexedTxGraph.html index b6713c7201..668caa9ca5 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/struct.IndexedTxGraph.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/struct.IndexedTxGraph.html @@ -1,47 +1,47 @@ -IndexedTxGraph in bdk_chain::indexed_tx_graph - Rust

Struct bdk_chain::indexed_tx_graph::IndexedTxGraph

source Â·

pub struct IndexedTxGraph<A, I> {
+IndexedTxGraph in bdk_chain::indexed_tx_graph - Rust
IndexedTxGraph
Fields
index
Methods
apply_block
apply_block_relevant
apply_changeset
apply_update
batch_insert_relevant
batch_insert_relevant_unconfirmed
batch_insert_unconfirmed
graph
initial_changeset
insert_anchor
insert_seen_at
insert_tx
insert_txout
new
Trait Implementations
Debug
Default
Auto Trait Implementations
RefUnwindSafe
Send
Sync
Unpin
UnwindSafe
Blanket Implementations
Any
Borrow<T>
BorrowMut<T>
From<T>
Into<U>
TryFrom<U>
TryInto<U>
VZip<V>
In bdk_chain::indexed_tx_graph?
Struct bdk_chain::indexed_tx_graph::IndexedTxGraph
source Â· 
pub struct IndexedTxGraph<A, I> {
     pub index: I,
     /* private fields */
-}Expand descriptionA struct that combines TxGraph and an Indexer implementation.
-This structure ensures that TxGraph and Indexer are updated atomically.
+}

Expand description

The IndexedTxGraph combines a TxGraph and an Indexer implementation.

It ensures that TxGraph and Indexer are updated atomically.

FieldsÂ§

Â§index: I

Transaction index.

ImplementationsÂ§

impl<A, I> IndexedTxGraph<A, I>

pub fn new(index: I) -> Self

Construct a new IndexedTxGraph with a given index.

pub fn graph(&self) -> &TxGraph<A>

Get a reference of the internal transaction graph.

impl<A: Anchor, I: Indexer> IndexedTxGraph<A, I>

pub fn apply_changeset(&mut self, changeset: ChangeSet<A, I::ChangeSet>)

Applies the ChangeSet to the IndexedTxGraph.

pub fn initial_changeset(&self) -> ChangeSet<A, I::ChangeSet>

Determines the ChangeSet between self and an empty IndexedTxGraph.

impl<A: Anchor, I: Indexer> IndexedTxGraph<A, I>where
I::ChangeSet: Default + Append,

pub fn apply_update(&mut self, update: TxGraph<A>) -> ChangeSet<A, I::ChangeSet>

Apply an update directly.

ImplementationsÂ§

impl<A, I> IndexedTxGraph<A, I>

pub fn new(index: I) -> Self

Construct a new IndexedTxGraph with a given index.

pub fn graph(&self) -> &TxGraph<A>

Get a reference of the internal transaction graph.

impl<A: Anchor, I: Indexer> IndexedTxGraph<A, I>

pub fn apply_changeset(&mut self, changeset: ChangeSet<A, I::ChangeSet>)

Applies the ChangeSet to the IndexedTxGraph.

pub fn initial_changeset(&self) -> ChangeSet<A, I::ChangeSet>

Determines the ChangeSet between self and an empty IndexedTxGraph.

impl<A: Anchor, I: Indexer> IndexedTxGraph<A, I>where
I::ChangeSet: Default + Append,

pub fn apply_update(&mut self, update: TxGraph<A>) -> ChangeSet<A, I::ChangeSet>

Apply an update directly.

update is a TxGraph<A> and the resultant changes is returned as ChangeSet.

pub fn insert_txout(
    &mut self,
    outpoint: OutPoint,
    txout: TxOut
) -> ChangeSet<A, I::ChangeSet>

Insert a floating txout of given outpoint.

pub fn insert_tx(&mut self, tx: Transaction) -> ChangeSet<A, I::ChangeSet>

Insert and index a transaction into the graph.

pub fn insert_anchor(
    &mut self,
    txid: Txid,
    anchor: A
) -> ChangeSet<A, I::ChangeSet>

Insert an anchor for a given transaction.

pub fn insert_seen_at(
    &mut self,
    txid: Txid,
    seen_at: u64
) -> ChangeSet<A, I::ChangeSet>

Insert a unix timestamp of when a transaction is seen in the mempool.

pub fn insert_txout(
    &mut self,
    outpoint: OutPoint,
    txout: TxOut
) -> ChangeSet<A, I::ChangeSet>

Insert a floating txout of given outpoint.

pub fn insert_tx(&mut self, tx: Transaction) -> ChangeSet<A, I::ChangeSet>

Insert and index a transaction into the graph.

pub fn insert_anchor(
    &mut self,
    txid: Txid,
    anchor: A
) -> ChangeSet<A, I::ChangeSet>

Insert an anchor for a given transaction.

pub fn insert_seen_at(
    &mut self,
    txid: Txid,
    seen_at: u64
) -> ChangeSet<A, I::ChangeSet>

Insert a unix timestamp of when a transaction is seen in the mempool.

This is used for transaction conflict resolution in TxGraph where the transaction with the later last-seen is prioritized.

pub fn batch_insert_relevant<'t>(
&mut self,
txs: impl IntoIterator<Item = (&'t Transaction, impl IntoIterator<Item = A>)>
) -> ChangeSet<A, I::ChangeSet>

Batch insert transactions, filtering out those that are irrelevant.

pub fn batch_insert_relevant<'t>(
&mut self,
txs: impl IntoIterator<Item = (&'t Transaction, impl IntoIterator<Item = A>)>
) -> ChangeSet<A, I::ChangeSet>

Batch insert transactions, filtering out those that are irrelevant.

Relevancy is determined by the Indexer::is_tx_relevant implementation of I. Irrelevant transactions in txs will be ignored. txs do not need to be in topological order.

pub fn batch_insert_relevant_unconfirmed<'t>(
&mut self,
unconfirmed_txs: impl IntoIterator<Item = (&'t Transaction, u64)>
) -> ChangeSet<A, I::ChangeSet>

Batch insert unconfirmed transactions, filtering out those that are irrelevant.

pub fn batch_insert_relevant_unconfirmed<'t>(
&mut self,
unconfirmed_txs: impl IntoIterator<Item = (&'t Transaction, u64)>
) -> ChangeSet<A, I::ChangeSet>

Batch insert unconfirmed transactions, filtering out those that are irrelevant.

Relevancy is determined by the internal Indexer::is_tx_relevant implementation of I. Irrelevant transactions in txs will be ignored.

Items of txs are tuples containing the transaction and a last seen timestamp. The last seen communicates when the transaction is last seen in the mempool which is used for conflict-resolution in TxGraph (refer to TxGraph::insert_seen_at for details).

pub fn batch_insert_unconfirmed(
&mut self,
txs: impl IntoIterator<Item = (Transaction, u64)>
) -> ChangeSet<A, I::ChangeSet>

Batch insert unconfirmed transactions.

pub fn batch_insert_unconfirmed(
&mut self,
txs: impl IntoIterator<Item = (Transaction, u64)>
) -> ChangeSet<A, I::ChangeSet>

Batch insert unconfirmed transactions.

To filter out irrelevant transactions, use batch_insert_relevant_unconfirmed instead.

impl<A, I: Indexer> IndexedTxGraph<A, I>where
I::ChangeSet: Default + Append,
A: AnchorFromBlockPosition + Anchor,

Methods are available if the anchor (A) implements AnchorFromBlockPosition.

pub fn apply_block_relevant(
    &mut self,
    block: Block,
    height: u32
) -> ChangeSet<A, I::ChangeSet>

Batch insert all transactions of the given block of height, filtering out those that are +

impl<A, I: Indexer> IndexedTxGraph<A, I>where
I::ChangeSet: Default + Append,
A: AnchorFromBlockPosition + Anchor,

Methods are available if the anchor (A) implements AnchorFromBlockPosition.

pub fn apply_block_relevant(
    &mut self,
    block: Block,
    height: u32
) -> ChangeSet<A, I::ChangeSet>

Batch insert all transactions of the given block of height, filtering out those that are irrelevant.

Each inserted transactionâs anchor will be constructed from AnchorFromBlockPosition::from_block_position.

Relevancy is determined by the internal Indexer::is_tx_relevant implementation of I. Irrelevant transactions in txs will be ignored.

pub fn apply_block(
    &mut self,
    block: Block,
    height: u32
) -> ChangeSet<A, I::ChangeSet>

Batch insert all transactions of the given block of height.

pub fn apply_block(
    &mut self,
    block: Block,
    height: u32
) -> ChangeSet<A, I::ChangeSet>

Batch insert all transactions of the given block of height.

Each inserted transactionâs anchor will be constructed from AnchorFromBlockPosition::from_block_position.

To only insert relevant transactions, use apply_block_relevant instead.

Trait ImplementationsÂ§

impl<A: Debug, I: Debug> Debug for IndexedTxGraph<A, I>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<A, I: Default> Default for IndexedTxGraph<A, I>

fn default() -> Self

Returns the âdefault valueâ for a type. Read more

Auto Trait ImplementationsÂ§

impl<A, I> RefUnwindSafe for IndexedTxGraph<A, I>where
A: RefUnwindSafe,
I: RefUnwindSafe,

impl<A, I> Send for IndexedTxGraph<A, I>where
A: Send,
I: Send,

impl<A, I> Sync for IndexedTxGraph<A, I>where
A: Sync,
I: Sync,

impl<A, I> Unpin for IndexedTxGraph<A, I>where
I: Unpin,

impl<A, I> UnwindSafe for IndexedTxGraph<A, I>where
A: RefUnwindSafe,
I: UnwindSafe,

Blanket ImplementationsÂ§

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable Â· sourceÂ§

fn from(t: T) -> T

Returns the argument unchanged.

Trait ImplementationsÂ§

impl<A: Debug, I: Debug> Debug for IndexedTxGraph<A, I>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<A, I: Default> Default for IndexedTxGraph<A, I>

fn default() -> Self

Returns the âdefault valueâ for a type. Read more

Auto Trait ImplementationsÂ§

impl<A, I> RefUnwindSafe for IndexedTxGraph<A, I>where
A: RefUnwindSafe,
I: RefUnwindSafe,

impl<A, I> Send for IndexedTxGraph<A, I>where
A: Send,
I: Send,

impl<A, I> Sync for IndexedTxGraph<A, I>where
A: Sync,
I: Sync,

impl<A, I> Unpin for IndexedTxGraph<A, I>where
I: Unpin,

impl<A, I> UnwindSafe for IndexedTxGraph<A, I>where
A: RefUnwindSafe,
I: UnwindSafe,

Blanket ImplementationsÂ§

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable Â· sourceÂ§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable Â· sourceÂ§

fn from(t: T) -> T

Returns the argument unchanged.