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 8e4806b3ec..61ea08d810 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.
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 miniscript;

Modules

chain_graph

Module for structures that combine the features of sparse_chain and tx_graph.

indexed_tx_graph

keychain

Module for keychain related structures.

local_chain

sparse_chain

Module for structures that maintain sparse (purposely incomplete) snapshots of blockchain data.

tx_graph

Module for structures that store and traverse transactions.

Structs

BlockId

A reference to a block in the canonical chain.

FullTxOut

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

SpkTxOutIndex

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

Enums

ConfirmationTime

Block height and timestamp at which a transaction is confirmed.

ObservedAs

Represents an observation of some chain data.

TxHeight

Represents the height at which a transaction is confirmed.

Constants

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.

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.

ForEachTxOut

Trait to do something with every txout contained in a structure.

\ No newline at end of file +

Re-exports

pub extern crate serde_crate as serde;

pub use bitcoin;

pub use miniscript;

Modules

chain_graph

Module for structures that combine the features of sparse_chain and tx_graph.

indexed_tx_graph

keychain

Module for keychain related structures.

local_chain

sparse_chain

Module for structures that maintain sparse (purposely incomplete) snapshots of blockchain data.

tx_graph

Module for structures that store and traverse transactions.

Structs

BlockId

A reference to a block in the canonical chain.

FullTxOut

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

SpkIterator

An iterator for derived script pubkeys.

SpkTxOutIndex

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

Enums

ConfirmationTime

Block height and timestamp at which a transaction is confirmed.

ObservedAs

Represents an observation of some chain data.

TxHeight

Represents the height 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.

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.

ForEachTxOut

Trait to do something with every txout contained in a structure.

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/trait.Indexer.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/trait.Indexer.html index 3016904dba..423be50a9f 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/trait.Indexer.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/indexed_tx_graph/trait.Indexer.html @@ -11,4 +11,4 @@

source

fn index_tx(&mut self, tx: &Transaction) -> Self::Additions

Scan and index the given transaction.

source

fn apply_additions(&mut self, additions: Self::Additions)

Apply additions to itself.

source

fn is_tx_relevant(&self, tx: &Transaction) -> bool

Determines whether the transaction should be included in the index.

ImplementorsÂ§

source Â§

type Additions = DerivationAdditions<K>

ImplementorsÂ§

Required MethodsÂ§

ImplementorsÂ§

Module bdk_chain::keychain

source Â·

Expand description

Module for keychain related structures.

+bdk_chain::keychain - Rust

Module bdk_chain::keychain

source Â·

Expand description

Module for keychain related structures.

A keychain here is a set of application-defined indexes for a miniscript descriptor where we can derive script pubkeys at a particular derivation index. The applicationâs index is simply anything that implements Ord.

@@ -10,4 +10,4 @@ changes between both these structures. KeychainTracker and changes made on a KeychainTracker are reported by KeychainChangeSets.

Re-exports

pub use persist::*;

Modules

persist

Persistence for changes made to a KeychainTracker.

Structs

Balance

Balance, differentiated into various categories.

DerivationAdditions

Represents updates to the derivation index of a KeychainTxOutIndex.

KeychainChangeSet

Represents changes to a KeychainTracker.

KeychainScan

An update that includes the last active indexes of each keychain.

KeychainTracker

A convenient combination of a KeychainTxOutIndex and a ChainGraph.

KeychainTxOutIndex

A convenient wrapper around SpkTxOutIndex that relates script pubkeys to miniscript public -Descriptors.

Constants

BIP32_MAX_INDEX

Maximum BIP32 derivation index.

\ No newline at end of file +Descriptors.

Struct bdk_chain::keychain::KeychainTxOutIndex

source Â·

pub struct KeychainTxOutIndex<K> { /* private fields */ }

Expand description

A convenient wrapper around SpkTxOutIndex that relates script pubkeys to miniscript public +KeychainTxOutIndex in bdk_chain::keychain - Rust

Struct bdk_chain::keychain::KeychainTxOutIndex

source Â·

pub struct KeychainTxOutIndex<K> { /* private fields */ }

Expand description

A convenient wrapper around SpkTxOutIndex that relates script pubkeys to miniscript public Descriptors.

Descriptors are referenced by the provided keychain generic (K).

Script pubkeys for a descriptor are revealed chronologically from index 0. I.e., If the last @@ -27,7 +27,7 @@ txout_index.add_keychain(MyKeychain::Internal, internal_descriptor); txout_index.add_keychain(MyKeychain::MyAppUser { user_id: 42 }, descriptor_for_user_42); let new_spk_for_user = txout_index.reveal_next_spk(&MyKeychain::MyAppUser{ user_id: 42 });

ImplementationsÂ§

source Â§

impl<K: Clone + Ord + Debug> KeychainTxOutIndex<K>

source

pub fn scan(&mut self, txouts: &impl ForEachTxOut) -> DerivationAdditions<K>

Scans an object for relevant outpoints, which are stored and indexed internally.

ImplementationsÂ§

source Â§

impl<K: Clone + Ord + Debug> KeychainTxOutIndex<K>

source

pub fn scan(&mut self, txouts: &impl ForEachTxOut) -> DerivationAdditions<K>

Scans an object for relevant outpoints, which are stored and indexed internally.

If the matched script pubkey is part of the lookahead, the last stored index is updated for the script pubkeyâs keychain and the DerivationAdditions returned will reflect the change.

@@ -39,35 +39,35 @@ your txouts. your chain state (i.e., SparseChain, ChainGraph).

See ForEachTxout for the types that support this.

source

pub fn scan_txout(
 &mut self,
 op: OutPoint,
 txout: &TxOut
) -> DerivationAdditions<K>

Scan a single outpoint for a matching script pubkey.

source

pub fn scan_txout(
 &mut self,
 op: OutPoint,
 txout: &TxOut
) -> DerivationAdditions<K>

Scan a single outpoint for a matching script pubkey.

If it matches, this will store and index it.

source

pub fn inner(&self) -> &SpkTxOutIndex<(K, u32)>

Return a reference to the internal SpkTxOutIndex.

source

pub fn keychains(&self) -> &BTreeMap<K, Descriptor<DescriptorPublicKey>>

Return a reference to the internal map of the keychain to descriptors.

source

pub fn add_keychain(
 &mut self,
 keychain: K,
 descriptor: Descriptor<DescriptorPublicKey>
)

Add a keychain to the trackerâs txout_index with a descriptor to derive addresses.

source

pub fn inner(&self) -> &SpkTxOutIndex<(K, u32)>

Return a reference to the internal SpkTxOutIndex.

source

pub fn keychains(&self) -> &BTreeMap<K, Descriptor<DescriptorPublicKey>>

Return a reference to the internal map of the keychain to descriptors.

source

pub fn add_keychain(
 &mut self,
 keychain: K,
 descriptor: Descriptor<DescriptorPublicKey>
)

Add a keychain to the trackerâs txout_index with a descriptor to derive addresses.

Adding a keychain means you will be able to derive new script pubkeys under that keychain and the txout index will discover transaction outputs with those script pubkeys.

Panics

This will panic if a different descriptor is introduced to the same keychain.

source

pub fn lookaheads(&self) -> &BTreeMap<K, u32>

Return the lookahead setting for each keychain.

source

pub fn lookaheads(&self) -> &BTreeMap<K, u32>

Return the lookahead setting for each keychain.

Refer to set_lookahead for a deeper explanation of the lookahead.

source

pub fn set_lookahead_for_all(&mut self, lookahead: u32)

Convenience method to call set_lookahead for all keychains.

source

pub fn set_lookahead(&mut self, keychain: &K, lookahead: u32)

Set the lookahead count for keychain.

source

pub fn set_lookahead_for_all(&mut self, lookahead: u32)

Convenience method to call set_lookahead for all keychains.

source

pub fn set_lookahead(&mut self, keychain: &K, lookahead: u32)

Set the lookahead count for keychain.

The lookahead is the number of scripts to cache ahead of the last stored script index. This is useful during a scan via scan or scan_txout.

Panics

This will panic if the keychain does not exist.

source

pub fn lookahead_to_target_multi(&mut self, target_indexes: BTreeMap<K, u32>)

Convenience method to call lookahead_to_target for multiple keychains.

source

pub fn lookahead_to_target(&mut self, keychain: &K, target_index: u32)

Store lookahead scripts until target_index.

source

pub fn lookahead_to_target_multi(&mut self, target_indexes: BTreeMap<K, u32>)

Convenience method to call lookahead_to_target for multiple keychains.

source

pub fn lookahead_to_target(&mut self, keychain: &K, target_index: u32)

Store lookahead scripts until target_index.

This does not change the lookahead setting.

source

pub fn spks_of_all_keychains(
&self
) -> BTreeMap<K, impl Iterator<Item = (u32, Script)> + Clone>

Generates script pubkey iterators for every keychain. The iterators iterate over all +

source

pub fn spks_of_all_keychains(
&self
) -> BTreeMap<K, SpkIterator<Descriptor<DescriptorPublicKey>>>

Generates script pubkey iterators for every keychain. The iterators iterate over all derivable script pubkeys.

source

pub fn spks_of_keychain(
&self,
keychain: &K
) -> impl Iterator<Item = (u32, Script)> + Clone

Generates a script pubkey iterator for the given keychainâs descriptor (if it exists). The +

source

pub fn spks_of_keychain(
&self,
keychain: &K
) -> SpkIterator<Descriptor<DescriptorPublicKey>> â

Generates a script pubkey iterator for the given keychainâs descriptor (if it exists). The iterator iterates over all derivable scripts of the keychainâs descriptor.

Panics

This will panic if the keychain does not exist.

source

pub fn revealed_spks_of_all_keychains(
&self
) -> BTreeMap<K, impl Iterator<Item = (u32, &Script)> + Clone>

Convenience method to get revealed_spks_of_keychain of all keychains.

source

pub fn revealed_spks_of_keychain(
&self,
keychain: &K
) -> impl DoubleEndedIterator<Item = (u32, &Script)> + Clone

Iterates over the script pubkeys revealed by this index under keychain.

source

pub fn next_index(&self, keychain: &K) -> (u32, bool)

Get the next derivation index for keychain. The next index is the index after the last revealed +

source

pub fn revealed_spks_of_all_keychains(
&self
) -> BTreeMap<K, impl Iterator<Item = (u32, &Script)> + Clone>

Convenience method to get revealed_spks_of_keychain of all keychains.

source

pub fn revealed_spks_of_keychain(
&self,
keychain: &K
) -> impl DoubleEndedIterator<Item = (u32, &Script)> + Clone

Iterates over the script pubkeys revealed by this index under keychain.

source

pub fn next_index(&self, keychain: &K) -> (u32, bool)

Get the next derivation index for keychain. The next index is the index after the last revealed derivation index.

The second field in the returned tuple represents whether the next derivation index is new. There are two scenarios where the next derivation index is reused (not new):

@@ -78,11 +78,11 @@ There are two scenarios where the next derivation index is reused (not new):

Not checking the second field of the tuple may result in address reuse.

Panics

Panics if the keychain does not exist.

source

pub fn last_revealed_indices(&self) -> &BTreeMap<K, u32>

Get the last derivation index that is revealed for each keychain.

source

pub fn last_revealed_indices(&self) -> &BTreeMap<K, u32>

Get the last derivation index that is revealed for each keychain.

Keychains with no revealed indices will not be included in the returned BTreeMap.

source

pub fn last_revealed_index(&self, keychain: &K) -> Option<u32>

Get the last derivation index revealed for keychain.

source

pub fn reveal_to_target_multi(
&mut self,
keychains: &BTreeMap<K, u32>
) -> (BTreeMap<K, impl Iterator<Item = (u32, Script)>>, DerivationAdditions<K>)

Convenience method to call Self::reveal_to_target on multiple keychains.

source

pub fn reveal_to_target(
 &mut self,
 keychain: &K,
 target_index: u32
) -> (impl Iterator<Item = (u32, Script)>, DerivationAdditions<K>)

Reveals script pubkeys of the keychainâs descriptor up to and including the +

source

pub fn last_revealed_index(&self, keychain: &K) -> Option<u32>

Get the last derivation index revealed for keychain.

source

pub fn reveal_to_target_multi(
&mut self,
keychains: &BTreeMap<K, u32>
) -> (BTreeMap<K, SpkIterator<Descriptor<DescriptorPublicKey>>>, DerivationAdditions<K>)

Convenience method to call Self::reveal_to_target on multiple keychains.

source

pub fn reveal_to_target(
 &mut self,
 keychain: &K,
 target_index: u32
) -> (SpkIterator<Descriptor<DescriptorPublicKey>>, DerivationAdditions<K>)

Reveals script pubkeys of the keychainâs descriptor up to and including the target_index.

If the target_index cannot be reached (due to the descriptor having no wildcard and/or the target_index is in the hardened index range), this method will make a best-effort and @@ -92,7 +92,7 @@ reveal up to the last possible index.

pubkeys are revealed, then both of these will be empty.

Panics

Panics if keychain does not exist.

source

pub fn reveal_next_spk(
&mut self,
keychain: &K
) -> ((u32, &Script), DerivationAdditions<K>)

Attempts to reveal the next script pubkey for keychain.

source

pub fn reveal_next_spk(
&mut self,
keychain: &K
) -> ((u32, &Script), DerivationAdditions<K>)

Attempts to reveal the next script pubkey for keychain.

Returns the derivation index of the revealed script pubkey, the revealed script pubkey and a DerivationAdditions which represents changes in the last revealed index (if any).

When a new script cannot be revealed, we return the last revealed script and an empty @@ -103,7 +103,7 @@ pubkeys are revealed, then both of these will be empty.

Panics

Panics if the keychain does not exist.

source

pub fn next_unused_spk(
&mut self,
keychain: &K
) -> ((u32, &Script), DerivationAdditions<K>)

Gets the next unused script pubkey in the keychain. I.e., the script pubkey with the lowest +

source

pub fn next_unused_spk(
&mut self,
keychain: &K
) -> ((u32, &Script), DerivationAdditions<K>)

Gets the next unused script pubkey in the keychain. I.e., the script pubkey with the lowest index that has not been used yet.

This will derive and reveal a new script pubkey if no more unused script pubkeys exist.

If the descriptor has no wildcard and already has a used script pubkey or if a descriptor @@ -111,24 +111,24 @@ has used all scripts up to the derivation bounds, then the last derived script p returned.

Panics

Panics if keychain has never been added to the index

source

pub fn mark_used(&mut self, keychain: &K, index: u32) -> bool

Marks the script pubkey at index as used even though the tracker hasnât seen an output with it. +

source

pub fn mark_used(&mut self, keychain: &K, index: u32) -> bool

Marks the script pubkey at index as used even though the tracker hasnât seen an output with it. This only has an effect when the index had been added to self already and was unused.

Returns whether the index was initially present as unused.

This is useful when you want to reserve a script pubkey for something but donât want to add the transaction output using it to the index yet. Other callers will consider index on keychain used until you call unmark_used.

source

pub fn unmark_used(&mut self, keychain: &K, index: u32) -> bool

Undoes the effect of mark_used. Returns whether the index is inserted back into +

source

pub fn unmark_used(&mut self, keychain: &K, index: u32) -> bool

Undoes the effect of mark_used. Returns whether the index is inserted back into unused.

Note that if self has scanned an output with this script pubkey, then this will have no effect.

source

pub fn unused_spks_of_keychain(
&self,
keychain: &K
) -> impl DoubleEndedIterator<Item = (u32, &Script)>

Iterates over all unused script pubkeys for a keychain stored in the index.

source

pub fn txouts_of_keychain(
&self,
keychain: &K
) -> impl DoubleEndedIterator<Item = (u32, OutPoint)> + '_

Iterates over all the [OutPoint] that have a TxOut with a script pubkey derived from +

source

pub fn unused_spks_of_keychain(
&self,
keychain: &K
) -> impl DoubleEndedIterator<Item = (u32, &Script)>

Iterates over all unused script pubkeys for a keychain stored in the index.

source

pub fn txouts_of_keychain(
&self,
keychain: &K
) -> impl DoubleEndedIterator<Item = (u32, OutPoint)> + '_

Iterates over all the [OutPoint] that have a TxOut with a script pubkey derived from keychain.

source

pub fn last_used_index(&self, keychain: &K) -> Option<u32>

Returns the highest derivation index of the keychain where KeychainTxOutIndex has +

source

pub fn last_used_index(&self, keychain: &K) -> Option<u32>

Returns the highest derivation index of the keychain where KeychainTxOutIndex has found a [TxOut] with itâs script pubkey.

source

pub fn last_used_indices(&self) -> BTreeMap<K, u32>

Returns the highest derivation index of each keychain that KeychainTxOutIndex has found +

source

pub fn last_used_indices(&self) -> BTreeMap<K, u32>

Returns the highest derivation index of each keychain that KeychainTxOutIndex has found a [TxOut] with itâs script pubkey.

source

pub fn apply_additions(&mut self, additions: DerivationAdditions<K>)

Applies the derivation additions to the KeychainTxOutIndex, extending the number of +

source

pub fn apply_additions(&mut self, additions: DerivationAdditions<K>)

Applies the derivation additions to the KeychainTxOutIndex, extending the number of derived scripts per keychain, as specified in the additions.

Methods from Deref<Target = SpkTxOutIndex<(K, u32)>>Â§

source

pub fn txouts(
&self
) -> impl DoubleEndedIterator<Item = (&I, OutPoint, &TxOut)> + ExactSizeIterator

Iterate over all known txouts that spend to tracked script pubkeys.

source

pub fn txouts_in_tx(
&self,
txid: Txid
) -> impl DoubleEndedIterator<Item = (&I, OutPoint, &TxOut)>

Finds all txouts on a transaction that has previously been scanned and indexed.

@@ -167,8 +167,8 @@ matches one of our script pubkeys.

have scanned the TxOuts the transaction is spending. For example, if you want to filter out all the transactions in a block that are irrelevant, you must first scan all the transactions in the block and only then use this method.

Trait ImplementationsÂ§

source Â§

impl<K: Clone> Clone for KeychainTxOutIndex<K>

source Â§

fn clone(&self) -> KeychainTxOutIndex<K>

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

source Â§

impl<K: Debug> Debug for KeychainTxOutIndex<K>

source Â§

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

Formats the value using the given formatter. Read more

source Â§

impl<K> Default for KeychainTxOutIndex<K>

source Â§

fn default() -> Self

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

source Â§

impl<K> Deref for KeychainTxOutIndex<K>

Â§

type Target = SpkTxOutIndex<(K, u32)>

The resulting type after dereferencing.

source Â§

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

Dereferences the value.

source Â§

impl<K: Clone + Ord + Debug + 'static> Indexer for KeychainTxOutIndex<K>

Â§

type Additions = DerivationAdditions<K>

The resultant âadditionsâ when new transaction data is indexed.

source Â§

fn index_txout(&mut self, outpoint: OutPoint, txout: &TxOut) -> Self::Additions

Scan and index the given outpoint and txout.

source Â§

fn index_tx(&mut self, tx: &Transaction) -> Self::Additions

Scan and index the given transaction.

source Â§

fn apply_additions(&mut self, additions: Self::Additions)

Apply additions to itself.

source Â§

fn is_tx_relevant(&self, tx: &Transaction) -> bool

Determines whether the transaction should be included in the index.

source Â§

impl<K: Clone + Ord + Debug + 'static> OwnedIndexer for KeychainTxOutIndex<K>

source Â§

fn is_spk_owned(&self, spk: &Script) -> bool

Determines whether a given script pubkey (spk) is owned.

Auto Trait ImplementationsÂ§

Â§

impl<K> RefUnwindSafe for KeychainTxOutIndex<K>where
K: RefUnwindSafe,

Â§

impl<K> Send for KeychainTxOutIndex<K>where
K: Send,

Â§

impl<K> Sync for KeychainTxOutIndex<K>where
K: Sync,

Â§

impl<K> Unpin for KeychainTxOutIndex<K>where
K: Unpin,

Â§

impl<K> UnwindSafe for KeychainTxOutIndex<K>where
K: UnwindSafe + RefUnwindSafe,

Blanket ImplementationsÂ§

source Â§

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

source Â§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source Â§

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

const: unstable Â· sourceÂ§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source Â§

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

source Â§

impl<T> From<T> for T

const: unstable Â· sourceÂ§

fn from(t: T) -> T

Returns the argument unchanged.

Trait ImplementationsÂ§

source Â§

impl<K: Clone> Clone for KeychainTxOutIndex<K>

source Â§

fn clone(&self) -> KeychainTxOutIndex<K>

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

source Â§

impl<K: Debug> Debug for KeychainTxOutIndex<K>

source Â§

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

Formats the value using the given formatter. Read more

source Â§

impl<K> Default for KeychainTxOutIndex<K>

source Â§

fn default() -> Self

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

source Â§

impl<K> Deref for KeychainTxOutIndex<K>

Â§

type Target = SpkTxOutIndex<(K, u32)>

The resulting type after dereferencing.

source Â§

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

Dereferences the value.

source Â§

impl<K: Clone + Ord + Debug + 'static> Indexer for KeychainTxOutIndex<K>

Â§

type Additions = DerivationAdditions<K>

The resultant âadditionsâ when new transaction data is indexed.

source Â§

fn index_txout(&mut self, outpoint: OutPoint, txout: &TxOut) -> Self::Additions

Scan and index the given outpoint and txout.

source Â§

fn index_tx(&mut self, tx: &Transaction) -> Self::Additions

Scan and index the given transaction.

source Â§

fn apply_additions(&mut self, additions: Self::Additions)

Apply additions to itself.

source Â§

fn is_tx_relevant(&self, tx: &Transaction) -> bool

Determines whether the transaction should be included in the index.

source Â§

impl<K: Clone + Ord + Debug + 'static> OwnedIndexer for KeychainTxOutIndex<K>

source Â§

fn is_spk_owned(&self, spk: &Script) -> bool

Determines whether a given script pubkey (spk) is owned.

Auto Trait ImplementationsÂ§

Â§

impl<K> RefUnwindSafe for KeychainTxOutIndex<K>where
K: RefUnwindSafe,

Â§

impl<K> Send for KeychainTxOutIndex<K>where
K: Send,

Â§

impl<K> Sync for KeychainTxOutIndex<K>where
K: Sync,

Â§

impl<K> Unpin for KeychainTxOutIndex<K>where
K: Unpin,

Â§

impl<K> UnwindSafe for KeychainTxOutIndex<K>where
K: UnwindSafe + RefUnwindSafe,

Blanket ImplementationsÂ§

source Â§

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

source Â§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source Â§

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

const: unstable Â· sourceÂ§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source Â§

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

source Â§

impl<T> From<T> for T

const: unstable Â· sourceÂ§

fn from(t: T) -> T

Returns the argument unchanged.

source Â§

impl<T, U> Into 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.

source Â§

impl<T> ToOwned for Twhere
T: Clone,

Â§

type Owned = T

The resulting type after obtaining ownership.

source Â§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source Â§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source Â§

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

Â§

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable Â· sourceÂ§

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source Â§

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

Â§

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable Â· sourceÂ§

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Â§

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

Â§

fn vzip(self) -> V

Struct bdk_chain::SpkIterator

source Â·

pub struct SpkIterator<D> { /* private fields */ }

Expand description

An iterator for derived script pubkeys.

SpkIterator is an implementation of the Iterator trait which possesses its own next() +and nth() functions, both of which circumvent the unnecessary intermediate derivations required +when using their default implementations.

Examples

use bdk_chain::SpkIterator;
+
+// Creates a new script pubkey iterator starting at 0 from a descriptor.
+let mut spk_iter = SpkIterator::new(&descriptor);
+assert_eq!(spk_iter.next(), Some((0, external_spk_0)));
+assert_eq!(spk_iter.next(), None);

ImplementationsÂ§

source Â§

impl<D> SpkIterator<D>where
D: Borrow<Descriptor<DescriptorPublicKey>>,

source

pub fn new(descriptor: D) -> Self

Creates a new script pubkey iterator starting at 0 from a descriptor.

Trait ImplementationsÂ§

source Â§

impl<D: Clone> Clone for SpkIterator<D>

source Â§

fn clone(&self) -> SpkIterator<D> â

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

source Â§

impl<D> Iterator for SpkIterator<D>where
D: Borrow<Descriptor<DescriptorPublicKey>>,

Â§

type Item = (u32, Script)

The type of the elements being iterated over.

source Â§

fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value. Read more

source Â§

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator. Read more

source Â§

fn next_chunk<const N: usize>(
&mut self
) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where
Self: Sized,

ð¬This is a nightly-only experimental API. (iter_next_chunk)

Advances the iterator and returns an array containing the next N values. Read more

1.0.0 Â· sourceÂ§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator. Read more

1.0.0 Â· sourceÂ§

fn count(self) -> usizewhere
Self: Sized,

Consumes the iterator, counting the number of iterations and returning it. Read more

1.0.0 Â· sourceÂ§

fn last(self) -> Option<Self::Item>where
Self: Sized,

Consumes the iterator, returning the last element. Read more

source Â§

fn advance_by(&mut self, n: usize) -> Result<(), usize>

ð¬This is a nightly-only experimental API. (iter_advance_by)

Advances the iterator by n elements. Read more

1.28.0 Â· sourceÂ§

fn step_by(self, step: usize) -> StepBy<Self>where
Self: Sized,

Creates an iterator starting at the same point, but stepping by +the given amount at each iteration. Read more

1.0.0 Â· sourceÂ§

fn chain(self, other: U) -> Chain<Self, ::IntoIter>where
Self: Sized,
U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new iterator over both in sequence. Read more

1.0.0 Â· sourceÂ§

fn zip(self, other: U) -> Zip<Self, ::IntoIter>where
Self: Sized,
U: IntoIterator,

âZips upâ two iterators into a single iterator of pairs. Read more

source Â§

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>where
Self: Sized,
G: FnMut() -> Self::Item,

ð¬This is a nightly-only experimental API. (iter_intersperse)

Creates a new iterator which places an item generated by separator +between adjacent items of the original iterator. Read more

1.0.0 Â· sourceÂ§

fn map<B, F>(self, f: F) -> Map<Self, F>where
Self: Sized,
F: FnMut(Self::Item) -> B,

Takes a closure and creates an iterator which calls that closure on each +element. Read more

1.21.0 Â· sourceÂ§

fn for_each<F>(self, f: F)where
Self: Sized,
F: FnMut(Self::Item),

Calls a closure on each element of an iterator. Read more

1.0.0 Â· sourceÂ§

fn filter(self, predicate: P) -> Filter<Self, P>where
Self: Sized,
P: FnMut(&Self::Item) -> bool,

Creates an iterator which uses a closure to determine if an element +should be yielded. Read more

1.0.0 Â· sourceÂ§

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>where
Self: Sized,
F: FnMut(Self::Item) -> Option,

Creates an iterator that both filters and maps. Read more

1.0.0 Â· sourceÂ§

fn enumerate(self) -> Enumerate<Self>where
Self: Sized,

Creates an iterator which gives the current iteration count as well as +the next value. Read more

1.0.0 Â· sourceÂ§

fn peekable(self) -> Peekable<Self>where
Self: Sized,

Creates an iterator which can use the peek and peek_mut methods +to look at the next element of the iterator without consuming it. See +their documentation for more information. Read more

1.0.0 Â· sourceÂ§

fn skip_while(self, predicate: P) -> SkipWhile<Self, P>where
Self: Sized,
P: FnMut(&Self::Item) -> bool,

Creates an iterator that skips elements based on a predicate. Read more

1.0.0 Â· sourceÂ§

fn take_while(self, predicate: P) -> TakeWhile<Self, P>where
Self: Sized,
P: FnMut(&Self::Item) -> bool,

Creates an iterator that yields elements based on a predicate. Read more

1.57.0 Â· sourceÂ§

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>where
Self: Sized,
P: FnMut(Self::Item) -> Option,

Creates an iterator that both yields elements based on a predicate and maps. Read more

1.0.0 Â· sourceÂ§

fn skip(self, n: usize) -> Skip<Self>where
Self: Sized,

Creates an iterator that skips the first n elements. Read more

1.0.0 Â· sourceÂ§

fn take(self, n: usize) -> Take<Self>where
Self: Sized,

Creates an iterator that yields the first n elements, or fewer +if the underlying iterator ends sooner. Read more

1.0.0 Â· sourceÂ§

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>where
Self: Sized,
F: FnMut(&mut St, Self::Item) -> Option,

An iterator adapter similar to fold that holds internal state and +produces a new iterator. Read more

1.0.0 Â· sourceÂ§

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>where
 Self: Sized,
 U: IntoIterator,
 F: FnMut(Self::Item) -> U,

Creates an iterator that works like map, but flattens nested structure. Read more

1.0.0 Â· sourceÂ§

fn fuse(self) -> Fuse<Self>where
Self: Sized,

Creates an iterator which ends after the first None. Read more

1.0.0 Â· sourceÂ§

fn inspect<F>(self, f: F) -> Inspect<Self, F>where
Self: Sized,
F: FnMut(&Self::Item),

Does something with each element of an iterator, passing the value on. Read more

1.0.0 Â· sourceÂ§

fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,

Borrows an iterator, rather than consuming it. Read more

1.0.0 Â· sourceÂ§

fn collect(self) -> Bwhere
B: FromIterator<Self::Item>,
Self: Sized,

Transforms an iterator into a collection. Read more

source Â§

fn collect_into<E>(self, collection: &mut E) -> &mut Ewhere
E: Extend<Self::Item>,
Self: Sized,

ð¬This is a nightly-only experimental API. (iter_collect_into)

Collects all the items from an iterator into a collection. Read more

1.0.0 Â· sourceÂ§

fn partition<B, F>(self, f: F) -> (B, B)where
 Self: Sized,
 B: Default + Extend<Self::Item>,
 F: FnMut(&Self::Item) -> bool,

Consumes an iterator, creating two collections from it. Read more

source Â§

fn is_partitioned(self, predicate: P) -> boolwhere
Self: Sized,
P: FnMut(Self::Item) -> bool,

ð¬This is a nightly-only experimental API. (iter_is_partitioned)

Checks if the elements of this iterator are partitioned according to the given predicate, +such that all those that return true precede all those that return false. Read more

1.27.0 Â· sourceÂ§

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> Rwhere
 Self: Sized,
 F: FnMut(B, Self::Item) -> R,
 R: Try<Output = B>,

An iterator method that applies a function as long as it returns +successfully, producing a single, final value. Read more

1.27.0 Â· sourceÂ§

fn try_for_each<F, R>(&mut self, f: F) -> Rwhere
 Self: Sized,
 F: FnMut(Self::Item) -> R,
 R: Try<Output = ()>,

An iterator method that applies a fallible function to each item in the +iterator, stopping at the first error and returning that error. Read more

1.0.0 Â· sourceÂ§

fn fold<B, F>(self, init: B, f: F) -> Bwhere
Self: Sized,
F: FnMut(B, Self::Item) -> B,

Folds every element into an accumulator by applying an operation, +returning the final result. Read more

1.51.0 Â· sourceÂ§

fn reduce<F>(self, f: F) -> Option<Self::Item>where
Self: Sized,
F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing +operation. Read more

source Â§

fn try_reduce<F, R>(
 &mut self,
 f: F
) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryTypewhere
 Self: Sized,
 F: FnMut(Self::Item, Self::Item) -> R,
 R: Try<Output = Self::Item>,
 <R as Try>::Residual: Residual<Option<Self::Item>>,

ð¬This is a nightly-only experimental API. (iterator_try_reduce)

Reduces the elements to a single one by repeatedly applying a reducing operation. If the +closure returns a failure, the failure is propagated back to the caller immediately. Read more

1.0.0 Â· sourceÂ§

fn all<F>(&mut self, f: F) -> boolwhere
Self: Sized,
F: FnMut(Self::Item) -> bool,

Tests if every element of the iterator matches a predicate. Read more

1.0.0 Â· sourceÂ§

fn any<F>(&mut self, f: F) -> boolwhere
Self: Sized,
F: FnMut(Self::Item) -> bool,

Tests if any element of the iterator matches a predicate. Read more

1.0.0 Â· sourceÂ§

fn find(&mut self, predicate: P) -> Option<Self::Item>where
Self: Sized,
P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator that satisfies a predicate. Read more

1.30.0 Â· sourceÂ§

fn find_map<B, F>(&mut self, f: F) -> Optionwhere
Self: Sized,
F: FnMut(Self::Item) -> Option,

Applies function to the elements of iterator and returns +the first non-none result. Read more

source Â§

fn try_find<F, R>(
 &mut self,
 f: F
) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryTypewhere
 Self: Sized,
 F: FnMut(&Self::Item) -> R,
 R: Try<Output = bool>,
 <R as Try>::Residual: Residual<Option<Self::Item>>,

ð¬This is a nightly-only experimental API. (try_find)

Applies function to the elements of iterator and returns +the first true result or the first error. Read more

1.0.0 Â· sourceÂ§

fn position(&mut self, predicate: P) -> Option<usize>where
Self: Sized,
P: FnMut(Self::Item) -> bool,

Searches for an element in an iterator, returning its index. Read more

1.6.0 Â· sourceÂ§

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>where
 B: Ord,
 Self: Sized,
 F: FnMut(&Self::Item) -> B,

Returns the element that gives the maximum value from the +specified function. Read more

1.15.0 Â· sourceÂ§

fn max_by<F>(self, compare: F) -> Option<Self::Item>where
Self: Sized,
F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the maximum value with respect to the +specified comparison function. Read more

1.6.0 Â· sourceÂ§

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>where
 B: Ord,
 Self: Sized,
 F: FnMut(&Self::Item) -> B,

Returns the element that gives the minimum value from the +specified function. Read more

1.15.0 Â· sourceÂ§

fn min_by<F>(self, compare: F) -> Option<Self::Item>where
Self: Sized,
F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the minimum value with respect to the +specified comparison function. Read more

1.0.0 Â· sourceÂ§

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)where
 FromA: Default + Extend<A>,
 FromB: Default + Extend,
 Self: Sized + Iterator<Item = (A, B)>,

Converts an iterator of pairs into a pair of containers. Read more

1.36.0 Â· sourceÂ§

fn copied<'a, T>(self) -> Copied<Self>where
T: 'a + Copy,
Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which copies all of its elements. Read more

1.0.0 Â· sourceÂ§

fn cloned<'a, T>(self) -> Cloned<Self>where
T: 'a + Clone,
Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which clones all of its elements. Read more

source Â§

fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>where
Self: Sized,

ð¬This is a nightly-only experimental API. (iter_array_chunks)

Returns an iterator over N elements of the iterator at a time. Read more

1.11.0 Â· sourceÂ§

fn sum<S>(self) -> Swhere
Self: Sized,
S: Sum<Self::Item>,

Sums the elements of an iterator. Read more

1.11.0 Â· sourceÂ§

fn product(self) -> Pwhere
Self: Sized,
P: Product<Self::Item>,

Iterates over the entire iterator, multiplying all the elements Read more

source Â§

fn cmp_by<I, F>(self, other: I, cmp: F) -> Orderingwhere
 Self: Sized,
 I: IntoIterator,
 F: FnMut(Self::Item, ::Item) -> Ordering,

ð¬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those +of another with respect to the specified comparison function. Read more

1.5.0 Â· sourceÂ§

fn partial_cmp(self, other: I) -> Option<Ordering>where
 I: IntoIterator,
 Self::Item: PartialOrd<::Item>,
 Self: Sized,

Lexicographically compares the elements of this Iterator with those +of another. Read more

source Â§

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>where
 Self: Sized,
 I: IntoIterator,
 F: FnMut(Self::Item, ::Item) -> Option<Ordering>,

ð¬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those +of another with respect to the specified comparison function. Read more

1.5.0 Â· sourceÂ§

fn eq(self, other: I) -> boolwhere
 I: IntoIterator,
 Self::Item: PartialEq<::Item>,
 Self: Sized,

Determines if the elements of this Iterator are equal to those of +another. Read more

source Â§

fn eq_by<I, F>(self, other: I, eq: F) -> boolwhere
 Self: Sized,
 I: IntoIterator,
 F: FnMut(Self::Item, ::Item) -> bool,

ð¬This is a nightly-only experimental API. (iter_order_by)

Determines if the elements of this Iterator are equal to those of +another with respect to the specified equality function. Read more

1.5.0 Â· sourceÂ§

fn ne(self, other: I) -> boolwhere
 I: IntoIterator,
 Self::Item: PartialEq<::Item>,
 Self: Sized,

Determines if the elements of this Iterator are unequal to those of +another. Read more

1.5.0 Â· sourceÂ§

fn lt(self, other: I) -> boolwhere
 I: IntoIterator,
 Self::Item: PartialOrd<::Item>,
 Self: Sized,

Determines if the elements of this Iterator are lexicographically +less than those of another. Read more

1.5.0 Â· sourceÂ§

fn le(self, other: I) -> boolwhere
 I: IntoIterator,
 Self::Item: PartialOrd<::Item>,
 Self: Sized,

Determines if the elements of this Iterator are lexicographically +less or equal to those of another. Read more

1.5.0 Â· sourceÂ§

fn gt(self, other: I) -> boolwhere
 I: IntoIterator,
 Self::Item: PartialOrd<::Item>,
 Self: Sized,

Determines if the elements of this Iterator are lexicographically +greater than those of another. Read more

1.5.0 Â· sourceÂ§

fn ge(self, other: I) -> boolwhere
 I: IntoIterator,
 Self::Item: PartialOrd<::Item>,
 Self: Sized,

Determines if the elements of this Iterator are lexicographically +greater than or equal to those of another. Read more

source Â§

fn is_sorted_by<F>(self, compare: F) -> boolwhere
Self: Sized,
F: FnMut(&Self::Item, &Self::Item) -> Option<Ordering>,

ð¬This is a nightly-only experimental API. (is_sorted)

Checks if the elements of this iterator are sorted using the given comparator function. Read more

source Â§

fn is_sorted_by_key<F, K>(self, f: F) -> boolwhere
 Self: Sized,
 F: FnMut(Self::Item) -> K,
 K: PartialOrd<K>,

ð¬This is a nightly-only experimental API. (is_sorted)

Checks if the elements of this iterator are sorted using the given key extraction +function. Read more

Auto Trait ImplementationsÂ§

Â§

impl<D> RefUnwindSafe for SpkIterator<D>where
D: RefUnwindSafe,

Â§

impl<D> Send for SpkIterator<D>where
D: Send,

Â§

impl<D> Sync for SpkIterator<D>where
D: Sync,

Â§

impl<D> Unpin for SpkIterator<D>where
D: Unpin,

Â§

impl<D> UnwindSafe for SpkIterator<D>where
D: UnwindSafe,

Blanket ImplementationsÂ§

source Â§

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

source Â§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source Â§

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

const: unstable Â· sourceÂ§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source Â§

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

source Â§

impl<T> From<T> for T

const: unstable Â· sourceÂ§

fn from(t: T) -> T

Returns the argument unchanged.

source Â§

impl<T, U> Into 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.

source Â§

impl IntoIterator for Iwhere
I: Iterator,

Â§

type Item = ::Item

The type of the elements being iterated over.

Â§

type IntoIter = I

Which kind of iterator are we turning this into?

const: unstable Â· sourceÂ§

fn into_iter(self) -> I

Creates an iterator from a value. Read more

source Â§

impl IteratorRandom for Iwhere
I: Iterator,

source Â§

fn choose<R>(self, rng: &mut R) -> Option<Self::Item>where
R: Rng + ?Sized,

Choose one element at random from the iterator. Read more

source Â§

fn choose_stable<R>(self, rng: &mut R) -> Option<Self::Item>where
R: Rng + ?Sized,

Choose one element at random from the iterator. Read more

source Â§

fn choose_multiple_fill<R>(self, rng: &mut R, buf: &mut [Self::Item]) -> usizewhere
R: Rng + ?Sized,

Collects values at random from the iterator into a supplied buffer +until that buffer is filled. Read more

source Â§

fn choose_multiple<R>(self, rng: &mut R, amount: usize) -> Vec<Self::Item, Global>where
R: Rng + ?Sized,

Collects amount values at random from the iterator into a vector. Read more

source Â§

impl<T> ToOwned for Twhere
T: Clone,

Â§

type Owned = T

The resulting type after obtaining ownership.

source Â§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source Â§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source Â§

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

Â§

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable Â· sourceÂ§

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source Â§

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

Â§

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable Â· sourceÂ§

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Â§

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

Â§

fn vzip(self) -> V

use crate::{ collections::*, indexed_tx_graph::{Indexer, OwnedIndexer}, miniscript::{Descriptor, DescriptorPublicKey}, - ForEachTxOut, SpkTxOutIndex, + spk_iter::BIP32_MAX_INDEX, + ForEachTxOut, SpkIterator, SpkTxOutIndex, }; -use alloc::{borrow::Cow, vec::Vec}; -use bitcoin::{secp256k1::Secp256k1, OutPoint, Script, TxOut}; +use alloc::vec::Vec; +use bitcoin::{OutPoint, Script, TxOut}; use core::{fmt::Debug, ops::Deref}; use crate::Append; use super::DerivationAdditions; -/// Maximum [BIP32](https://bips.xyz/32) derivation index. -pub const BIP32_MAX_INDEX: u32 = (1 << 31) - 1; - /// A convenient wrapper around [`SpkTxOutIndex`] that relates script pubkeys to miniscript public /// [`Descriptor`]s. /// @@ -862,10 +827,9 @@ let next_reveal_index = self.last_revealed.get(keychain).map_or(0, |v| *v + 1); let lookahead = self.lookahead.get(keychain).map_or(0, |v| *v); - for (new_index, new_spk) in range_descriptor_spks( - Cow::Borrowed(descriptor), - next_store_index..next_reveal_index + lookahead, - ) { + for (new_index, new_spk) in + SpkIterator::new_with_range(descriptor, next_store_index..next_reveal_index + lookahead) + { let _inserted = self .inner .insert_spk((keychain.clone(), new_index), new_spk); @@ -885,13 +849,13 @@ /// derivable script pubkeys. pub fn spks_of_all_keychains( &self, - ) -> BTreeMap<K, impl Iterator<Item = (u32, Script)> + Clone> { + ) -> BTreeMap<K, SpkIterator<Descriptor<DescriptorPublicKey>>> { self.keychains .iter() .map(|(keychain, descriptor)| { ( keychain.clone(), - range_descriptor_spks(Cow::Owned(descriptor.clone()), 0..), + SpkIterator::new_with_range(descriptor.clone(), 0..), ) }) .collect() @@ -903,13 +867,13 @@ /// # Panics /// /// This will panic if the `keychain` does not exist. - pub fn spks_of_keychain(&self, keychain: &K) -> impl Iterator<Item = (u32, Script)> + Clone { + pub fn spks_of_keychain(&self, keychain: &K) -> SpkIterator<Descriptor<DescriptorPublicKey>> { let descriptor = self .keychains .get(keychain) .expect("keychain must exist") .clone(); - range_descriptor_spks(Cow::Owned(descriptor), 0..) + SpkIterator::new_with_range(descriptor, 0..) } /// Convenience method to get [`revealed_spks_of_keychain`] of all keychains. @@ -989,7 +953,7 @@ &mut self, keychains: &BTreeMap<K, u32>, ) -> ( - BTreeMap<K, impl Iterator<Item = (u32, Script)>>, + BTreeMap<K, SpkIterator<Descriptor<DescriptorPublicKey>>>, DerivationAdditions<K>, ) { let mut additions = DerivationAdditions::default(); @@ -999,7 +963,7 @@ let (new_spks, new_additions) = self.reveal_to_target(keychain, index); if !new_additions.is_empty() { spks.insert(keychain.clone(), new_spks); - additions.append(new_additions); + additions.append(new_additions.clone()); } } @@ -1024,7 +988,10 @@ &mut self, keychain: &K, target_index: u32, - ) -> (impl Iterator<Item = (u32, Script)>, DerivationAdditions<K>) { + ) -> ( + SpkIterator<Descriptor<DescriptorPublicKey>>, + DerivationAdditions<K>, + ) { let descriptor = self.keychains.get(keychain).expect("keychain must exist"); let has_wildcard = descriptor.has_wildcard(); @@ -1049,7 +1016,7 @@ // we range over indexes that are not stored let range = next_reveal_index + lookahead..=target_index + lookahead; - for (new_index, new_spk) in range_descriptor_spks(Cow::Borrowed(descriptor), range) { + for (new_index, new_spk) in SpkIterator::new_with_range(descriptor, range) { let _inserted = self .inner .insert_spk((keychain.clone(), new_index), new_spk); @@ -1066,16 +1033,13 @@ let _old_index = self.last_revealed.insert(keychain.clone(), index); debug_assert!(_old_index < Some(index)); ( - range_descriptor_spks( - Cow::Owned(descriptor.clone()), - next_reveal_index..index + 1, - ), + SpkIterator::new_with_range(descriptor.clone(), next_reveal_index..index + 1), DerivationAdditions(core::iter::once((keychain.clone(), index)).collect()), ) } None => ( - range_descriptor_spks( - Cow::Owned(descriptor.clone()), + SpkIterator::new_with_range( + descriptor.clone(), next_reveal_index..next_reveal_index, ), DerivationAdditions::default(), @@ -1206,35 +1170,5 @@ let _ = self.reveal_to_target_multi(&additions.0); } } - -fn range_descriptor_spks<'a, R>( - descriptor: Cow<'a, Descriptor<DescriptorPublicKey>>, - range: R, -) -> impl Iterator<Item = (u32, Script)> + Clone + Send + 'a -where - R: Iterator<Item = u32> + Clone + Send + 'a, -{ - let secp = Secp256k1::verification_only(); - let has_wildcard = descriptor.has_wildcard(); - range - .into_iter() - // non-wildcard descriptors can only have one derivation index (0) - .take_while(move |&index| has_wildcard || index == 0) - // we can only iterate over non-hardened indices - .take_while(|&index| index <= BIP32_MAX_INDEX) - .map( - move |index| -> Result<_, miniscript::descriptor::ConversionError> { - Ok(( - index, - descriptor - .at_derivation_index(index) - .derived_descriptor(&secp)? - .script_pubkey(), - )) - }, - ) - .take_while(Result::is_ok) - .map(Result::unwrap) -}

//! 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: @@ -136,6 +140,10 @@ mod descriptor_ext; #[cfg(feature = "miniscript")] pub use descriptor_ext::DescriptorExt; +#[cfg(feature = "miniscript")] +mod spk_iter; +#[cfg(feature = "miniscript")] +pub use spk_iter::*; #[allow(unused_imports)] #[macro_use] diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_chain/spk_iter.rs.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_chain/spk_iter.rs.html new file mode 100644 index 0000000000..e40c964bac --- /dev/null +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_chain/spk_iter.rs.html @@ -0,0 +1,432 @@ +spk_iter.rs - source ? 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 + use crate::{ + bitcoin::{secp256k1::Secp256k1, Script}, + miniscript::{Descriptor, DescriptorPublicKey}, +}; +use core::{borrow::Borrow, ops::Bound, ops::RangeBounds}; + +/// Maximum [BIP32](https://bips.xyz/32) derivation index. +pub const BIP32_MAX_INDEX: u32 = (1 << 31) - 1; + +/// An iterator for derived script pubkeys. +/// +/// [`SpkIterator`] is an implementation of the [`Iterator`] trait which possesses its own `next()` +/// and `nth()` functions, both of which circumvent the unnecessary intermediate derivations required +/// when using their default implementations. +/// +/// ## Examples +/// +/// ``` +/// use bdk_chain::SpkIterator; +/// # use miniscript::{Descriptor, DescriptorPublicKey}; +/// # use bitcoin::{secp256k1::Secp256k1}; +/// # use std::str::FromStr; +/// # let secp = bitcoin::secp256k1::Secp256k1::signing_only(); +/// # let (descriptor, _) = Descriptor::<DescriptorPublicKey>::parse_descriptor(&secp, "wpkh([73c5da0a/86'/0'/0']xprv9xgqHN7yz9MwCkxsBPN5qetuNdQSUttZNKw1dcYTV4mkaAFiBVGQziHs3NRSWMkCzvgjEe3n9xV8oYywvM8at9yRqyaZVz6TYYhX98VjsUk/1/0)").unwrap(); +/// # let external_spk_0 = descriptor.at_derivation_index(0).script_pubkey(); +/// # let external_spk_3 = descriptor.at_derivation_index(3).script_pubkey(); +/// # let external_spk_4 = descriptor.at_derivation_index(4).script_pubkey(); +/// +/// // Creates a new script pubkey iterator starting at 0 from a descriptor. +/// let mut spk_iter = SpkIterator::new(&descriptor); +/// assert_eq!(spk_iter.next(), Some((0, external_spk_0))); +/// assert_eq!(spk_iter.next(), None); +/// ``` +#[derive(Clone)] +pub struct SpkIterator<D> { + next_index: u32, + end: u32, + descriptor: D, + secp: Secp256k1<bitcoin::secp256k1::VerifyOnly>, +} + +impl<D> SpkIterator<D> +where + D: Borrow<Descriptor<DescriptorPublicKey>>, +{ + /// Creates a new script pubkey iterator starting at 0 from a descriptor. + pub fn new(descriptor: D) -> Self { + let end = if descriptor.borrow().has_wildcard() { + BIP32_MAX_INDEX + } else { + 0 + }; + + SpkIterator::new_with_range(descriptor, 0..=end) + } + + // Creates a new script pubkey iterator from a descriptor with a given range. + pub(crate) fn new_with_range<R>(descriptor: D, range: R) -> Self + where + R: RangeBounds<u32>, + { + let mut end = match range.end_bound() { + Bound::Included(end) => *end + 1, + Bound::Excluded(end) => *end, + Bound::Unbounded => u32::MAX, + }; + // Because `end` is exclusive, we want the maximum value to be BIP32_MAX_INDEX + 1. + end = end.min(BIP32_MAX_INDEX + 1); + + Self { + next_index: match range.start_bound() { + Bound::Included(start) => *start, + Bound::Excluded(start) => *start + 1, + Bound::Unbounded => u32::MIN, + }, + end, + descriptor, + secp: Secp256k1::verification_only(), + } + } +} + +impl<D> Iterator for SpkIterator<D> +where + D: Borrow<Descriptor<DescriptorPublicKey>>, +{ + type Item = (u32, Script); + + fn next(&mut self) -> Option<Self::Item> { + // For non-wildcard descriptors, we expect the first element to be Some((0, spk)), then None after. + // For wildcard descriptors, we expect it to keep iterating until exhausted. + if self.next_index >= self.end { + return None; + } + + let script = self + .descriptor + .borrow() + .at_derivation_index(self.next_index) + .derived_descriptor(&self.secp) + .expect("the descriptor cannot need hardened derivation") + .script_pubkey(); + let output = (self.next_index, script); + + self.next_index += 1; + + Some(output) + } + + fn nth(&mut self, n: usize) -> Option<Self::Item> { + self.next_index = self + .next_index + .saturating_add(u32::try_from(n).unwrap_or(u32::MAX)); + self.next() + } +} + +#[cfg(test)] +mod test { + use crate::{ + bitcoin::secp256k1::Secp256k1, + keychain::KeychainTxOutIndex, + miniscript::{Descriptor, DescriptorPublicKey}, + spk_iter::{SpkIterator, BIP32_MAX_INDEX}, + }; + + #[derive(Clone, Debug, PartialEq, Eq, Ord, PartialOrd)] + enum TestKeychain { + External, + Internal, + } + + fn init_txout_index() -> ( + KeychainTxOutIndex<TestKeychain>, + Descriptor<DescriptorPublicKey>, + Descriptor<DescriptorPublicKey>, + ) { + let mut txout_index = KeychainTxOutIndex::<TestKeychain>::default(); + + let secp = Secp256k1::signing_only(); + let (external_descriptor,_) = Descriptor::<DescriptorPublicKey>::parse_descriptor(&secp, "tr([73c5da0a/86'/0'/0']xprv9xgqHN7yz9MwCkxsBPN5qetuNdQSUttZNKw1dcYTV4mkaAFiBVGQziHs3NRSWMkCzvgjEe3n9xV8oYywvM8at9yRqyaZVz6TYYhX98VjsUk/0/*)").unwrap(); + let (internal_descriptor,_) = Descriptor::<DescriptorPublicKey>::parse_descriptor(&secp, "tr([73c5da0a/86'/0'/0']xprv9xgqHN7yz9MwCkxsBPN5qetuNdQSUttZNKw1dcYTV4mkaAFiBVGQziHs3NRSWMkCzvgjEe3n9xV8oYywvM8at9yRqyaZVz6TYYhX98VjsUk/1/*)").unwrap(); + + txout_index.add_keychain(TestKeychain::External, external_descriptor.clone()); + txout_index.add_keychain(TestKeychain::Internal, internal_descriptor.clone()); + + (txout_index, external_descriptor, internal_descriptor) + } + + #[test] + #[allow(clippy::iter_nth_zero)] + fn test_spkiterator_wildcard() { + let (_, external_desc, _) = init_txout_index(); + let external_spk_0 = external_desc.at_derivation_index(0).script_pubkey(); + let external_spk_16 = external_desc.at_derivation_index(16).script_pubkey(); + let external_spk_20 = external_desc.at_derivation_index(20).script_pubkey(); + let external_spk_21 = external_desc.at_derivation_index(21).script_pubkey(); + let external_spk_max = external_desc + .at_derivation_index(BIP32_MAX_INDEX) + .script_pubkey(); + + let mut external_spk = SpkIterator::new(&external_desc); + let max_index = BIP32_MAX_INDEX - 22; + + assert_eq!(external_spk.next().unwrap(), (0, external_spk_0)); + assert_eq!(external_spk.nth(15).unwrap(), (16, external_spk_16)); + assert_eq!(external_spk.nth(3).unwrap(), (20, external_spk_20.clone())); + assert_eq!(external_spk.next().unwrap(), (21, external_spk_21)); + assert_eq!( + external_spk.nth(max_index as usize).unwrap(), + (BIP32_MAX_INDEX, external_spk_max) + ); + assert_eq!(external_spk.nth(0), None); + + let mut external_spk = SpkIterator::new_with_range(&external_desc, 0..21); + assert_eq!(external_spk.nth(20).unwrap(), (20, external_spk_20)); + assert_eq!(external_spk.next(), None); + + let mut external_spk = SpkIterator::new_with_range(&external_desc, 0..21); + assert_eq!(external_spk.nth(21), None); + } + + #[test] + #[allow(clippy::iter_nth_zero)] + fn test_spkiterator_non_wildcard() { + let secp = bitcoin::secp256k1::Secp256k1::signing_only(); + let (no_wildcard_descriptor, _) = Descriptor::<DescriptorPublicKey>::parse_descriptor(&secp, "wpkh([73c5da0a/86'/0'/0']xprv9xgqHN7yz9MwCkxsBPN5qetuNdQSUttZNKw1dcYTV4mkaAFiBVGQziHs3NRSWMkCzvgjEe3n9xV8oYywvM8at9yRqyaZVz6TYYhX98VjsUk/1/0)").unwrap(); + let external_spk_0 = no_wildcard_descriptor + .at_derivation_index(0) + .script_pubkey(); + + let mut external_spk = SpkIterator::new(&no_wildcard_descriptor); + + assert_eq!(external_spk.next().unwrap(), (0, external_spk_0.clone())); + assert_eq!(external_spk.next(), None); + + let mut external_spk = SpkIterator::new(&no_wildcard_descriptor); + + assert_eq!(external_spk.nth(0).unwrap(), (0, external_spk_0)); + assert_eq!(external_spk.nth(0), None); + } + + // The following dummy traits were created to test if SpkIterator is working properly. + trait TestSendStatic: Send + 'static { + fn test(&self) -> u32 { + 20 + } + } + + impl TestSendStatic for SpkIterator<Descriptor<DescriptorPublicKey>> { + fn test(&self) -> u32 { + 20 + } + } +} + + \ No newline at end of file

List of all items

Structs

Enums

Traits

Type Definitions

Constants

List of all items

Structs

Enums

Traits

Type Definitions

Constants

Constant bdk_chain::BIP32_MAX_INDEX

Constant bdk_chain::COINBASE_MATURITY

Constant bdk_chain::COINBASE_MATURITY

Crate bdk_chain

Crate bdk_chain

fn index_tx(&mut self, tx: &Transaction) -> Self::Additions

fn apply_additions(&mut self, additions: Self::Additions)

fn is_tx_relevant(&self, tx: &Transaction) -> bool

ImplementorsÂ§

impl<I: Clone + Ord + 'static> Indexer for SpkTxOutIndex<I>

type Additions = ()

impl<K: Clone + Ord + Debug + 'static> Indexer for KeychainTxOutIndex<K>

type Additions = DerivationAdditions<K>

ImplementorsÂ§

impl<I: Clone + Ord + 'static> Indexer for SpkTxOutIndex<I>

type Additions = ()

impl<K: Clone + Ord + Debug + 'static> Indexer for KeychainTxOutIndex<K>

type Additions = DerivationAdditions<K>

Required MethodsÂ§

fn is_spk_owned(&self, spk: &Script) -> bool

ImplementorsÂ§

impl<I: Clone + Ord + 'static> OwnedIndexer for SpkTxOutIndex<I>

impl<K: Clone + Ord + Debug + 'static> OwnedIndexer for KeychainTxOutIndex<K>

ImplementorsÂ§

impl<I: Clone + Ord + 'static> OwnedIndexer for SpkTxOutIndex<I>

impl<K: Clone + Ord + Debug + 'static> OwnedIndexer for KeychainTxOutIndex<K>

Constant bdk_chain::keychain::BIP32_MAX_INDEX

Module bdk_chain::keychain

Module bdk_chain::keychain

Struct bdk_chain::keychain::KeychainTxOutIndex

Struct bdk_chain::keychain::KeychainTxOutIndex

ImplementationsÂ§

impl<K: Clone + Ord + Debug> KeychainTxOutIndex<K>

pub fn scan(&mut self, txouts: &impl ForEachTxOut) -> DerivationAdditions<K>

ImplementationsÂ§

impl<K: Clone + Ord + Debug> KeychainTxOutIndex<K>

pub fn scan(&mut self, txouts: &impl ForEachTxOut) -> DerivationAdditions<K>

pub fn scan_txout( &mut self, op: OutPoint, txout: &TxOut) -> DerivationAdditions<K>

pub fn scan_txout( &mut self, op: OutPoint, txout: &TxOut) -> DerivationAdditions<K>

pub fn inner(&self) -> &SpkTxOutIndex<(K, u32)>

pub fn keychains(&self) -> &BTreeMap<K, Descriptor<DescriptorPublicKey>>

pub fn add_keychain( &mut self, keychain: K, descriptor: Descriptor<DescriptorPublicKey>)

pub fn inner(&self) -> &SpkTxOutIndex<(K, u32)>

pub fn keychains(&self) -> &BTreeMap<K, Descriptor<DescriptorPublicKey>>

pub fn add_keychain( &mut self, keychain: K, descriptor: Descriptor<DescriptorPublicKey>)

pub fn lookaheads(&self) -> &BTreeMap<K, u32>

pub fn lookaheads(&self) -> &BTreeMap<K, u32>

pub fn set_lookahead_for_all(&mut self, lookahead: u32)

pub fn set_lookahead(&mut self, keychain: &K, lookahead: u32)

pub fn set_lookahead_for_all(&mut self, lookahead: u32)

pub fn set_lookahead(&mut self, keychain: &K, lookahead: u32)

pub fn lookahead_to_target_multi(&mut self, target_indexes: BTreeMap<K, u32>)

pub fn lookahead_to_target(&mut self, keychain: &K, target_index: u32)

pub fn lookahead_to_target_multi(&mut self, target_indexes: BTreeMap<K, u32>)

pub fn lookahead_to_target(&mut self, keychain: &K, target_index: u32)

pub fn spks_of_all_keychains( &self) -> BTreeMap<K, impl Iterator<Item = (u32, Script)> + Clone>

pub fn spks_of_all_keychains( &self) -> BTreeMap<K, SpkIterator<Descriptor<DescriptorPublicKey>>>

pub fn spks_of_keychain( &self, keychain: &K) -> impl Iterator<Item = (u32, Script)> + Clone

pub fn spks_of_keychain( &self, keychain: &K) -> SpkIterator<Descriptor<DescriptorPublicKey>> â

pub fn revealed_spks_of_all_keychains( &self) -> BTreeMap<K, impl Iterator<Item = (u32, &Script)> + Clone>

pub fn revealed_spks_of_keychain( &self, keychain: &K) -> impl DoubleEndedIterator<Item = (u32, &Script)> + Clone

pub fn next_index(&self, keychain: &K) -> (u32, bool)

pub fn revealed_spks_of_all_keychains( &self) -> BTreeMap<K, impl Iterator<Item = (u32, &Script)> + Clone>

pub fn revealed_spks_of_keychain( &self, keychain: &K) -> impl DoubleEndedIterator<Item = (u32, &Script)> + Clone

pub fn next_index(&self, keychain: &K) -> (u32, bool)

pub fn last_revealed_indices(&self) -> &BTreeMap<K, u32>

pub fn last_revealed_indices(&self) -> &BTreeMap<K, u32>

pub fn last_revealed_index(&self, keychain: &K) -> Option<u32>

pub fn scan_txout(
&mut self,
op: OutPoint,
txout: &TxOut
) -> DerivationAdditions<K>

pub fn scan_txout(
&mut self,
op: OutPoint,
txout: &TxOut
) -> DerivationAdditions<K>

pub fn add_keychain(
&mut self,
keychain: K,
descriptor: Descriptor<DescriptorPublicKey>
)

pub fn add_keychain(
&mut self,
keychain: K,
descriptor: Descriptor<DescriptorPublicKey>
)

pub fn spks_of_all_keychains(
&self
) -> BTreeMap<K, impl Iterator<Item = (u32, Script)> + Clone>

pub fn spks_of_all_keychains(
&self
) -> BTreeMap<K, SpkIterator<Descriptor<DescriptorPublicKey>>>

pub fn spks_of_keychain(
&self,
keychain: &K
) -> impl Iterator<Item = (u32, Script)> + Clone

pub fn spks_of_keychain(
&self,
keychain: &K
) -> SpkIterator<Descriptor<DescriptorPublicKey>> â

pub fn revealed_spks_of_all_keychains(
&self
) -> BTreeMap<K, impl Iterator<Item = (u32, &Script)> + Clone>

pub fn revealed_spks_of_keychain(
&self,
keychain: &K
) -> impl DoubleEndedIterator<Item = (u32, &Script)> + Clone

pub fn revealed_spks_of_all_keychains(
&self
) -> BTreeMap<K, impl Iterator<Item = (u32, &Script)> + Clone>

pub fn revealed_spks_of_keychain(
&self,
keychain: &K
) -> impl DoubleEndedIterator<Item = (u32, &Script)> + Clone

pub fn reveal_to_target_multi(
&mut self,
keychains: &BTreeMap<K, u32>
) -> (BTreeMap<K, impl Iterator<Item = (u32, Script)>>, DerivationAdditions<K>)

pub fn reveal_to_target(
&mut self,
keychain: &K,
target_index: u32
) -> (impl Iterator<Item = (u32, Script)>, DerivationAdditions<K>)

pub fn reveal_to_target_multi(
&mut self,
keychains: &BTreeMap<K, u32>
) -> (BTreeMap<K, SpkIterator<Descriptor<DescriptorPublicKey>>>, DerivationAdditions<K>)

pub fn reveal_to_target(
&mut self,
keychain: &K,
target_index: u32
) -> (SpkIterator<Descriptor<DescriptorPublicKey>>, DerivationAdditions<K>)

pub fn reveal_next_spk(
&mut self,
keychain: &K
) -> ((u32, &Script), DerivationAdditions<K>)

pub fn reveal_next_spk(
&mut self,
keychain: &K
) -> ((u32, &Script), DerivationAdditions<K>)

pub fn next_unused_spk(
&mut self,
keychain: &K
) -> ((u32, &Script), DerivationAdditions<K>)

pub fn next_unused_spk(
&mut self,
keychain: &K
) -> ((u32, &Script), DerivationAdditions<K>)