From: github-actions Date: Mon, 24 Oct 2022 09:03:59 +0000 (+0000) Subject: Publish autogenerated nightly docs X-Git-Url: http://internal-gitweb-vhost/script/%22https:/database/scripts/struct.ScriptBuf.html?a=commitdiff_plain;h=ae5553e621e405edee95748ef91ff13c348d6f3f;p=bitcoindevkit.org Publish autogenerated nightly docs --- diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/fn.version.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/fn.version.html index b5a3aab062..d396fd94a0 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/fn.version.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/fn.version.html @@ -6,6 +6,6 @@ logo

In bdk

logo
-

Function bdk::version

source · [−]
pub fn version() -> &'static str
Expand description

Get the version of BDK at runtime

+

Function bdk::version

source · [−]
pub fn version() -> &'static str
Expand description

Get the version of BDK at runtime

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html index 1cefe93482..944d33a366 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html @@ -6,7 +6,7 @@ logo

Crate bdk

logo
-

Crate bdk

source · [−]
Expand description

A modern, lightweight, descriptor-based wallet library written in Rust.

+

Crate bdk

source · [−]
Expand description

A modern, lightweight, descriptor-based wallet library written in Rust.

About

The BDK library aims to be the core building block for Bitcoin wallets of any kind.

    @@ -149,7 +149,7 @@ BDK.

  • key-value-db: key value database based on sled for caching blockchain data

Re-exports

-
pub extern crate bitcoin;
pub extern crate bitcoincore_rpc;
pub extern crate electrum_client;
pub extern crate esplora_client;
pub extern crate miniscript;
pub extern crate rusqlite;
pub extern crate sled;
pub use descriptor::template;
pub use descriptor::HdKeyPaths;
pub use wallet::address_validator;
pub use wallet::signer;
pub use wallet::signer::SignOptions;
pub use wallet::tx_builder::TxBuilder;
pub use wallet::SyncOptions;
pub use wallet::Wallet;

Modules

+
pub extern crate bitcoin;
pub extern crate bitcoincore_rpc;
pub extern crate electrum_client;
pub extern crate esplora_client;
pub extern crate hwi;
pub extern crate miniscript;
pub extern crate rusqlite;
pub extern crate sled;
pub use descriptor::template;
pub use descriptor::HdKeyPaths;
pub use wallet::address_validator;
pub use wallet::signer;
pub use wallet::signer::SignOptions;
pub use wallet::tx_builder::TxBuilder;
pub use wallet::SyncOptions;
pub use wallet::Wallet;

Modules

blockchain

Blockchain backends

database

Database types

descriptor

Descriptors

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/sidebar-items.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/sidebar-items.js index 13fd4a2458..e970e9c663 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/sidebar-items.js +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/sidebar-items.js @@ -1 +1 @@ -initSidebarItems({"enum":[["Error","Errors that can be thrown by the `Wallet`"],["KeychainKind","Types of keychains"],["Utxo","An unspent transaction output (UTXO)."]],"externcrate":[["bitcoin",""],["bitcoincore_rpc",""],["electrum_client",""],["esplora_client",""],["miniscript",""],["rusqlite",""],["sled",""]],"fn":[["version","Get the version of BDK at runtime"]],"macro":[["descriptor","Macro to write full descriptors with code"],["fragment","Macro to write descriptor fragments with code"]],"mod":[["blockchain","Blockchain backends"],["database","Database types"],["descriptor","Descriptors"],["keys","Key formats"],["psbt","Additional functions on the `rust-bitcoin` `PartiallySignedTransaction` structure."],["wallet","Wallet"]],"struct":[["Balance","Balance differentiated in various categories"],["BlockTime","Block height and timestamp of a block"],["FeeRate","Fee rate"],["LocalUtxo","An unspent output owned by a `Wallet`."],["TransactionDetails","A wallet transaction"],["WeightedUtxo","A [`Utxo`] with its `satisfaction_weight`."]],"trait":[["Vbytes","Trait implemented by types that can be used to measure weight units."]],"type":[["ConfirmationTime","DEPRECATED: Confirmation time of a transaction"]]}); \ No newline at end of file +initSidebarItems({"enum":[["Error","Errors that can be thrown by the `Wallet`"],["KeychainKind","Types of keychains"],["Utxo","An unspent transaction output (UTXO)."]],"externcrate":[["bitcoin",""],["bitcoincore_rpc",""],["electrum_client",""],["esplora_client",""],["hwi",""],["miniscript",""],["rusqlite",""],["sled",""]],"fn":[["version","Get the version of BDK at runtime"]],"macro":[["descriptor","Macro to write full descriptors with code"],["fragment","Macro to write descriptor fragments with code"]],"mod":[["blockchain","Blockchain backends"],["database","Database types"],["descriptor","Descriptors"],["keys","Key formats"],["psbt","Additional functions on the `rust-bitcoin` `PartiallySignedTransaction` structure."],["wallet","Wallet"]],"struct":[["Balance","Balance differentiated in various categories"],["BlockTime","Block height and timestamp of a block"],["FeeRate","Fee rate"],["LocalUtxo","An unspent output owned by a `Wallet`."],["TransactionDetails","A wallet transaction"],["WeightedUtxo","A [`Utxo`] with its `satisfaction_weight`."]],"trait":[["Vbytes","Trait implemented by types that can be used to measure weight units."]],"type":[["ConfirmationTime","DEPRECATED: Confirmation time of a transaction"]]}); \ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/hardwaresigner/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/hardwaresigner/index.html index b215321a49..3b705657b7 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/hardwaresigner/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/hardwaresigner/index.html @@ -6,8 +6,21 @@ logo

Module hardwaresigner

logo
-

Module bdk::wallet::hardwaresigner

source · [−]
This is supported on crate feature hardware-signer only.
Expand description

HWI Signer

-

This module contains a simple implementation of a Custom signer for rust-hwi

+

Module bdk::wallet::hardwaresigner

source · [−]
This is supported on crate feature hardware-signer only.
Expand description

HWI Signer

+

This module contains HWISigner, an implementation of a TransactionSigner to be +used with hardware wallets.

+ +
let devices = HWIClient::enumerate()?;
+let first_device = devices.first().expect("No devices found!");
+let custom_signer = HWISigner::from_device(first_device, HWIChain::Test)?;
+
+// Adding the hardware signer to the BDK wallet
+wallet.add_signer(
+    KeychainKind::External,
+    SignerOrdering(200),
+    Arc::new(custom_signer),
+);
+

Structs

HWISigner

Custom signer for Hardware Wallets

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/hardwaresigner/struct.HWISigner.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/hardwaresigner/struct.HWISigner.html index ed459eb787..3bc32a9ae0 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/hardwaresigner/struct.HWISigner.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/hardwaresigner/struct.HWISigner.html @@ -6,14 +6,14 @@ logo

HWISigner

Associated Constants

ALIGN

Methods

from_device

Trait Implementations

DebugSignerCommonTransactionSigner

Auto Trait Implementations

!RefUnwindSafeSendSyncUnpinUnwindSafe

Blanket Implementations

AnyBorrow<T>BorrowMut<T>From<T>Into<U>PointableTryFrom<U>TryInto<U>VZip<V>

In bdk::wallet::hardwaresigner

logo
-

Struct bdk::wallet::hardwaresigner::HWISigner

source · [−]
pub struct HWISigner { /* private fields */ }
This is supported on crate feature hardware-signer only.
Expand description

Custom signer for Hardware Wallets

+

Struct bdk::wallet::hardwaresigner::HWISigner

source · [−]
pub struct HWISigner { /* private fields */ }
This is supported on crate feature hardware-signer only.
Expand description

Custom signer for Hardware Wallets

This ignores sign_options and leaves the decisions up to the hardware wallet.

-

Implementations

Create a instance from the specified device and chain

-

Trait Implementations

Formats the value using the given formatter. Read more

-

Return the SignerId for this signer Read more

+

Implementations

Create a instance from the specified device and chain

+

Trait Implementations

Formats the value using the given formatter. Read more

+

Return the SignerId for this signer Read more

Return the secret key for the signer Read more

-

This implementation ignores sign_options

-

Sign all the inputs of the psbt

+

This implementation ignores sign_options

+

Sign all the inputs of the psbt

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

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/signer/trait.SignerCommon.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/signer/trait.SignerCommon.html index 826d44f3f1..c9e8ee9cd4 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/signer/trait.SignerCommon.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/signer/trait.SignerCommon.html @@ -18,5 +18,5 @@ compare two signers.

This is used internally to reconstruct the original descriptor that may contain secrets. External signers that are meant to keep key isolated should just return None here (which is the default for this method, if not overridden).

-

Implementors

+

Implementors

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/signer/trait.TransactionSigner.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/signer/trait.TransactionSigner.html index a46f6d2f6d..0de39708c2 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/signer/trait.TransactionSigner.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/signer/trait.TransactionSigner.html @@ -12,6 +12,6 @@

This trait can be implemented when the signer can’t sign inputs individually, but signs the whole transaction at once.

Required methods

Sign all the inputs of the psbt

-

Implementors

This implementation ignores sign_options

+

Implementors

This implementation ignores sign_options

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/lib.rs.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/lib.rs.html index ff9a4a0e97..fdeba228ab 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/lib.rs.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/lib.rs.html @@ -289,6 +289,8 @@ 282 283 284 +285 +286 
// Bitcoin Dev Kit
 // Written in 2020 by Alekos Filini <alekos.filini@gmail.com>
 //
@@ -494,6 +496,8 @@ fn main() -> Result<(), bdk::Error> {
 extern crate serde;
 #[macro_use]
 extern crate serde_json;
+#[cfg(feature = "hardware-signer")]
+pub extern crate hwi;
 
 #[cfg(all(feature = "reqwest", feature = "ureq"))]
 compile_error!("Features reqwest and ureq are mutually exclusive and cannot be enabled together");
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/wallet/hardwaresigner.rs.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/wallet/hardwaresigner.rs.html
index 4e3e967f8b..bb2d1e8bcd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/wallet/hardwaresigner.rs.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/wallet/hardwaresigner.rs.html
@@ -69,6 +69,39 @@
 62
 63
 64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
 
// Bitcoin Dev Kit
 // Written in 2020 by Alekos Filini <alekos.filini@gmail.com>
 //
@@ -82,7 +115,40 @@
 
 //! HWI Signer
 //!
-//! This module contains a simple implementation of a Custom signer for rust-hwi
+//! This module contains HWISigner, an implementation of a [TransactionSigner] to be
+//! used with hardware wallets.
+//! ```no_run
+//! # use bdk::bitcoin::Network;
+//! # use bdk::database::MemoryDatabase;
+//! # use bdk::signer::SignerOrdering;
+//! # use bdk::wallet::hardwaresigner::HWISigner;
+//! # use bdk::wallet::AddressIndex::New;
+//! # use bdk::{FeeRate, KeychainKind, SignOptions, SyncOptions, Wallet};
+//! # use hwi::{types::HWIChain, HWIClient};
+//! # use std::sync::Arc;
+//! #
+//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
+//! let devices = HWIClient::enumerate()?;
+//! let first_device = devices.first().expect("No devices found!");
+//! let custom_signer = HWISigner::from_device(first_device, HWIChain::Test)?;
+//!
+//! # let mut wallet = Wallet::new(
+//! #     "",
+//! #     None,
+//! #     Network::Testnet,
+//! #     MemoryDatabase::default(),
+//! # )?;
+//! #
+//! // Adding the hardware signer to the BDK wallet
+//! wallet.add_signer(
+//!     KeychainKind::External,
+//!     SignerOrdering(200),
+//!     Arc::new(custom_signer),
+//! );
+//!
+//! # Ok(())
+//! # }
+//! ```
 
 use bitcoin::psbt::PartiallySignedTransaction;
 use bitcoin::secp256k1::{All, Secp256k1};