Enum bdk_wallet :: ApplyBlockError Copy item path

impl<CS, S> !Freeze for Init<CS, S>

impl<CS, S> RefUnwindSafe for Init<CS, S>

where diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.KeychainTxGraph.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.KeychainTxGraph.html index edb5ad742d..69421bcb1f 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.KeychainTxGraph.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.KeychainTxGraph.html @@ -1,6 +1,6 @@ -KeychainTxGraph in example_cli - Rust

Type Alias example_cli::KeychainTxGraph

source Â·

pub type KeychainTxGraph = IndexedTxGraph<ConfirmationBlockTime, KeychainTxOutIndex<Keychain>>;

Expand description

Alias for a IndexedTxGraph with specific Anchor and Indexer.

+KeychainTxGraph in example_cli - Rust

Type Alias example_cli::KeychainTxGraph

source Â·

pub type KeychainTxGraph = IndexedTxGraph<ConfirmationBlockTime, KeychainTxOutIndex<Keychain>>;

Expand description

Alias for a IndexedTxGraph with specific Anchor and Indexer.

Aliased TypeÂ§

struct KeychainTxGraph {
-    pub index: KeychainTxOutIndex<Keychain>,
+    pub index: KeychainTxOutIndex<Keychain>,
     /* private fields */
-}

FieldsÂ§

Â§index: KeychainTxOutIndex<Keychain>

Transaction index.

FieldsÂ§

Â§index: KeychainTxOutIndex<Keychain>

Transaction index.

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.PlanUtxo.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.PlanUtxo.html index cc88748bfc..575a1c700d 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.PlanUtxo.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/type.PlanUtxo.html @@ -1 +1 @@ -PlanUtxo in example_cli - Rust

Type Alias example_cli::PlanUtxo

source Â·

pub type PlanUtxo = (Plan, FullTxOut<ConfirmationBlockTime>);

\ No newline at end of file +PlanUtxo in example_cli - Rust

Type Alias example_cli::PlanUtxo

source Â·

pub type PlanUtxo = (Plan, FullTxOut<ConfirmationBlockTime>);

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_wallet_rpc/enum.Emission.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_wallet_rpc/enum.Emission.html index b84a18cd3e..c964ee5c8d 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_wallet_rpc/enum.Emission.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_wallet_rpc/enum.Emission.html @@ -1,8 +1,8 @@ Emission in example_wallet_rpc - Rust

Enum example_wallet_rpc::Emission

source Â·

pub(crate) enum Emission {
     SigTerm,
-    Block(BlockEvent<Block>),
+    Block(BlockEvent<Block>),
     Mempool(Vec<(Transaction, u64)>),
-}

VariantsÂ§

SigTerm

Block(BlockEvent<Block>)

Mempool(Vec<(Transaction, u64)>)

Trait ImplementationsÂ§

impl Debug for Emission

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

Formats the value using the given formatter. Read more

Auto Trait ImplementationsÂ§

impl UnwindSafe for Emission

Blanket ImplementationsÂ§

impl<T> Any for T

where +}

VariantsÂ§

SigTerm

Block(BlockEvent<Block>)

Mempool(Vec<(Transaction, u64)>)

Trait ImplementationsÂ§

impl Debug for Emission

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

Formats the value using the given formatter. Read more

Auto Trait ImplementationsÂ§

impl Freeze for Emission

impl RefUnwindSafe for Emission

impl Send for Emission

impl Sync for Emission

impl Unpin for Emission

impl UnwindSafe for Emission

Blanket ImplementationsÂ§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/help.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/help.html index d83666a4d3..f662b41ef8 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/help.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/help.html @@ -1 +1 @@ -Help

Rustdoc help

\ No newline at end of file +Help

Rustdoc help

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/settings.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/settings.html index 8c8e2d03a2..b09211728f 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/settings.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/settings.html @@ -1 +1 @@ -Settings

Rustdoc settings

\ No newline at end of file +Settings

Rustdoc settings

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/types.rs.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/types.rs.html index 1e4f3f07c3..31e5ac2cc6 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/types.rs.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/types.rs.html @@ -222,7 +222,7 @@ /// The location of the output. outpoint: OutPoint, /// The nSequence value to set for this input. - sequence: Option<Sequence>, + sequence: Sequence, /// The information about the input we require to add it to a PSBT. // Box it to stop the type being too big. psbt_input: Box<psbt::Input>, @@ -264,7 +264,7 @@ pub fn sequence(&self) -> Option<Sequence> { match self { Utxo::Local(_) => None, - Utxo::Foreign { sequence, .. } => *sequence, + Utxo::Foreign { sequence, .. } => Some(*sequence), } } } diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/mod.rs.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/mod.rs.html index 57aaf7ae71..35dde739ce 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/mod.rs.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/mod.rs.html @@ -4238,7 +4238,7 @@ WeightedUtxo { utxo: Utxo::Foreign { outpoint: txin.previous_output, - sequence: Some(txin.sequence), + sequence: txin.sequence, psbt_input: Box::new(psbt::Input { witness_utxo: Some(txout.clone()), non_witness_utxo: Some(prev_tx.as_ref().clone()), diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/tx_builder.rs.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/tx_builder.rs.html index ffa40feb51..822cd11842 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/tx_builder.rs.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/tx_builder.rs.html @@ -1491,7 +1491,7 @@ satisfaction_weight, utxo: Utxo::Foreign { outpoint, - sequence: Some(sequence), + sequence, psbt_input: Box::new(psbt_input), }, }); diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.AsRef.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.AsRef.js index d4e6c798fa..1ee19459e5 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.AsRef.js +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.AsRef.js @@ -1,4 +1,4 @@ (function() {var implementors = { "bdk_chain":[["impl AsRef<[u8; 32]> for DescriptorId"],["impl AsRef<[u8]> for DescriptorId"],["impl<A> AsRef<TxGraph<A>> for TxGraph<A>"],["impl<A, I> AsRef<TxGraph<A>> for IndexedTxGraph<A, I>"]], -"bdk_wallet":[["impl AsRef<TxGraph<ConfirmationBlockTime>> for Wallet"],["impl AsRef<[u8]> for KeychainKind"]] +"bdk_wallet":[["impl AsRef<TxGraph<ConfirmationBlockTime>> for Wallet"],["impl AsRef<[u8]> for KeychainKind"]] };if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})() \ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.From.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.From.js index 8c94502b00..52fd643bef 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.From.js +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/trait.impl/core/convert/trait.From.js @@ -2,6 +2,6 @@ "bdk_chain":[["impl From<Hash> for DescriptorId"],["impl From<DescriptorId> for Hash"],["impl<'b> From<TxPosInBlock<'b>> for BlockId"],["impl<'b> From<TxPosInBlock<'b>> for ConfirmationBlockTime"],["impl<A> From<ChangeSet> for ChangeSet<A, ChangeSet>"],["impl<A> From<TxGraph<A>> for TxUpdate<A>"],["impl<A, IA: Default> From<ChangeSet<A>> for ChangeSet<A, IA>"],["impl<A: Ord + Clone> From<TxUpdate<A>> for TxGraph<A>"],["impl<B: IntoIterator<Item = (u32, Option<BlockHash>)>> From for ChangeSet"],["impl<T> From<T> for AnchorImpl<T>"],["impl<T> From<T> for Impl<T>"]], "bdk_core":[["impl From<(&u32, &BlockHash)> for BlockId"],["impl From<(u32, BlockHash)> for BlockId"],["impl From<BlockId> for (u32, BlockHash)"],["impl From<SyncRequestBuilder> for SyncRequest"],["impl<K> From<FullScanRequestBuilder<K>> for FullScanRequest<K>"]], "bdk_file_store":[["impl From<Error> for FileError"],["impl From<Error> for IterError"]], -"bdk_wallet":[["impl From<Error> for CreateTxError"],["impl From<PolicyError> for Error"],["impl From<PolicyError> for CreateTxError"],["impl From<SatisfiableItem> for Policy"],["impl From<LoadMismatch> for LoadError"],["impl From<MiniscriptPsbtError> for CreateTxError"],["impl From<KeyError> for Error"],["impl From<bool> for Satisfaction"],["impl From<FullScanResponse<KeychainKind>> for Update"],["impl From<SyncResponse> for Update"],["impl From<InsufficientFunds> for CreateTxError"],["impl From<ChangeSet> for ChangeSet"],["impl From<ChangeSet> for ChangeSet"],["impl From<ChangeSet<ConfirmationBlockTime>> for ChangeSet"],["impl From<ChangeSet<ConfirmationBlockTime, ChangeSet>> for ChangeSet"],["impl From<Error> for Error"],["impl From<Error> for Error"],["impl From<Error> for Error"],["impl From<Error> for CreateTxError"],["impl From<Error> for KeyError"],["impl From<Error> for KeyError"],["impl From<Fingerprint> for SignerId"],["impl From<Hash> for SignerId"],["impl From<HexToBytesError> for Error"],["impl From<ParsePublicKeyError> for Error"],["impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>"],["impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>"],["impl<E> From<LoadMismatch> for LoadWithPersistError<E>"]], +"bdk_wallet":[["impl From<Error> for CreateTxError"],["impl From<PolicyError> for Error"],["impl From<PolicyError> for CreateTxError"],["impl From<SatisfiableItem> for Policy"],["impl From<LoadMismatch> for LoadError"],["impl From<MiniscriptPsbtError> for CreateTxError"],["impl From<KeyError> for Error"],["impl From<bool> for Satisfaction"],["impl From<ChangeSet<ConfirmationBlockTime, ChangeSet>> for ChangeSet"],["impl From<ChangeSet> for ChangeSet"],["impl From<ChangeSet> for ChangeSet"],["impl From<ChangeSet<ConfirmationBlockTime>> for ChangeSet"],["impl From<FullScanResponse<KeychainKind>> for Update"],["impl From<SyncResponse> for Update"],["impl From<InsufficientFunds> for CreateTxError"],["impl From<Error> for Error"],["impl From<Error> for Error"],["impl From<Error> for Error"],["impl From<Error> for CreateTxError"],["impl From<Error> for KeyError"],["impl From<Error> for KeyError"],["impl From<Fingerprint> for SignerId"],["impl From<Hash> for SignerId"],["impl From<HexToBytesError> for Error"],["impl From<ParsePublicKeyError> for Error"],["impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>"],["impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>"],["impl<E> From<LoadMismatch> for LoadWithPersistError<E>"]], "example_bitcoind_rpc_polling":[["impl From<RpcArgs> for Auth"]] };if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})() \ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_chain/indexed_tx_graph/struct.IndexedTxGraph.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_chain/indexed_tx_graph/struct.IndexedTxGraph.js index 84b38e2452..78182e9876 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_chain/indexed_tx_graph/struct.IndexedTxGraph.js +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_chain/indexed_tx_graph/struct.IndexedTxGraph.js @@ -1,3 +1,3 @@ (function() {var type_impls = { -"example_cli":[["

impl<A, I> AsRef<TxGraph<A>> for IndexedTxGraph<A, I>

fn as_ref(&self) -> &TxGraph<A>

Converts this type into a shared reference of the (usually inferred) input type.

","AsRef>","example_cli::KeychainTxGraph"],["

impl<A, I> Debug for IndexedTxGraph<A, I>
where\n A: Debug,\n I: Debug,

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

Formats the value using the given formatter. Read more

","Debug","example_cli::KeychainTxGraph"],["

impl<A, I> Default for IndexedTxGraph<A, I>
where\n I: Default,

fn default() -> IndexedTxGraph<A, I>

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

","Default","example_cli::KeychainTxGraph"],["

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

pub fn new(index: I) -> IndexedTxGraph<A, I>

Construct a new [IndexedTxGraph] with a given index.

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

Get a reference of the internal transaction graph.

",0,"example_cli::KeychainTxGraph"],["

impl<A, I> IndexedTxGraph<A, I>
where\n ::ChangeSet: Default + Merge,\n A: for<'b> Anchor + for<'b> From<TxPosInBlock<'b>>,\n I: Indexer,

Methods are available if the anchor (A) can be created from [TxPosInBlock].

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

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

Each inserted transactionâs anchor will be constructed using [TxPosInBlock].

Relevancy is determined by the internal [Indexer::is_tx_relevant] implementation of I.\nIrrelevant transactions in txs will be ignored.

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

Batch insert all transactions of the given block of height.

Each inserted transactionâs anchor will be constructed using [TxPosInBlock].

To only insert relevant transactions, use apply_block_relevant instead.

",0,"example_cli::KeychainTxGraph"],["

impl<A, I> IndexedTxGraph<A, I>
where\n A: Anchor,\n I: Indexer,

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

Applies the [ChangeSet] to the [IndexedTxGraph].

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

Determines the [ChangeSet] between self and an empty [IndexedTxGraph].

",0,"example_cli::KeychainTxGraph"],["

impl<A, I> IndexedTxGraph<A, I>
where\n A: Anchor,\n I: Indexer,\n ::ChangeSet: Default + Merge,

pub fn apply_update(\n &mut self,\n update: TxUpdate<A>\n) -> ChangeSet<A, ::ChangeSet>

Apply an update directly.

update is a tx_graph::TxUpdate<A> and the resultant changes is returned as [ChangeSet].

pub fn apply_update_at(\n &mut self,\n update: TxUpdate<A>,\n seen_at: Option<u64>\n) -> ChangeSet<A, ::ChangeSet>

Apply the given update with an optional seen_at timestamp.

seen_at represents when the update is seen (in unix seconds). It is used to determine the\nlast_seens for all transactions in the update which have no corresponding anchor(s). The\nlast_seen value is used internally to determine precedence of conflicting unconfirmed\ntransactions (where the transaction with the lower last_seen value is omitted from the\ncanonical history).

Not setting a seen_at value means unconfirmed transactions introduced by this update will\nnot be part of the canonical history of transactions.

Use apply_update to have the seen_at value automatically\nset to the current time.

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

Insert a floating txout of given outpoint.

pub fn insert_tx<T>(&mut self, tx: T) -> ChangeSet<A, ::ChangeSet>
where\n T: Into<Arc<Transaction>>,

Insert and index a transaction into the graph.

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

Insert an anchor for a given transaction.

pub fn insert_seen_at(\n &mut self,\n txid: Txid,\n seen_at: u64\n) -> ChangeSet<A, ::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\nthe later last-seen is prioritized.

pub fn batch_insert_relevant<T>(\n &mut self,\n txs: impl IntoIterator<Item = (T, impl IntoIterator<Item = A>)>\n) -> ChangeSet<A, ::ChangeSet>
where\n T: Into<Arc<Transaction>>,

Batch insert transactions, filtering out those that are irrelevant.

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

pub fn batch_insert_relevant_unconfirmed<T>(\n &mut self,\n unconfirmed_txs: impl IntoIterator<Item = (T, u64)>\n) -> ChangeSet<A, ::ChangeSet>
where\n T: Into<Arc<Transaction>>,

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

Relevancy is determined by the internal [Indexer::is_tx_relevant] implementation of I.\nIrrelevant transactions in txs will be ignored.

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

pub fn batch_insert_unconfirmed<T>(\n &mut self,\n txs: impl IntoIterator<Item = (T, u64)>\n) -> ChangeSet<A, ::ChangeSet>
where\n T: Into<Arc<Transaction>>,

Batch insert unconfirmed transactions.

To filter out irrelevant transactions, use batch_insert_relevant_unconfirmed instead.

",0,"example_cli::KeychainTxGraph"]] +"example_cli":[["

impl<A, I> AsRef<TxGraph<A>> for IndexedTxGraph<A, I>

fn as_ref(&self) -> &TxGraph<A>

Converts this type into a shared reference of the (usually inferred) input type.

","AsRef>","example_cli::KeychainTxGraph"],["

impl<A, I> Debug for IndexedTxGraph<A, I>
where\n A: Debug,\n I: Debug,

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

Formats the value using the given formatter. Read more

","Debug","example_cli::KeychainTxGraph"],["

impl<A, I> Default for IndexedTxGraph<A, I>
where\n I: Default,

fn default() -> IndexedTxGraph<A, I>

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

","Default","example_cli::KeychainTxGraph"],["

impl<A, I> IndexedTxGraph<A, I>
where\n ::ChangeSet: Default + Merge,\n A: for<'b> Anchor + for<'b> From<TxPosInBlock<'b>>,\n I: Indexer,

Methods are available if the anchor (A) can be created from TxPosInBlock.

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

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

Each inserted transactionâs anchor will be constructed using TxPosInBlock.

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

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

Batch insert all transactions of the given block of height.

Each inserted transactionâs anchor will be constructed using TxPosInBlock.

To only insert relevant transactions, use apply_block_relevant instead.

",0,"example_cli::KeychainTxGraph"],["

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

pub fn new(index: I) -> IndexedTxGraph<A, I>

Construct a new IndexedTxGraph with a given index.

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

Get a reference of the internal transaction graph.

",0,"example_cli::KeychainTxGraph"],["

impl<A, I> IndexedTxGraph<A, I>
where\n A: Anchor,\n I: Indexer,

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

Applies the ChangeSet to the IndexedTxGraph.

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

Determines the ChangeSet between self and an empty IndexedTxGraph.

",0,"example_cli::KeychainTxGraph"],["

impl<A, I> IndexedTxGraph<A, I>
where\n A: Anchor,\n I: Indexer,\n ::ChangeSet: Default + Merge,

pub fn apply_update(\n &mut self,\n update: TxUpdate<A>\n) -> ChangeSet<A, ::ChangeSet>

Apply an update directly.

update is a tx_graph::TxUpdate<A> and the resultant changes is returned as ChangeSet.

pub fn apply_update_at(\n &mut self,\n update: TxUpdate<A>,\n seen_at: Option<u64>\n) -> ChangeSet<A, ::ChangeSet>

Apply the given update with an optional seen_at timestamp.

Not setting a seen_at value means unconfirmed transactions introduced by this update will\nnot be part of the canonical history of transactions.

Use apply_update to have the seen_at value automatically\nset to the current time.

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

Insert a floating txout of given outpoint.

pub fn insert_tx<T>(&mut self, tx: T) -> ChangeSet<A, ::ChangeSet>
where\n T: Into<Arc<Transaction>>,

Insert and index a transaction into the graph.

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

Insert an anchor for a given transaction.

pub fn insert_seen_at(\n &mut self,\n txid: Txid,\n seen_at: u64\n) -> ChangeSet<A, ::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\nthe later last-seen is prioritized.

pub fn batch_insert_relevant<T>(\n &mut self,\n txs: impl IntoIterator<Item = (T, impl IntoIterator<Item = A>)>\n) -> ChangeSet<A, ::ChangeSet>
where\n T: Into<Arc<Transaction>>,

Batch insert transactions, filtering out those that are irrelevant.

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

pub fn batch_insert_relevant_unconfirmed<T>(\n &mut self,\n unconfirmed_txs: impl IntoIterator<Item = (T, u64)>\n) -> ChangeSet<A, ::ChangeSet>
where\n T: Into<Arc<Transaction>>,

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

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

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

pub fn batch_insert_unconfirmed<T>(\n &mut self,\n txs: impl IntoIterator<Item = (T, u64)>\n) -> ChangeSet<A, ::ChangeSet>
where\n T: Into<Arc<Transaction>>,

Batch insert unconfirmed transactions.

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

To filter out irrelevant transactions, use batch_insert_relevant_unconfirmed instead.

",0,"example_cli::KeychainTxGraph"]] };if (window.register_type_impls) {window.register_type_impls(type_impls);} else {window.pending_type_impls = type_impls;}})() \ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_chain/tx_graph/struct.CanonicalTx.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_chain/tx_graph/struct.CanonicalTx.js index 81c6733b76..5d2242f6b7 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_chain/tx_graph/struct.CanonicalTx.js +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_chain/tx_graph/struct.CanonicalTx.js @@ -1,3 +1,3 @@ (function() {var type_impls = { -"bdk_wallet":[["

impl<'a, T, A> Clone for CanonicalTx<'a, T, A>
where\n T: Clone,\n A: Clone,

fn clone(&self) -> CanonicalTx<'a, T, A>

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

","Clone","bdk_wallet::wallet::WalletTx"],["

impl<'a, T, A> Debug for CanonicalTx<'a, T, A>
where\n T: Debug,\n A: Debug,

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

Formats the value using the given formatter. Read more

","Debug","bdk_wallet::wallet::WalletTx"],["

impl<'a, T, A> Ord for CanonicalTx<'a, T, A>
where\n T: Ord,\n A: Ord,

fn cmp(&self, other: &CanonicalTx<'a, T, A>) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 Â· sourceÂ§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 Â· sourceÂ§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 Â· sourceÂ§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more

","Ord","bdk_wallet::wallet::WalletTx"],["

impl<'a, T, A> PartialEq for CanonicalTx<'a, T, A>
where\n T: PartialEq,\n A: PartialEq,

fn eq(&self, other: &CanonicalTx<'a, T, A>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.

1.0.0 Â· sourceÂ§

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

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.

","PartialEq","bdk_wallet::wallet::WalletTx"],["

impl<'a, T, A> PartialOrd for CanonicalTx<'a, T, A>
where\n T: PartialOrd,\n A: PartialOrd,

fn partial_cmp(&self, other: &CanonicalTx<'a, T, A>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 Â· sourceÂ§

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 Â· sourceÂ§

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

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more

1.0.0 Â· sourceÂ§

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 Â· sourceÂ§

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

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more

","PartialOrd","bdk_wallet::wallet::WalletTx"],["

impl<'a, T, A> Eq for CanonicalTx<'a, T, A>
where\n T: Eq,\n A: Eq,

","Eq","bdk_wallet::wallet::WalletTx"],["

impl<'a, T, A> StructuralPartialEq for CanonicalTx<'a, T, A>

","StructuralPartialEq","bdk_wallet::wallet::WalletTx"]] +"bdk_wallet":[["

impl<'a, T, A> Clone for CanonicalTx<'a, T, A>
where\n T: Clone,\n A: Clone,

fn clone(&self) -> CanonicalTx<'a, T, A>

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

","Clone","bdk_wallet::wallet::WalletTx"],["

impl<'a, T, A> Debug for CanonicalTx<'a, T, A>
where\n T: Debug,\n A: Debug,

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

Formats the value using the given formatter. Read more

","Debug","bdk_wallet::wallet::WalletTx"],["

impl<'a, T, A> Ord for CanonicalTx<'a, T, A>
where\n T: Ord,\n A: Ord,

fn cmp(&self, other: &CanonicalTx<'a, T, A>) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 Â· sourceÂ§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 Â· sourceÂ§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 Â· sourceÂ§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more

","Ord","bdk_wallet::wallet::WalletTx"],["

impl<'a, T, A> PartialEq for CanonicalTx<'a, T, A>
where\n T: PartialEq,\n A: PartialEq,

fn eq(&self, other: &CanonicalTx<'a, T, A>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.

1.0.0 Â· sourceÂ§

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

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.

","PartialEq","bdk_wallet::wallet::WalletTx"],["

impl<'a, T, A> PartialOrd for CanonicalTx<'a, T, A>
where\n T: PartialOrd,\n A: PartialOrd,

fn partial_cmp(&self, other: &CanonicalTx<'a, T, A>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 Â· sourceÂ§

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 Â· sourceÂ§

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

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more

1.0.0 Â· sourceÂ§

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 Â· sourceÂ§

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

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more

","PartialOrd","bdk_wallet::wallet::WalletTx"],["

impl<'a, T, A> Eq for CanonicalTx<'a, T, A>
where\n T: Eq,\n A: Eq,

","Eq","bdk_wallet::wallet::WalletTx"],["

impl<'a, T, A> StructuralPartialEq for CanonicalTx<'a, T, A>

","StructuralPartialEq","bdk_wallet::wallet::WalletTx"]] };if (window.register_type_impls) {window.register_type_impls(type_impls);} else {window.pending_type_impls = type_impls;}})() \ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_wallet/descriptor/enum.Descriptor.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_wallet/descriptor/enum.Descriptor.js index 2a39910dca..26dc87a4d8 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_wallet/descriptor/enum.Descriptor.js +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_wallet/descriptor/enum.Descriptor.js @@ -1,3 +1,3 @@ (function() {var type_impls = { -"bdk_wallet":[["

impl<Pk> Clone for Descriptor<Pk>
where\n Pk: Clone + MiniscriptKey,

fn clone(&self) -> Descriptor<Pk>

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

","Clone","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> Debug for Descriptor<Pk>
where\n Pk: MiniscriptKey,

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

Formats the value using the given formatter. Read more

","Debug","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl Descriptor<DefiniteDescriptorKey>

pub fn derived_descriptor<C>(\n &self,\n secp: &Secp256k1<C>\n) -> Result<Descriptor<PublicKey>, ConversionError>
where\n C: Verification,

Convert all the public keys in the descriptor to [bitcoin::PublicKey] by deriving them or\notherwise converting them. All [bitcoin::secp256k1::XOnlyPublicKey]s are converted to by adding a\ndefault(0x02) y-coordinate.

Â§Examples

use miniscript::descriptor::{Descriptor, DescriptorPublicKey};\nuse miniscript::bitcoin::secp256k1;\nuse std::str::FromStr;\n\n// test from bip 86\nlet secp = secp256k1::Secp256k1::verification_only();\nlet descriptor = Descriptor::<DescriptorPublicKey>::from_str(\"tr(xpub6BgBgsespWvERF3LHQu6CnqdvfEvtMcQjYrcRzx53QJjSxarj2afYWcLteoGVky7D3UKDP9QyrLprQ3VCECoY49yfdDEHGCtMMj92pReUsQ/0/*)\")\n    .expect(\"Valid ranged descriptor\");\nlet result = descriptor.at_derivation_index(0).unwrap().derived_descriptor(&secp).expect(\"Non-hardened derivation\");\nassert_eq!(result.to_string(), \"tr(03cc8a4bc64d897bddc5fbc2f670f7a8ba0b386779106cf1223c6fc5d7cd6fc115)#6qm9h8ym\");

Â§Errors

This function will return an error if hardened derivation is attempted.

",0,"bdk_wallet::descriptor::DerivedDescriptor"],["

impl Descriptor<DefiniteDescriptorKey>

pub fn plan(\n self,\n provider: &P\n) -> Result<Plan, Descriptor<DefiniteDescriptorKey>>
where\n P: AssetProvider<DefiniteDescriptorKey>,

Returns a plan if the provided assets are sufficient to produce a non-malleable satisfaction

If the assets arenât sufficient for generating a Plan, the descriptor is returned

pub fn plan_mall(\n self,\n provider: &P\n) -> Result<Plan, Descriptor<DefiniteDescriptorKey>>
where\n P: AssetProvider<DefiniteDescriptorKey>,

Returns a plan if the provided assets are sufficient to produce a malleable satisfaction

If the assets arenât sufficient for generating a Plan, the descriptor is returned

",0,"bdk_wallet::descriptor::DerivedDescriptor"],["

impl Descriptor<DescriptorPublicKey>

pub fn is_deriveable(&self) -> bool

ðDeprecated: use has_wildcards instead

Whether or not the descriptor has any wildcards

pub fn has_wildcard(&self) -> bool

Whether or not the descriptor has any wildcards i.e. /*.

pub fn at_derivation_index(\n &self,\n index: u32\n) -> Result<Descriptor<DefiniteDescriptorKey>, ConversionError>

Replaces all wildcards (i.e. /*) in the descriptor with a particular derivation index,\nturning it into a definite descriptor.

Â§Errors

If index â¥ 2^31

pub fn derive(\n &self,\n index: u32\n) -> Result<Descriptor<DefiniteDescriptorKey>, ConversionError>

ðDeprecated: use at_derivation_index instead

Deprecated name for Self::at_derivation_index.

pub fn derived_descriptor<C>(\n &self,\n secp: &Secp256k1<C>,\n index: u32\n) -> Result<Descriptor<PublicKey>, ConversionError>
where\n C: Verification,

This is a shorthand for:

\n\n

    .expect(\"Valid ranged descriptor\");\nlet derived_descriptor = descriptor.at_derivation_index(index).unwrap().derived_descriptor(&secp).unwrap();

and is only here really here for backwards compatibility.\nSee at_derivation_index and [derived_descriptor] for more documentation.

Â§Errors

This function will return an error if hardened derivation is attempted.

pub fn parse_descriptor<C>(\n secp: &Secp256k1<C>,\n s: &str\n) -> Result<(Descriptor<DescriptorPublicKey>, BTreeMap<DescriptorPublicKey, DescriptorSecretKey>), Error>
where\n C: Signing,

Parse a descriptor that may contain secret keys

Internally turns every secret key found into the corresponding public key and then returns a\na descriptor that only contains public keys and a map to lookup the secret key given a public key.

pub fn to_string_with_secret(\n &self,\n key_map: &BTreeMap<DescriptorPublicKey, DescriptorSecretKey>\n) -> String

Serialize a descriptor to string with its secret keys

pub fn find_derivation_index_for_spk<C>(\n &self,\n secp: &Secp256k1<C>,\n script_pubkey: &Script,\n range: Range<u32>\n) -> Result<Option<(u32, Descriptor<PublicKey>)>, ConversionError>
where\n C: Verification,

Utility method for deriving the descriptor at each index in a range to find one matching\nscript_pubkey.

If it finds a match then it returns the index it was derived at and the concrete\ndescriptor at that index. If the descriptor is non-derivable then it will simply check the\nscript pubkey against the descriptor and return it if it matches (in this case the index\nreturned will be meaningless).

pub fn is_multipath(&self) -> bool

Whether this descriptor contains a key that has multiple derivation paths.

pub fn into_single_descriptors(\n self\n) -> Result<Vec<Descriptor<DescriptorPublicKey>>, Error>

Get as many descriptors as different paths in this descriptor.

For multipath descriptors it will return as many descriptors as there is\nâparallelâ paths. For regular descriptors it will just return itself.

",0,"bdk_wallet::descriptor::ExtendedDescriptor"],["

impl<Pk> Descriptor<Pk>
where\n Pk: MiniscriptKey + ToPublicKey,

pub fn address(&self, network: Network) -> Result<Address, Error>

Computes the Bitcoin address of the descriptor, if one exists

Some descriptors like pk() donât have an address.

Â§Errors

For raw/bare descriptors that donât have an address.

pub fn script_pubkey(&self) -> ScriptBuf

Computes the scriptpubkey of the descriptor.

pub fn unsigned_script_sig(&self) -> ScriptBuf

Computes the scriptSig that will be in place for an unsigned input\nspending an output with this descriptor. For pre-segwit descriptors,\nwhich use the scriptSig for signatures, this returns the empty script.

This is used in Segwit transactions to produce an unsigned transaction\nwhose txid will not change during signing (since only the witness data\nwill change).

pub fn explicit_script(&self) -> Result<ScriptBuf, Error>

Computes the the underlying script before any hashing is done. For\nBare, Pkh and Wpkh this is the scriptPubkey; for ShWpkh and Sh\nthis is the redeemScript; for the others it is the witness script.

Â§Errors

If the descriptor is a taproot descriptor.

pub fn script_code(&self) -> Result<ScriptBuf, Error>

Computes the scriptCode of a transaction output.

The scriptCode is the Script of the previous transaction output being\nserialized in the sighash when evaluating a CHECKSIG & co. OP code.

Â§Errors

If the descriptor is a taproot descriptor.

pub fn get_satisfaction<S>(\n &self,\n satisfier: S\n) -> Result<(Vec<Vec<u8>>, ScriptBuf), Error>
where\n S: Satisfier<Pk>,

Returns satisfying non-malleable witness and scriptSig to spend an\noutput controlled by the given descriptor if it possible to\nconstruct one using the satisfier S.

pub fn get_satisfaction_mall<S>(\n &self,\n satisfier: S\n) -> Result<(Vec<Vec<u8>>, ScriptBuf), Error>
where\n S: Satisfier<Pk>,

Returns a possilbly mallable satisfying non-malleable witness and scriptSig to spend an\noutput controlled by the given descriptor if it possible to\nconstruct one using the satisfier S.

pub fn satisfy<S>(&self, txin: &mut TxIn, satisfier: S) -> Result<(), Error>
where\n S: Satisfier<Pk>,

Attempts to produce a non-malleable satisfying witness and scriptSig to spend an\noutput controlled by the given descriptor; add the data to a given\nTxIn output.

",0,"bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> Descriptor<Pk>
where\n Pk: MiniscriptKey,

pub fn new_pk(pk: Pk) -> Descriptor<Pk>

Create a new pk descriptor

pub fn new_pkh(pk: Pk) -> Result<Descriptor<Pk>, Error>

Create a new PkH descriptor

pub fn new_wpkh(pk: Pk) -> Result<Descriptor<Pk>, Error>

Create a new Wpkh descriptor\nWill return Err if uncompressed key is used

pub fn new_sh_wpkh(pk: Pk) -> Result<Descriptor<Pk>, Error>

Create a new sh wrapped wpkh from Pk.\nErrors when uncompressed keys are supplied

pub fn new_sh(ms: Miniscript<Pk, Legacy>) -> Result<Descriptor<Pk>, Error>

Create a new sh for a given redeem script\nErrors when miniscript exceeds resource limits under p2sh context\nor does not type check at the top level

pub fn new_wsh(ms: Miniscript<Pk, Segwitv0>) -> Result<Descriptor<Pk>, Error>

Create a new wsh descriptor from witness script\nErrors when miniscript exceeds resource limits under p2sh context\nor does not type check at the top level

pub fn new_sh_wsh(ms: Miniscript<Pk, Segwitv0>) -> Result<Descriptor<Pk>, Error>

Create a new sh wrapped wsh descriptor with witness script\nErrors when miniscript exceeds resource limits under wsh context\nor does not type check at the top level

pub fn new_bare(ms: Miniscript<Pk, BareCtx>) -> Result<Descriptor<Pk>, Error>

Create a new bare descriptor from witness script\nErrors when miniscript exceeds resource limits under bare context\nor does not type check at the top level

pub fn new_sh_with_wpkh(wpkh: Wpkh<Pk>) -> Descriptor<Pk>

Create a new sh wrapper for the given wpkh descriptor

pub fn new_sh_with_wsh(wsh: Wsh<Pk>) -> Descriptor<Pk>

Create a new sh wrapper for the given wsh descriptor

pub fn new_sh_sortedmulti(\n k: usize,\n pks: Vec<Pk>\n) -> Result<Descriptor<Pk>, Error>

Create a new sh sortedmulti descriptor with threshold k\nand Vec of pks.\nErrors when miniscript exceeds resource limits under p2sh context

pub fn new_sh_wsh_sortedmulti(\n k: usize,\n pks: Vec<Pk>\n) -> Result<Descriptor<Pk>, Error>

Create a new sh wrapped wsh sortedmulti descriptor from threshold\nk and Vec of pks\nErrors when miniscript exceeds resource limits under segwit context

pub fn new_wsh_sortedmulti(\n k: usize,\n pks: Vec<Pk>\n) -> Result<Descriptor<Pk>, Error>

Create a new wsh sorted multi descriptor\nErrors when miniscript exceeds resource limits under p2sh context

pub fn new_tr(\n key: Pk,\n script: Option<TapTree<Pk>>\n) -> Result<Descriptor<Pk>, Error>

Create new tr descriptor\nErrors when miniscript exceeds resource limits under Tap context

pub fn desc_type(&self) -> DescriptorType

Get the [DescriptorType] of Descriptor

pub fn sanity_check(&self) -> Result<(), Error>

Checks whether the descriptor is safe.

Checks whether all the spend paths in the descriptor are possible on the\nbitcoin network under the current standardness and consensus rules. Also\nchecks whether the descriptor requires signatures on all spend paths and\nwhether the script is malleable.

In general, all the guarantees of miniscript hold only for safe scripts.\nThe signer may not be able to find satisfactions even if one exists.

pub fn max_weight_to_satisfy(&self) -> Result<Weight, Error>

Computes an upper bound on the difference between a non-satisfied\nTxInâs segwit_weight and a satisfied TxInâs segwit_weight

Since this method uses segwit_weight instead of legacy_weight,\nif you want to include only legacy inputs in your transaction,\nyou should remove 1WU from each inputâs max_weight_to_satisfy\nfor a more accurate estimate.

In other words, for segwit inputs or legacy inputs included in\nsegwit transactions, the following will hold for each input if\nthat input was satisfied with the largest possible witness:

\n\n

for i in 0..transaction.input.len() {\n    assert_eq!(\n        descriptor_for_input[i].max_weight_to_satisfy(),\n        transaction.input[i].segwit_weight() - TxIn::default().segwit_weight()\n    );\n}

Instead, for legacy transactions, the following will hold for each input\nif that input was satisfied with the largest possible witness:

\n\n

for i in 0..transaction.input.len() {\n    assert_eq!(\n        descriptor_for_input[i].max_weight_to_satisfy(),\n        transaction.input[i].legacy_weight() - TxIn::default().legacy_weight()\n    );\n}

Assumes all ECDSA signatures are 73 bytes, including push opcode and\nsighash suffix.\nAssumes all Schnorr signatures are 66 bytes, including push opcode and\nsighash suffix.

Â§Errors

When the descriptor is impossible to safisfy (ex: sh(OP_FALSE)).

pub fn max_satisfaction_weight(&self) -> Result<usize, Error>

ðDeprecated since 10.0.0: Use max_weight_to_satisfy instead. The method to count bytes was redesigned and the results will differ from max_weight_to_satisfy. For more details check rust-bitcoin/rust-miniscript#476.

Computes an upper bound on the weight of a satisfying witness to the\ntransaction.

Assumes all ec-signatures are 73 bytes, including push opcode and\nsighash suffix. Includes the weight of the VarInts encoding the\nscriptSig and witness stack length.

Â§Errors

When the descriptor is impossible to safisfy (ex: sh(OP_FALSE)).

",0,"bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl DescriptorExt for Descriptor<DescriptorPublicKey>

fn dust_value(&self) -> u64

Returns the minimum value (in satoshis) at which an output is broadcastable.\nPanics if the descriptor wildcard is hardened.

fn descriptor_id(&self) -> DescriptorId

Returns the descriptor ID, calculated as the sha256 hash of the spk derived from the\ndescriptor at index 0.

","DescriptorExt","bdk_wallet::descriptor::ExtendedDescriptor"],["

impl<'de, Pk> Deserialize<'de> for Descriptor<Pk>
where\n Pk: FromStrKey,

fn deserialize<D>(\n deserializer: D\n) -> Result<Descriptor<Pk>, <D as Deserializer<'de>>::Error>
where\n D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

","Deserialize<'de>","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> Display for Descriptor<Pk>
where\n Pk: MiniscriptKey,

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

Formats the value using the given formatter. Read more

","Display","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl ExtractPolicy for Descriptor<DescriptorPublicKey>

fn extract_policy(\n &self,\n signers: &SignersContainer,\n build_sat: BuildSatisfaction<'_>,\n secp: &Secp256k1<All>\n) -> Result<Option<Policy>, Error>

Extract the spending policy

","ExtractPolicy","bdk_wallet::descriptor::ExtendedDescriptor"],["

impl<Pk> ForEachKey<Pk> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn for_each_key<'a, F>(&'a self, pred: F) -> bool
where\n F: FnMut(&'a Pk) -> bool,

Run a predicate on every key in the descriptor, returning whether\nthe predicate returned true for every key

fn for_any_key<'a, F>(&'a self, pred: F) -> bool
where\n F: FnMut(&'a Pk) -> bool,\n Pk: 'a,

Run a predicate on every key in the descriptor, returning whether\nthe predicate returned true for any key

","ForEachKey","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> From<Bare<Pk>> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn from(inner: Bare<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

","From>","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn from(inner: Pkh<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

","From>","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> From<Sh<Pk>> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn from(inner: Sh<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

","From>","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> From<Tr<Pk>> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn from(inner: Tr<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

","From>","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

","From>","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn from(inner: Wsh<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

","From>","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> FromStr for Descriptor<Pk>
where\n Pk: FromStrKey,

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Descriptor<Pk>, Error>

Parses a string s to return a value of this type. Read more

","FromStr","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> FromTree for Descriptor<Pk>
where\n Pk: FromStrKey,

fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>

Parse an expression tree into a descriptor.

","FromTree","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> Hash for Descriptor<Pk>
where\n Pk: Hash + MiniscriptKey,

fn hash<H>(&self, state: &mut H)
where\n __H: Hasher,

Feeds this value into the given Hasher. Read more

1.3.0 Â· sourceÂ§

fn hash_slice<H>(data: &[Self], state: &mut H)
where\n H: Hasher,\n Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

","Hash","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> Liftable<Pk> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn lift(&self) -> Result<Policy<Pk>, Error>

Converts this object into an abstract policy.

","Liftable","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> Ord for Descriptor<Pk>
where\n Pk: Ord + MiniscriptKey,

fn cmp(&self, other: &Descriptor<Pk>) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 Â· sourceÂ§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 Â· sourceÂ§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 Â· sourceÂ§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more

","Ord","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> PartialEq for Descriptor<Pk>
where\n Pk: PartialEq + MiniscriptKey,

fn eq(&self, other: &Descriptor<Pk>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.

1.0.0 Â· sourceÂ§

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

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.

","PartialEq","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> PartialOrd for Descriptor<Pk>
where\n Pk: PartialOrd + MiniscriptKey,

fn partial_cmp(&self, other: &Descriptor<Pk>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 Â· sourceÂ§

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 Â· sourceÂ§

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

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more

1.0.0 Â· sourceÂ§

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 Â· sourceÂ§

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

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more

","PartialOrd","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<'de, Pk> Serialize for Descriptor<Pk>
where\n Pk: MiniscriptKey,

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

Serialize this value into the given Serde serializer. Read more

","Serialize","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<P, Q> TranslatePk<P, Q> for Descriptor
where\n P: MiniscriptKey,\n Q: MiniscriptKey,

fn translate_pk<T, E>(\n &self,\n t: &mut T\n) -> Result<<Descriptor as TranslatePk<P, Q>>::Output, TranslateErr<E>>
where\n T: Translator<P, Q, E>,

Converts a descriptor using abstract keys to one using specific keys.

type Output = Descriptor<Q>

The associated output type. This must be Self<Q>.

","TranslatePk","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> Eq for Descriptor<Pk>
where\n Pk: Eq + MiniscriptKey,

","Eq","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> StructuralPartialEq for Descriptor<Pk>
where\n Pk: MiniscriptKey,

","StructuralPartialEq","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"]] +"bdk_wallet":[["

impl<Pk> Clone for Descriptor<Pk>
where\n Pk: Clone + MiniscriptKey,

fn clone(&self) -> Descriptor<Pk>

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

","Clone","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> Debug for Descriptor<Pk>
where\n Pk: MiniscriptKey,

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

Formats the value using the given formatter. Read more

","Debug","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl Descriptor<DefiniteDescriptorKey>

pub fn derived_descriptor<C>(\n &self,\n secp: &Secp256k1<C>\n) -> Result<Descriptor<PublicKey>, ConversionError>
where\n C: Verification,

Â§Examples

use miniscript::descriptor::{Descriptor, DescriptorPublicKey};\nuse miniscript::bitcoin::secp256k1;\nuse std::str::FromStr;\n\n// test from bip 86\nlet secp = secp256k1::Secp256k1::verification_only();\nlet descriptor = Descriptor::<DescriptorPublicKey>::from_str(\"tr(xpub6BgBgsespWvERF3LHQu6CnqdvfEvtMcQjYrcRzx53QJjSxarj2afYWcLteoGVky7D3UKDP9QyrLprQ3VCECoY49yfdDEHGCtMMj92pReUsQ/0/*)\")\n    .expect(\"Valid ranged descriptor\");\nlet result = descriptor.at_derivation_index(0).unwrap().derived_descriptor(&secp).expect(\"Non-hardened derivation\");\nassert_eq!(result.to_string(), \"tr(03cc8a4bc64d897bddc5fbc2f670f7a8ba0b386779106cf1223c6fc5d7cd6fc115)#6qm9h8ym\");

Â§Errors

This function will return an error if hardened derivation is attempted.

",0,"bdk_wallet::descriptor::DerivedDescriptor"],["

impl Descriptor<DefiniteDescriptorKey>

pub fn plan(\n self,\n provider: &P\n) -> Result<Plan, Descriptor<DefiniteDescriptorKey>>
where\n P: AssetProvider<DefiniteDescriptorKey>,

Returns a plan if the provided assets are sufficient to produce a non-malleable satisfaction

If the assets arenât sufficient for generating a Plan, the descriptor is returned

pub fn plan_mall(\n self,\n provider: &P\n) -> Result<Plan, Descriptor<DefiniteDescriptorKey>>
where\n P: AssetProvider<DefiniteDescriptorKey>,

Returns a plan if the provided assets are sufficient to produce a malleable satisfaction

If the assets arenât sufficient for generating a Plan, the descriptor is returned

",0,"bdk_wallet::descriptor::DerivedDescriptor"],["

impl Descriptor<DescriptorPublicKey>

pub fn is_deriveable(&self) -> bool

ðDeprecated: use has_wildcards instead

Whether or not the descriptor has any wildcards

pub fn has_wildcard(&self) -> bool

Whether or not the descriptor has any wildcards i.e. /*.

pub fn at_derivation_index(\n &self,\n index: u32\n) -> Result<Descriptor<DefiniteDescriptorKey>, ConversionError>

Replaces all wildcards (i.e. /*) in the descriptor with a particular derivation index,\nturning it into a definite descriptor.

Â§Errors

If index â¥ 2^31

pub fn derive(\n &self,\n index: u32\n) -> Result<Descriptor<DefiniteDescriptorKey>, ConversionError>

ðDeprecated: use at_derivation_index instead

Deprecated name for Self::at_derivation_index.

pub fn derived_descriptor<C>(\n &self,\n secp: &Secp256k1<C>,\n index: u32\n) -> Result<Descriptor<PublicKey>, ConversionError>
where\n C: Verification,

This is a shorthand for:

\n\n

    .expect(\"Valid ranged descriptor\");\nlet derived_descriptor = descriptor.at_derivation_index(index).unwrap().derived_descriptor(&secp).unwrap();

and is only here really here for backwards compatibility.\nSee at_derivation_index and [derived_descriptor] for more documentation.

Â§Errors

This function will return an error if hardened derivation is attempted.

pub fn parse_descriptor<C>(\n secp: &Secp256k1<C>,\n s: &str\n) -> Result<(Descriptor<DescriptorPublicKey>, BTreeMap<DescriptorPublicKey, DescriptorSecretKey>), Error>
where\n C: Signing,

Parse a descriptor that may contain secret keys

Internally turns every secret key found into the corresponding public key and then returns a\na descriptor that only contains public keys and a map to lookup the secret key given a public key.

pub fn to_string_with_secret(\n &self,\n key_map: &BTreeMap<DescriptorPublicKey, DescriptorSecretKey>\n) -> String

Serialize a descriptor to string with its secret keys

pub fn find_derivation_index_for_spk<C>(\n &self,\n secp: &Secp256k1<C>,\n script_pubkey: &Script,\n range: Range<u32>\n) -> Result<Option<(u32, Descriptor<PublicKey>)>, ConversionError>
where\n C: Verification,

Utility method for deriving the descriptor at each index in a range to find one matching\nscript_pubkey.

pub fn is_multipath(&self) -> bool

Whether this descriptor contains a key that has multiple derivation paths.

pub fn into_single_descriptors(\n self\n) -> Result<Vec<Descriptor<DescriptorPublicKey>>, Error>

Get as many descriptors as different paths in this descriptor.

For multipath descriptors it will return as many descriptors as there is\nâparallelâ paths. For regular descriptors it will just return itself.

",0,"bdk_wallet::descriptor::ExtendedDescriptor"],["

impl<Pk> Descriptor<Pk>
where\n Pk: MiniscriptKey + ToPublicKey,

pub fn address(&self, network: Network) -> Result<Address, Error>

Computes the Bitcoin address of the descriptor, if one exists

Some descriptors like pk() donât have an address.

Â§Errors

For raw/bare descriptors that donât have an address.

pub fn script_pubkey(&self) -> ScriptBuf

Computes the scriptpubkey of the descriptor.

pub fn unsigned_script_sig(&self) -> ScriptBuf

This is used in Segwit transactions to produce an unsigned transaction\nwhose txid will not change during signing (since only the witness data\nwill change).

pub fn explicit_script(&self) -> Result<ScriptBuf, Error>

Â§Errors

If the descriptor is a taproot descriptor.

pub fn script_code(&self) -> Result<ScriptBuf, Error>

Computes the scriptCode of a transaction output.

The scriptCode is the Script of the previous transaction output being\nserialized in the sighash when evaluating a CHECKSIG & co. OP code.

Â§Errors

If the descriptor is a taproot descriptor.

pub fn get_satisfaction<S>(\n &self,\n satisfier: S\n) -> Result<(Vec<Vec<u8>>, ScriptBuf), Error>
where\n S: Satisfier<Pk>,

Returns satisfying non-malleable witness and scriptSig to spend an\noutput controlled by the given descriptor if it possible to\nconstruct one using the satisfier S.

pub fn get_satisfaction_mall<S>(\n &self,\n satisfier: S\n) -> Result<(Vec<Vec<u8>>, ScriptBuf), Error>
where\n S: Satisfier<Pk>,

Returns a possilbly mallable satisfying non-malleable witness and scriptSig to spend an\noutput controlled by the given descriptor if it possible to\nconstruct one using the satisfier S.

pub fn satisfy<S>(&self, txin: &mut TxIn, satisfier: S) -> Result<(), Error>
where\n S: Satisfier<Pk>,

Attempts to produce a non-malleable satisfying witness and scriptSig to spend an\noutput controlled by the given descriptor; add the data to a given\nTxIn output.

",0,"bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> Descriptor<Pk>
where\n Pk: MiniscriptKey,

pub fn new_pk(pk: Pk) -> Descriptor<Pk>

Create a new pk descriptor

pub fn new_pkh(pk: Pk) -> Result<Descriptor<Pk>, Error>

Create a new PkH descriptor

pub fn new_wpkh(pk: Pk) -> Result<Descriptor<Pk>, Error>

Create a new Wpkh descriptor\nWill return Err if uncompressed key is used

pub fn new_sh_wpkh(pk: Pk) -> Result<Descriptor<Pk>, Error>

Create a new sh wrapped wpkh from Pk.\nErrors when uncompressed keys are supplied

pub fn new_sh(ms: Miniscript<Pk, Legacy>) -> Result<Descriptor<Pk>, Error>

Create a new sh for a given redeem script\nErrors when miniscript exceeds resource limits under p2sh context\nor does not type check at the top level

pub fn new_wsh(ms: Miniscript<Pk, Segwitv0>) -> Result<Descriptor<Pk>, Error>

Create a new wsh descriptor from witness script\nErrors when miniscript exceeds resource limits under p2sh context\nor does not type check at the top level

pub fn new_sh_wsh(ms: Miniscript<Pk, Segwitv0>) -> Result<Descriptor<Pk>, Error>

Create a new sh wrapped wsh descriptor with witness script\nErrors when miniscript exceeds resource limits under wsh context\nor does not type check at the top level

pub fn new_bare(ms: Miniscript<Pk, BareCtx>) -> Result<Descriptor<Pk>, Error>

Create a new bare descriptor from witness script\nErrors when miniscript exceeds resource limits under bare context\nor does not type check at the top level

pub fn new_sh_with_wpkh(wpkh: Wpkh<Pk>) -> Descriptor<Pk>

Create a new sh wrapper for the given wpkh descriptor

pub fn new_sh_with_wsh(wsh: Wsh<Pk>) -> Descriptor<Pk>

Create a new sh wrapper for the given wsh descriptor

pub fn new_sh_sortedmulti(\n k: usize,\n pks: Vec<Pk>\n) -> Result<Descriptor<Pk>, Error>

Create a new sh sortedmulti descriptor with threshold k\nand Vec of pks.\nErrors when miniscript exceeds resource limits under p2sh context

pub fn new_sh_wsh_sortedmulti(\n k: usize,\n pks: Vec<Pk>\n) -> Result<Descriptor<Pk>, Error>

Create a new sh wrapped wsh sortedmulti descriptor from threshold\nk and Vec of pks\nErrors when miniscript exceeds resource limits under segwit context

pub fn new_wsh_sortedmulti(\n k: usize,\n pks: Vec<Pk>\n) -> Result<Descriptor<Pk>, Error>

Create a new wsh sorted multi descriptor\nErrors when miniscript exceeds resource limits under p2sh context

pub fn new_tr(\n key: Pk,\n script: Option<TapTree<Pk>>\n) -> Result<Descriptor<Pk>, Error>

Create new tr descriptor\nErrors when miniscript exceeds resource limits under Tap context

pub fn desc_type(&self) -> DescriptorType

Get the [DescriptorType] of Descriptor

pub fn sanity_check(&self) -> Result<(), Error>

Checks whether the descriptor is safe.

In general, all the guarantees of miniscript hold only for safe scripts.\nThe signer may not be able to find satisfactions even if one exists.

pub fn max_weight_to_satisfy(&self) -> Result<Weight, Error>

Computes an upper bound on the difference between a non-satisfied\nTxInâs segwit_weight and a satisfied TxInâs segwit_weight

In other words, for segwit inputs or legacy inputs included in\nsegwit transactions, the following will hold for each input if\nthat input was satisfied with the largest possible witness:

\n\n

for i in 0..transaction.input.len() {\n    assert_eq!(\n        descriptor_for_input[i].max_weight_to_satisfy(),\n        transaction.input[i].segwit_weight() - TxIn::default().segwit_weight()\n    );\n}

Instead, for legacy transactions, the following will hold for each input\nif that input was satisfied with the largest possible witness:

\n\n

for i in 0..transaction.input.len() {\n    assert_eq!(\n        descriptor_for_input[i].max_weight_to_satisfy(),\n        transaction.input[i].legacy_weight() - TxIn::default().legacy_weight()\n    );\n}

Assumes all ECDSA signatures are 73 bytes, including push opcode and\nsighash suffix.\nAssumes all Schnorr signatures are 66 bytes, including push opcode and\nsighash suffix.

Â§Errors

When the descriptor is impossible to safisfy (ex: sh(OP_FALSE)).

pub fn max_satisfaction_weight(&self) -> Result<usize, Error>

Computes an upper bound on the weight of a satisfying witness to the\ntransaction.

Assumes all ec-signatures are 73 bytes, including push opcode and\nsighash suffix. Includes the weight of the VarInts encoding the\nscriptSig and witness stack length.

Â§Errors

When the descriptor is impossible to safisfy (ex: sh(OP_FALSE)).

",0,"bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl DescriptorExt for Descriptor<DescriptorPublicKey>

fn dust_value(&self) -> u64

Returns the minimum value (in satoshis) at which an output is broadcastable.\nPanics if the descriptor wildcard is hardened.

fn descriptor_id(&self) -> DescriptorId

Returns the descriptor ID, calculated as the sha256 hash of the spk derived from the\ndescriptor at index 0.

","DescriptorExt","bdk_wallet::descriptor::ExtendedDescriptor"],["

impl<'de, Pk> Deserialize<'de> for Descriptor<Pk>
where\n Pk: FromStrKey,

fn deserialize<D>(\n deserializer: D\n) -> Result<Descriptor<Pk>, <D as Deserializer<'de>>::Error>
where\n D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

","Deserialize<'de>","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> Display for Descriptor<Pk>
where\n Pk: MiniscriptKey,

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

Formats the value using the given formatter. Read more

","Display","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl ExtractPolicy for Descriptor<DescriptorPublicKey>

fn extract_policy(\n &self,\n signers: &SignersContainer,\n build_sat: BuildSatisfaction<'_>,\n secp: &Secp256k1<All>\n) -> Result<Option<Policy>, Error>

Extract the spending policy

","ExtractPolicy","bdk_wallet::descriptor::ExtendedDescriptor"],["

impl<Pk> ForEachKey<Pk> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn for_each_key<'a, F>(&'a self, pred: F) -> bool
where\n F: FnMut(&'a Pk) -> bool,

Run a predicate on every key in the descriptor, returning whether\nthe predicate returned true for every key

fn for_any_key<'a, F>(&'a self, pred: F) -> bool
where\n F: FnMut(&'a Pk) -> bool,\n Pk: 'a,

Run a predicate on every key in the descriptor, returning whether\nthe predicate returned true for any key

","ForEachKey","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> From<Bare<Pk>> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn from(inner: Bare<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

","From>","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn from(inner: Pkh<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

","From>","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> From<Sh<Pk>> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn from(inner: Sh<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

","From>","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> From<Tr<Pk>> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn from(inner: Tr<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

","From>","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

","From>","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn from(inner: Wsh<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

","From>","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> FromStr for Descriptor<Pk>
where\n Pk: FromStrKey,

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Descriptor<Pk>, Error>

Parses a string s to return a value of this type. Read more

","FromStr","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> FromTree for Descriptor<Pk>
where\n Pk: FromStrKey,

fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>

Parse an expression tree into a descriptor.

","FromTree","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> Hash for Descriptor<Pk>
where\n Pk: Hash + MiniscriptKey,

fn hash<H>(&self, state: &mut H)
where\n __H: Hasher,

Feeds this value into the given Hasher. Read more

1.3.0 Â· sourceÂ§

fn hash_slice<H>(data: &[Self], state: &mut H)
where\n H: Hasher,\n Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

","Hash","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> Liftable<Pk> for Descriptor<Pk>
where\n Pk: MiniscriptKey,

fn lift(&self) -> Result<Policy<Pk>, Error>

Converts this object into an abstract policy.

","Liftable","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> Ord for Descriptor<Pk>
where\n Pk: Ord + MiniscriptKey,

fn cmp(&self, other: &Descriptor<Pk>) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 Â· sourceÂ§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 Â· sourceÂ§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 Â· sourceÂ§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more

","Ord","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> PartialEq for Descriptor<Pk>
where\n Pk: PartialEq + MiniscriptKey,

fn eq(&self, other: &Descriptor<Pk>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.

1.0.0 Â· sourceÂ§

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

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.

","PartialEq","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> PartialOrd for Descriptor<Pk>
where\n Pk: PartialOrd + MiniscriptKey,

fn partial_cmp(&self, other: &Descriptor<Pk>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 Â· sourceÂ§

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 Â· sourceÂ§

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

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more

1.0.0 Â· sourceÂ§

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 Â· sourceÂ§

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

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more

","PartialOrd","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<'de, Pk> Serialize for Descriptor<Pk>
where\n Pk: MiniscriptKey,

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

Serialize this value into the given Serde serializer. Read more

","Serialize","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<P, Q> TranslatePk<P, Q> for Descriptor
where\n P: MiniscriptKey,\n Q: MiniscriptKey,

fn translate_pk<T, E>(\n &self,\n t: &mut T\n) -> Result<<Descriptor as TranslatePk<P, Q>>::Output, TranslateErr<E>>
where\n T: Translator<P, Q, E>,

Converts a descriptor using abstract keys to one using specific keys.

type Output = Descriptor<Q>

The associated output type. This must be Self<Q>.

","TranslatePk","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["

impl<Pk> Eq for Descriptor<Pk>
where\n Pk: Eq + MiniscriptKey,

","Eq","bdk_wallet::descriptor::ExtendedDescriptor","bdk_wallet::descriptor::DerivedDescriptor"],["