From dc16cb55b96de0bb9035c40f8f05fd9806e33c88 Mon Sep 17 00:00:00 2001 From: github-actions Date: Thu, 2 Feb 2023 02:13:05 +0000 Subject: [PATCH] Publish autogenerated nightly docs --- .../bdk/descriptor/template/struct.Bip49Public.html | 2 +- .../bdk/descriptor/template/struct.Bip84Public.html | 2 +- .../bdk/nightly/latest/bdk/keys/fn.any_network.html | 4 ++-- .../docs-rs/bdk/nightly/latest/bdk/keys/index.html | 2 +- .../bdk/nightly/latest/bdk/keys/sidebar-items.js | 2 +- .../nightly/latest/bdk/keys/trait.DerivableKey.html | 2 +- .../bdk/nightly/latest/bdk/psbt/trait.PsbtUtils.html | 2 +- .../bdk/nightly/latest/bdk/struct.Balance.html | 12 ++++++------ .../bdk/nightly/latest/bdk/struct.BlockTime.html | 10 +++++----- .../latest/bdk/struct.TransactionDetails.html | 8 ++++---- .../nightly/latest/bdk/type.ConfirmationTime.html | 2 +- .../docs-rs/bdk/nightly/latest/bdk/wallet/index.html | 2 +- .../bdk/nightly/latest/bdk/wallet/sidebar-items.js | 2 +- .../latest/bdk/wallet/struct.AddressInfo.html | 4 ++-- .../docs-rs/bdk/nightly/latest/search-index.js | 2 +- .../latest/src/bdk/descriptor/template.rs.html | 4 ++-- .../bdk/nightly/latest/src/bdk/keys/mod.rs.html | 6 +++--- .../bdk/nightly/latest/src/bdk/psbt/mod.rs.html | 2 +- .../docs-rs/bdk/nightly/latest/src/bdk/types.rs.html | 4 +--- .../bdk/nightly/latest/src/bdk/wallet/mod.rs.html | 2 +- 20 files changed, 37 insertions(+), 39 deletions(-) diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/template/struct.Bip49Public.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/template/struct.Bip49Public.html index 8ef34fbc45..4233e3a1b7 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/template/struct.Bip49Public.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/template/struct.Bip49Public.html @@ -1,6 +1,6 @@ Bip49Public in bdk::descriptor::template - Rust
pub struct Bip49Public<K: DerivableKey<Segwitv0>>(pub K, pub Fingerprint, pub KeychainKind);
Expand description

BIP49 public template. Expands to sh(wpkh(key/{0,1}/*))

-

This assumes that the key used has already been derived with m/49'/0'/0'.

+

This assumes that the key used has already been derived with m/49'/0'/0' for Mainnet or m/49'/1'/0' for Testnet.

This template requires the parent fingerprint to populate correctly the metadata of PSBTs.

See Bip49 for a template that does the full derivation, but requires private data for the key.

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/template/struct.Bip84Public.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/template/struct.Bip84Public.html index bb35801fe7..e10efcd032 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/template/struct.Bip84Public.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/template/struct.Bip84Public.html @@ -1,6 +1,6 @@ Bip84Public in bdk::descriptor::template - Rust
pub struct Bip84Public<K: DerivableKey<Segwitv0>>(pub K, pub Fingerprint, pub KeychainKind);
Expand description

BIP84 public template. Expands to wpkh(key/{0,1}/*)

-

This assumes that the key used has already been derived with m/84'/0'/0'.

+

This assumes that the key used has already been derived with m/84'/0'/0' for Mainnet or m/84'/1'/0' for Testnet.

This template requires the parent fingerprint to populate correctly the metadata of PSBTs.

See Bip84 for a template that does the full derivation, but requires private data for the key.

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/fn.any_network.html index 9d82bdf14e..25df445c11 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/fn.any_network.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/fn.any_network.html @@ -1,3 +1,3 @@ -any_network in bdk::keys - Rust

Function bdk::keys::any_network

source ·
pub fn any_network() -> ValidNetworks
Expand description

Create a set containing mainnet, testnet and regtest

+any_network in bdk::keys - Rust

Function bdk::keys::any_network

source ·
pub fn any_network() -> ValidNetworks
Expand description

Create a set containing mainnet, testnet, signet, and regtest

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/index.html index 8ad57dba0c..2731f3e349 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/index.html @@ -3,4 +3,4 @@

Modules

bip39keys-bip39
BIP-0039

Structs

Output of a GeneratableKey key generation
Options for generating a [PrivateKey]
A descriptor [bitcoin::PrivateKey] with optional origin information.
A descriptor SinglePubKey with optional origin information.
Contents of a “sortedmulti” descriptor

Enums

Container for public or secret keys
The descriptor pubkey, either a single pubkey or an xpub.
The descriptor secret key, either a single private key or an xprv.
Enum for extended keys that can be either xprv or xpub
Errors thrown while working with keys
Enum representation of the known valid ScriptContexts
Single public key without any origin or range information.

Traits

Trait for keys that can be derived.
Trait that adds extra useful methods to ScriptContexts
Trait that allows generating a key with the default options
Trait for keys that can be generated
Trait for objects that can be turned into a public or secret DescriptorKey
The ScriptContext for Miniscript. Additional type information associated with miniscript that is used for carrying out checks that dependent on the context under which the script is used. -For example, disallowing uncompressed keys in Segwit context

Functions

Create a set containing mainnet, testnet and regtest
Create a set only containing mainnet
Compute the intersection of two sets
Create a set containing testnet and regtest

Type Definitions

Alias type for a map of public key to secret key
Set of valid networks for a key
\ No newline at end of file +For example, disallowing uncompressed keys in Segwit context

Functions

Create a set containing mainnet, testnet, signet, and regtest
Create a set only containing mainnet
Compute the intersection of two sets
Create a set containing testnet and regtest

Type Definitions

Alias type for a map of public key to secret key
Set of valid networks for a key
\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/sidebar-items.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/sidebar-items.js index 9e4dddf388..7ccece3a39 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/sidebar-items.js +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/sidebar-items.js @@ -1 +1 @@ -window.SIDEBAR_ITEMS = {"enum":[["DescriptorKey","Container for public or secret keys"],["DescriptorPublicKey","The descriptor pubkey, either a single pubkey or an xpub."],["DescriptorSecretKey","The descriptor secret key, either a single private key or an xprv."],["ExtendedKey","Enum for extended keys that can be either `xprv` or `xpub`"],["KeyError","Errors thrown while working with `keys`"],["ScriptContextEnum","Enum representation of the known valid [`ScriptContext`]s"],["SinglePubKey","Single public key without any origin or range information."]],"fn":[["any_network","Create a set containing mainnet, testnet and regtest"],["mainnet_network","Create a set only containing mainnet"],["merge_networks","Compute the intersection of two sets"],["test_networks","Create a set containing testnet and regtest"]],"mod":[["bip39","BIP-0039"]],"struct":[["GeneratedKey","Output of a [`GeneratableKey`] key generation"],["PrivateKeyGenerateOptions","Options for generating a [`PrivateKey`]"],["SinglePriv","A descriptor [`bitcoin::PrivateKey`] with optional origin information."],["SinglePub","A descriptor [`SinglePubKey`] with optional origin information."],["SortedMultiVec","Contents of a “sortedmulti” descriptor"]],"trait":[["DerivableKey","Trait for keys that can be derived."],["ExtScriptContext","Trait that adds extra useful methods to [`ScriptContext`]s"],["GeneratableDefaultOptions","Trait that allows generating a key with the default options"],["GeneratableKey","Trait for keys that can be generated"],["IntoDescriptorKey","Trait for objects that can be turned into a public or secret [`DescriptorKey`]"],["ScriptContext","The ScriptContext for Miniscript. Additional type information associated with miniscript that is used for carrying out checks that dependent on the context under which the script is used. For example, disallowing uncompressed keys in Segwit context"]],"type":[["KeyMap","Alias type for a map of public key to secret key"],["ValidNetworks","Set of valid networks for a key"]]}; \ No newline at end of file +window.SIDEBAR_ITEMS = {"enum":[["DescriptorKey","Container for public or secret keys"],["DescriptorPublicKey","The descriptor pubkey, either a single pubkey or an xpub."],["DescriptorSecretKey","The descriptor secret key, either a single private key or an xprv."],["ExtendedKey","Enum for extended keys that can be either `xprv` or `xpub`"],["KeyError","Errors thrown while working with `keys`"],["ScriptContextEnum","Enum representation of the known valid [`ScriptContext`]s"],["SinglePubKey","Single public key without any origin or range information."]],"fn":[["any_network","Create a set containing mainnet, testnet, signet, and regtest"],["mainnet_network","Create a set only containing mainnet"],["merge_networks","Compute the intersection of two sets"],["test_networks","Create a set containing testnet and regtest"]],"mod":[["bip39","BIP-0039"]],"struct":[["GeneratedKey","Output of a [`GeneratableKey`] key generation"],["PrivateKeyGenerateOptions","Options for generating a [`PrivateKey`]"],["SinglePriv","A descriptor [`bitcoin::PrivateKey`] with optional origin information."],["SinglePub","A descriptor [`SinglePubKey`] with optional origin information."],["SortedMultiVec","Contents of a “sortedmulti” descriptor"]],"trait":[["DerivableKey","Trait for keys that can be derived."],["ExtScriptContext","Trait that adds extra useful methods to [`ScriptContext`]s"],["GeneratableDefaultOptions","Trait that allows generating a key with the default options"],["GeneratableKey","Trait for keys that can be generated"],["IntoDescriptorKey","Trait for objects that can be turned into a public or secret [`DescriptorKey`]"],["ScriptContext","The ScriptContext for Miniscript. Additional type information associated with miniscript that is used for carrying out checks that dependent on the context under which the script is used. For example, disallowing uncompressed keys in Segwit context"]],"type":[["KeyMap","Alias type for a map of public key to secret key"],["ValidNetworks","Set of valid networks for a key"]]}; \ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/trait.DerivableKey.html index f0b6ed90ee..1900a15ebc 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/trait.DerivableKey.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/trait.DerivableKey.html @@ -9,7 +9,7 @@ for (DerivableKey, DerivationPath) and (DerivableKey, KeySource, DerivationPath) tuples.

For key types that don’t encode any indication about the path to use (like bip39), it’s -generally recommended to implemented this trait instead of IntoDescriptorKey. The same +generally recommended to implement this trait instead of IntoDescriptorKey. The same rules regarding script context and valid networks apply.

Examples

Key types that can be directly converted into an ExtendedPrivKey or diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/psbt/trait.PsbtUtils.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/psbt/trait.PsbtUtils.html index f771c9a156..a6ee42fa14 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/psbt/trait.PsbtUtils.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/psbt/trait.PsbtUtils.html @@ -5,7 +5,7 @@ fn fee_rate(&self) -> Option<FeeRate>; }

Expand description

Trait to add functions to extract utxos and calculate fees.

Required Methods§

Get the TxOut for the specified input index, if it doesn’t exist in the PSBT None is returned.

-

The total transaction fee amount, sum of input amounts minus sum of output amounts, in Sats. +

The total transaction fee amount, sum of input amounts minus sum of output amounts, in sats. If the PSBT is missing a TxOut for an input returns None.

The transaction’s fee rate. This value will only be accurate if calculated AFTER the PartiallySignedTransaction is finalized and all witness/signature data is added to the diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/struct.Balance.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/struct.Balance.html index 6a556b410f..de7d4ef319 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/struct.Balance.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/struct.Balance.html @@ -1,5 +1,5 @@ Balance in bdk - Rust

Struct bdk::Balance

source ·
pub struct Balance {
+                    logo

Balance

Struct bdk::Balance

source ·
pub struct Balance {
     pub immature: u64,
     pub trusted_pending: u64,
     pub untrusted_pending: u64,
@@ -9,12 +9,12 @@
 
§trusted_pending: u64

Unconfirmed UTXOs generated by a wallet tx

§untrusted_pending: u64

Unconfirmed UTXOs received from an external wallet

§confirmed: u64

Confirmed and immediately spendable balance

-

Implementations§

Get sum of trusted_pending and confirmed coins

-

Get the whole balance visible to the wallet

-

Trait Implementations§

The resulting type after applying the + operator.
Performs the + operation. Read more
Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
Deserialize this value from the given Serde deserializer. Read more
Formats the value using the given formatter. Read more
This method tests for self and other values to be equal, and is used +

Implementations§

Get sum of trusted_pending and confirmed coins

+

Get the whole balance visible to the wallet

+

Trait Implementations§

The resulting type after applying the + operator.
Performs the + operation. Read more
Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
Deserialize this value from the given Serde deserializer. Read more
Formats the value using the given formatter. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason. Read more
Serialize this value into the given Serde serializer. Read more
Method which takes an iterator and generates Self from the elements by -“summing up” the items. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

+sufficient, and should not be overridden without very good reason. Read more
Serialize this value into the given Serde serializer. Read more
Method which takes an iterator and generates Self from the elements by +“summing up” the items. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/struct.BlockTime.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/struct.BlockTime.html index fa50bf83e8..ff0b97cc82 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/struct.BlockTime.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/struct.BlockTime.html @@ -1,16 +1,16 @@ BlockTime in bdk - Rust

Struct bdk::BlockTime

source ·
pub struct BlockTime {
+                    logo

BlockTime

Struct bdk::BlockTime

source ·
pub struct BlockTime {
     pub height: u32,
     pub timestamp: u64,
 }
Expand description

Block height and timestamp of a block

Fields§

§height: u32

confirmation block height

§timestamp: u64

confirmation block timestamp

-

Implementations§

Returns Some BlockTime if both height and timestamp are Some

-

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
Deserialize this value from the given Serde deserializer. Read more
Converts to this type from the input type.
This method returns an Ordering between self and other. Read more
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
Restrict a value to a certain interval. Read more
This method tests for self and other values to be equal, and is used +

Implementations§

Returns Some BlockTime if both height and timestamp are Some

+

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
Deserialize this value from the given Serde deserializer. Read more
Converts to this type from the input type.
This method returns an Ordering between self and other. Read more
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
Restrict a value to a certain interval. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason. Read more
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= +sufficient, and should not be overridden without very good reason. Read more
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

+operator. Read more
Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/struct.TransactionDetails.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/struct.TransactionDetails.html index 5444bcad30..eaeb893b26 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/struct.TransactionDetails.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/struct.TransactionDetails.html @@ -1,5 +1,5 @@ TransactionDetails in bdk - Rust

Struct bdk::TransactionDetails

source ·
pub struct TransactionDetails {
+                    logo

TransactionDetails

Struct bdk::TransactionDetails

source ·
pub struct TransactionDetails {
     pub transaction: Option<Transaction>,
     pub txid: Txid,
     pub received: u64,
@@ -17,11 +17,11 @@ Sum of owned inputs of this transaction.

The availability of the fee depends on the backend. It’s never None with an Electrum Server backend, but it could be None with a Bitcoin RPC node without txindex that receive funds while offline.

-
§confirmation_time: Option<BlockTime>

If the transaction is confirmed, contains height and timestamp of the block containing the +

§confirmation_time: Option<BlockTime>

If the transaction is confirmed, contains height and Unix timestamp of the block containing the transaction, unconfirmed transaction contains None.

-

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Deserialize this value from the given Serde deserializer. Read more
This method returns an Ordering between self and other. Read more
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
Restrict a value to a certain interval. Read more
This method tests for self and other values to be equal, and is used +

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Deserialize this value from the given Serde deserializer. Read more
This method returns an Ordering between self and other. Read more
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
Restrict a value to a certain interval. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason. Read more
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= +sufficient, and should not be overridden without very good reason. Read more
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/type.ConfirmationTime.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/type.ConfirmationTime.html index 17fa2127fa..bea7bb14d2 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/type.ConfirmationTime.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/type.ConfirmationTime.html @@ -1,4 +1,4 @@ ConfirmationTime in bdk - Rust

Type Definition bdk::ConfirmationTime

source ·
pub type ConfirmationTime = BlockTime;
👎Deprecated: This structure has been renamed to BlockTime
Expand description

DEPRECATED: Confirmation time of a transaction

+ logo

ConfirmationTime

Type Definition bdk::ConfirmationTime

source ·
pub type ConfirmationTime = BlockTime;
👎Deprecated: This structure has been renamed to BlockTime
Expand description

DEPRECATED: Confirmation time of a transaction

The structure has been renamed to BlockTime

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/index.html index 98c0391d69..db13000761 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/index.html @@ -1,7 +1,7 @@ bdk::wallet - Rust

Module bdk::wallet

source ·
Expand description

Wallet

This module defines the Wallet structure.

-

Modules

Coin selection
Wallet export
hardwaresignerhardware-signer
HWI Signer
Generalized signers
Cross-platform time
Transaction builder
verifyverify
Verify transactions against the consensus rules

Structs

A derived address and the index it was found at +

Modules

Coin selection
Wallet export
hardwaresignerhardware-signer
HWI Signer
Generalized signers
Cross-platform time
Transaction builder
verifyverify
Verify transactions against the consensus rules

Structs

A derived address and the index it was found at. For convenience this automatically derefs to Address
Options to a sync.
A Bitcoin wallet

Enums

The address index selection strategy to use to derived an address from the wallet’s external descriptor. See Wallet::get_address. If you’re unsure which one to use use WalletIndex::New.

Traits

Trait to check if a value is below the dust limit. We are performing dust value calculation for a given script public key using rust-bitcoin to diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/sidebar-items.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/sidebar-items.js index ce79156216..8319a96a9d 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/sidebar-items.js +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/sidebar-items.js @@ -1 +1 @@ -window.SIDEBAR_ITEMS = {"enum":[["AddressIndex","The address index selection strategy to use to derived an address from the wallet’s external descriptor. See [`Wallet::get_address`]. If you’re unsure which one to use use `WalletIndex::New`."]],"fn":[["get_funded_wallet","Return a fake wallet that appears to be funded for testing."],["wallet_name_from_descriptor","Deterministically generate a unique name given the descriptors defining the wallet"]],"mod":[["coin_selection","Coin selection"],["export","Wallet export"],["hardwaresigner","HWI Signer"],["signer","Generalized signers"],["time","Cross-platform time"],["tx_builder","Transaction builder"],["verify","Verify transactions against the consensus rules"]],"struct":[["AddressInfo","A derived address and the index it was found at For convenience this automatically derefs to `Address`"],["SyncOptions","Options to a `sync`."],["Wallet","A Bitcoin wallet"]],"trait":[["IsDust","Trait to check if a value is below the dust limit. We are performing dust value calculation for a given script public key using rust-bitcoin to keep it compatible with network dust rate"]]}; \ No newline at end of file +window.SIDEBAR_ITEMS = {"enum":[["AddressIndex","The address index selection strategy to use to derived an address from the wallet’s external descriptor. See [`Wallet::get_address`]. If you’re unsure which one to use use `WalletIndex::New`."]],"fn":[["get_funded_wallet","Return a fake wallet that appears to be funded for testing."],["wallet_name_from_descriptor","Deterministically generate a unique name given the descriptors defining the wallet"]],"mod":[["coin_selection","Coin selection"],["export","Wallet export"],["hardwaresigner","HWI Signer"],["signer","Generalized signers"],["time","Cross-platform time"],["tx_builder","Transaction builder"],["verify","Verify transactions against the consensus rules"]],"struct":[["AddressInfo","A derived address and the index it was found at. For convenience this automatically derefs to `Address`"],["SyncOptions","Options to a `sync`."],["Wallet","A Bitcoin wallet"]],"trait":[["IsDust","Trait to check if a value is below the dust limit. We are performing dust value calculation for a given script public key using rust-bitcoin to keep it compatible with network dust rate"]]}; \ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.AddressInfo.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.AddressInfo.html index c8b7bdc622..b03187bc96 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.AddressInfo.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.AddressInfo.html @@ -1,9 +1,9 @@ -AddressInfo in bdk::wallet - Rust