From 23dc6d4a20b55c0e2f4b470846778661fa7d68bb Mon Sep 17 00:00:00 2001 From: github-actions Date: Tue, 15 Dec 2020 11:29:49 +0000 Subject: [PATCH] Publish autogenerated nightly docs --- .../blockchain/esplora/enum.EsploraError.html | 6 +- .../bdk/descriptor/enum.Descriptor.html | 2 +- .../descriptor/policy/enum.PolicyError.html | 8 +- .../policy/enum.SatisfiableItem.html | 2 +- .../latest/bdk/descriptor/policy/index.html | 2 +- .../descriptor/policy/struct.Condition.html | 2 +- .../bdk/descriptor/policy/struct.Policy.html | 6 +- .../bdk/descriptor/struct.Miniscript.html | 2 +- .../bdk/descriptor/trait.ExtractPolicy.html | 2 +- .../bdk/nightly/latest/bdk/enum.Error.html | 2 +- .../docs-rs/bdk/nightly/latest/bdk/index.html | 2 +- .../bdk/nightly/latest/bdk/wallet/index.html | 2 +- .../latest/bdk/wallet/struct.Wallet.html | 24 +- .../latest/bdk/wallet/trait.IsDust.html | 6 +- .../tx_builder/enum.ChangeSpendPolicy.html | 18 +- .../wallet/tx_builder/enum.TxOrdering.html | 18 +- .../latest/bdk/wallet/tx_builder/index.html | 2 +- .../wallet/tx_builder/struct.TxBuilder.html | 8 +- static/docs-rs/bdk/nightly/latest/rustdoc.css | 2 +- .../bdk/nightly/latest/search-index.js | 2 +- .../latest/src/bdk/descriptor/policy.rs.html | 34 ++- .../bdk/nightly/latest/src/bdk/error.rs.html | 2 +- .../nightly/latest/src/bdk/wallet/mod.rs.html | 80 +++++- .../latest/src/bdk/wallet/tx_builder.rs.html | 46 +++- .../latest/src/bdk/wallet/utils.rs.html | 240 ++++++++++++++++++ 25 files changed, 441 insertions(+), 79 deletions(-) diff --git a/static/docs-rs/bdk/nightly/latest/bdk/blockchain/esplora/enum.EsploraError.html b/static/docs-rs/bdk/nightly/latest/bdk/blockchain/esplora/enum.EsploraError.html index d3a6a72336..3a45d9599c 100644 --- a/static/docs-rs/bdk/nightly/latest/bdk/blockchain/esplora/enum.EsploraError.html +++ b/static/docs-rs/bdk/nightly/latest/bdk/blockchain/esplora/enum.EsploraError.html @@ -2,7 +2,7 @@

[][src]Enum bdk::blockchain::esplora::EsploraError

pub enum EsploraError {
-    Reqwest(Error),
+    Reqwest(Error),
     Parsing(ParseIntError),
     BitcoinEncoding(Error),
     Hex(Error),
@@ -12,7 +12,7 @@
 }
This is supported on crate feature esplora only.

Errors that can happen during a sync with EsploraBlockchain

Variants

-
Reqwest(Error)

Error with the HTTP call

+
Reqwest(Error)

Error with the HTTP call

Parsing(ParseIntError)

Invalid number returned

BitcoinEncoding(Error)

Invalid Bitcoin data returned

Hex(Error)

Invalid Hex data returned

@@ -25,7 +25,7 @@

impl From<Error> for EsploraError[src]

impl From<Error> for EsploraError[src]

impl From<Error> for EsploraError[src]

impl From<Error> for EsploraError[src]

impl From<EsploraError> for Error[src]

impl<Pk> Debug for Descriptor<Pk> where
    Pk: MiniscriptKey

impl<Pk> Display for Descriptor<Pk> where
    Pk: MiniscriptKey

impl<Pk> Eq for Descriptor<Pk> where
    Pk: MiniscriptKey + Eq

impl ExtractPolicy for Descriptor<DescriptorPublicKey>[src]

impl<Pk> Eq for Descriptor<Pk> where
    Pk: MiniscriptKey + Eq

impl ExtractPolicy for Descriptor<DescriptorPublicKey>[src]

impl<Pk> FromStr for Descriptor<Pk> where
    Pk: MiniscriptKey,
    <Pk as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: ToString

type Err = Error

The associated error which can be returned from parsing.

impl<Pk> FromTree for Descriptor<Pk> where
    Pk: MiniscriptKey,
    <Pk as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: ToString

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

Parse an expression tree into a descriptor

diff --git a/static/docs-rs/bdk/nightly/latest/bdk/descriptor/policy/enum.PolicyError.html b/static/docs-rs/bdk/nightly/latest/bdk/descriptor/policy/enum.PolicyError.html index 4a69c8f3af..c514b71eff 100644 --- a/static/docs-rs/bdk/nightly/latest/bdk/descriptor/policy/enum.PolicyError.html +++ b/static/docs-rs/bdk/nightly/latest/bdk/descriptor/policy/enum.PolicyError.html @@ -1,7 +1,7 @@ bdk::descriptor::policy::PolicyError - Rust

[][src]Enum bdk::descriptor::policy::PolicyError

pub enum PolicyError {
+                Change settings

[][src]Enum bdk::descriptor::policy::PolicyError

pub enum PolicyError {
     NotEnoughItemsSelected(String),
     TooManyItemsSelected(String),
     IndexOutOfRange(usize),
@@ -19,9 +19,9 @@
 
AddOnPartialComplete

Can not add to an item that is Satisfaction::PartialComplete

MixedTimelockUnits

Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000

IncompatibleConditions

Incompatible conditions (not currently used)

-

Trait Implementations

impl Debug for PolicyError[src]

impl Display for PolicyError[src]

impl Error for PolicyError[src]

Trait Implementations

impl Debug for PolicyError[src]

impl Display for PolicyError[src]

impl Error for PolicyError[src]

Trait Implementations

impl Clone for SatisfiableItem[src]

impl Debug for SatisfiableItem[src]

impl From<SatisfiableItem> for Policy[src]

impl From<SatisfiableItem> for Policy[src]

impl Serialize for SatisfiableItem[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

Loading content...

Implementors

impl ExtractPolicy for Descriptor<DescriptorPublicKey>[src]

impl<Ctx: ScriptContext> ExtractPolicy for Miniscript<DescriptorPublicKey, Ctx>[src]

Loading content...
\ No newline at end of file diff --git a/static/docs-rs/bdk/nightly/latest/bdk/enum.Error.html b/static/docs-rs/bdk/nightly/latest/bdk/enum.Error.html index 253cca9cce..f5c7105d62 100644 --- a/static/docs-rs/bdk/nightly/latest/bdk/enum.Error.html +++ b/static/docs-rs/bdk/nightly/latest/bdk/enum.Error.html @@ -65,7 +65,7 @@ the desired outputs plus fee, if there is not such combination this error is thr
UnknownUTXO

Happens when trying to spend an UTXO that is not in the internal database

TransactionNotFound

Thrown when a tx is not found in the internal database

TransactionConfirmed

Happens when trying to bump a transaction that is already confirmed

-
IrreplaceableTransaction

Trying to replace a tx that has a sequence = 0xFFFFFFFF

+
IrreplaceableTransaction

Trying to replace a tx that has a sequence >= 0xFFFFFFFE

FeeRateTooLow

When bumping a tx the fee rate requested is lower than required

Fields of FeeRateTooLow

required: FeeRate

Required fee rate (satoshi/vbyte)

FeeTooLow

When bumping a tx the absolute fee requested is lower than replaced tx absolute fee

diff --git a/static/docs-rs/bdk/nightly/latest/bdk/index.html b/static/docs-rs/bdk/nightly/latest/bdk/index.html index 1103952b0f..a8a575593b 100644 --- a/static/docs-rs/bdk/nightly/latest/bdk/index.html +++ b/static/docs-rs/bdk/nightly/latest/bdk/index.html @@ -148,7 +148,7 @@ BDK.

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

    -
    pub extern crate bitcoin;
    pub extern crate miniscript;
    pub extern crate electrum_client;
    pub extern crate reqwest;
    pub extern crate sled;
    pub use descriptor::template;
    pub use descriptor::HDKeyPaths;
    pub use wallet::address_validator;
    pub use wallet::signer;
    pub use wallet::tx_builder::TxBuilder;
    pub use wallet::OfflineWallet;
    pub use wallet::Wallet;

    Modules

    +
    pub extern crate bitcoin;
    pub extern crate miniscript;
    pub extern crate electrum_client;
    pub extern crate reqwest;
    pub extern crate sled;
    pub use descriptor::template;
    pub use descriptor::HDKeyPaths;
    pub use wallet::address_validator;
    pub use wallet::signer;
    pub use wallet::tx_builder::TxBuilder;
    pub use wallet::OfflineWallet;
    pub use wallet::Wallet;

    Modules

    blockchain

    Blockchain backends

    database

    Database types

    descriptor

    Descriptors

    diff --git a/static/docs-rs/bdk/nightly/latest/bdk/wallet/index.html b/static/docs-rs/bdk/nightly/latest/bdk/wallet/index.html index 7fca428c3a..513ce94f78 100644 --- a/static/docs-rs/bdk/nightly/latest/bdk/wallet/index.html +++ b/static/docs-rs/bdk/nightly/latest/bdk/wallet/index.html @@ -1,7 +1,7 @@ bdk::wallet - Rust

    [][src]Module bdk::wallet

    Wallet

    + Change settings

    [][src]Module bdk::wallet

    Wallet

    This module defines the Wallet structure.

    Modules

    address_validator

    Address validation callbacks

    diff --git a/static/docs-rs/bdk/nightly/latest/bdk/wallet/struct.Wallet.html b/static/docs-rs/bdk/nightly/latest/bdk/wallet/struct.Wallet.html index dfefecc151..f96733fe1e 100644 --- a/static/docs-rs/bdk/nightly/latest/bdk/wallet/struct.Wallet.html +++ b/static/docs-rs/bdk/nightly/latest/bdk/wallet/struct.Wallet.html @@ -9,7 +9,7 @@ needs to operate, like blockchain type provided implements Blockchain, or "offline" OfflineBlockchain is used. Offline wallets only expose methods that don't need any interaction with the blockchain to work.

    -

    Implementations

    impl<B, D> Wallet<B, D> where
        B: BlockchainMarker,
        D: BatchDatabase
    [src]

    pub fn new_offline<E: ToWalletDescriptor>(
        descriptor: E,
        change_descriptor: Option<E>,
        network: Network,
        database: D
    ) -> Result<Self, Error>
    [src]

    Create a new "offline" wallet

    +

    Implementations

    impl<B, D> Wallet<B, D> where
        B: BlockchainMarker,
        D: BatchDatabase
    [src]

    pub fn new_offline<E: ToWalletDescriptor>(
        descriptor: E,
        change_descriptor: Option<E>,
        network: Network,
        database: D
    ) -> Result<Self, Error>
    [src]

    Create a new "offline" wallet

    pub fn get_new_address(&self) -> Result<Address, Error>[src]

    Return a newly generated address using the external descriptor

    pub fn is_mine(&self, script: &Script) -> Result<bool, Error>[src]

    Return whether or not a script is part of this wallet (either internal or external)

    pub fn list_unspent(&self) -> Result<Vec<UTXO>, Error>[src]

    Return the list of unspent outputs of this wallet

    @@ -27,14 +27,14 @@ methods that don't need any interaction with the blockchain to work.

    See the signer module for an example.

    pub fn add_address_validator(&mut self, validator: Arc<dyn AddressValidator>)[src]

    Add an address validator

    See the address_validator module for an example.

    -

    pub fn create_tx<Cs: CoinSelectionAlgorithm<D>>(
        &self,
        builder: TxBuilder<D, Cs, CreateTx>
    ) -> Result<(PSBT, TransactionDetails), Error>
    [src]

    Create a new transaction following the options specified in the builder

    +

    pub fn create_tx<Cs: CoinSelectionAlgorithm<D>>(
        &self,
        builder: TxBuilder<D, Cs, CreateTx>
    ) -> Result<(PSBT, TransactionDetails), Error>
    [src]

    Create a new transaction following the options specified in the builder

    Example

     let (psbt, details) = wallet.create_tx(
         TxBuilder::with_recipients(vec![(to_address.script_pubkey(), 50_000)])
     )?;
     // sign and broadcast ...
    -

    pub fn bump_fee<Cs: CoinSelectionAlgorithm<D>>(
        &self,
        txid: &Txid,
        builder: TxBuilder<D, Cs, BumpFee>
    ) -> Result<(PSBT, TransactionDetails), Error>
    [src]

    Bump the fee of a transaction following the options specified in the builder

    +

    pub fn bump_fee<Cs: CoinSelectionAlgorithm<D>>(
        &self,
        txid: &Txid,
        builder: TxBuilder<D, Cs, BumpFee>
    ) -> Result<(PSBT, TransactionDetails), Error>
    [src]

    Bump the fee of a transaction following the options specified in the builder

    Return an error if the transaction is already confirmed or doesn't explicitly signal RBF.

    NOTE: if the original transaction was made with TxBuilder::set_single_recipient, the TxBuilder::maintain_single_recipient flag should be enabled to correctly reduce the @@ -49,21 +49,21 @@ transaction regardless of whether they are necessary or not to cover additional TxBuilder::new().fee_rate(FeeRate::from_sat_per_vb(5.0)), )?; // sign and broadcast ...

    -

    pub fn sign(
        &self,
        psbt: PSBT,
        assume_height: Option<u32>
    ) -> Result<(PSBT, bool), Error>
    [src]

    Sign a transaction with all the wallet's signers, in the order specified by every signer's +

    pub fn sign(
        &self,
        psbt: PSBT,
        assume_height: Option<u32>
    ) -> Result<(PSBT, bool), Error>
    [src]

    Sign a transaction with all the wallet's signers, in the order specified by every signer's SignerOrdering

    Example

     let (signed_psbt, finalized) = wallet.sign(psbt, None)?;
    -

    pub fn policies(&self, script_type: ScriptType) -> Result<Option<Policy>, Error>[src]

    Return the spending policies for the wallet's descriptor

    -

    pub fn public_descriptor(
        &self,
        script_type: ScriptType
    ) -> Result<Option<ExtendedDescriptor>, Error>
    [src]

    Return the "public" version of the wallet's descriptor, meaning a new descriptor that has +

    pub fn policies(&self, script_type: ScriptType) -> Result<Option<Policy>, Error>[src]

    Return the spending policies for the wallet's descriptor

    +

    pub fn public_descriptor(
        &self,
        script_type: ScriptType
    ) -> Result<Option<ExtendedDescriptor>, Error>
    [src]

    Return the "public" version of the wallet's descriptor, meaning a new descriptor that has the same structure but with every secret key removed

    This can be used to build a watch-only version of a wallet

    -

    pub fn finalize_psbt(
        &self,
        psbt: PSBT,
        assume_height: Option<u32>
    ) -> Result<(PSBT, bool), Error>
    [src]

    Try to finalize a PSBT

    -

    pub fn secp_ctx(&self) -> &Secp256k1<All>[src]

    impl<B, D> Wallet<B, D> where
        B: Blockchain,
        D: BatchDatabase
    [src]

    pub fn new<E: ToWalletDescriptor>(
        descriptor: E,
        change_descriptor: Option<E>,
        network: Network,
        database: D,
        client: B
    ) -> Result<Self, Error>
    [src]

    Create a new "online" wallet

    -

    pub fn sync<P: 'static + Progress>(
        &self,
        progress_update: P,
        max_address_param: Option<u32>
    ) -> Result<(), Error>
    [src]

    Sync the internal database with the blockchain

    -

    pub fn client(&self) -> Option<&B>[src]

    Return a reference to the internal blockchain client

    -

    pub fn network(&self) -> Network[src]

    Get the Bitcoin network the wallet is using.

    -

    pub fn broadcast(&self, tx: Transaction) -> Result<Txid, Error>[src]

    Broadcast a transaction to the network

    +

    pub fn finalize_psbt(
        &self,
        psbt: PSBT,
        assume_height: Option<u32>
    ) -> Result<(PSBT, bool), Error>
    [src]

    Try to finalize a PSBT

    +

    pub fn secp_ctx(&self) -> &Secp256k1<All>[src]

    impl<B, D> Wallet<B, D> where
        B: Blockchain,
        D: BatchDatabase
    [src]

    pub fn new<E: ToWalletDescriptor>(
        descriptor: E,
        change_descriptor: Option<E>,
        network: Network,
        database: D,
        client: B
    ) -> Result<Self, Error>
    [src]

    Create a new "online" wallet

    +

    pub fn sync<P: 'static + Progress>(
        &self,
        progress_update: P,
        max_address_param: Option<u32>
    ) -> Result<(), Error>
    [src]

    Sync the internal database with the blockchain

    +

    pub fn client(&self) -> Option<&B>[src]

    Return a reference to the internal blockchain client

    +

    pub fn network(&self) -> Network[src]

    Get the Bitcoin network the wallet is using.

    +

    pub fn broadcast(&self, tx: Transaction) -> Result<Txid, Error>[src]

    Broadcast a transaction to the network

    Auto Trait Implementations

    impl<B, D> !RefUnwindSafe for Wallet<B, D>[src]

    impl<B, D> Send for Wallet<B, D> where
        B: Send,
        D: Send
    [src]

    impl<B, D> !Sync for Wallet<B, D>[src]

    impl<B, D> Unpin for Wallet<B, D> where
        B: Unpin,
        D: Unpin
    [src]

    impl<B, D> !UnwindSafe for Wallet<B, D>[src]

    Blanket Implementations

    impl<T> Any for T where
        T: 'static + ?Sized
    [src]

    impl<T> Borrow<T> for T where
        T: ?Sized
    [src]

    impl<T> BorrowMut<T> for T where
        T: ?Sized
    [src]

    Required methods

    pub fn is_dust(&self) -> bool[src]

    Check whether or not a value is below dust limit

    +
    Loading content...

    Implementations on Foreign Types

    impl IsDust for u64[src]

    Loading content...

    Implementors

    Loading content... \ No newline at end of file diff --git a/static/docs-rs/bdk/nightly/latest/bdk/wallet/tx_builder/enum.ChangeSpendPolicy.html b/static/docs-rs/bdk/nightly/latest/bdk/wallet/tx_builder/enum.ChangeSpendPolicy.html index 4af88212fd..e8e848212e 100644 --- a/static/docs-rs/bdk/nightly/latest/bdk/wallet/tx_builder/enum.ChangeSpendPolicy.html +++ b/static/docs-rs/bdk/nightly/latest/bdk/wallet/tx_builder/enum.ChangeSpendPolicy.html @@ -1,7 +1,7 @@ bdk::wallet::tx_builder::ChangeSpendPolicy - Rust

    [][src]Enum bdk::wallet::tx_builder::ChangeSpendPolicy

    pub enum ChangeSpendPolicy {
    +                Change settings

    [][src]Enum bdk::wallet::tx_builder::ChangeSpendPolicy

    pub enum ChangeSpendPolicy {
         ChangeAllowed,
         OnlyChange,
         ChangeForbidden,
    @@ -11,27 +11,27 @@
     
    ChangeAllowed

    Use both change and non-change outputs (default)

    OnlyChange

    Only use change outputs (see TxBuilder::only_spend_change)

    ChangeForbidden

    Only use non-change outputs (see TxBuilder::do_not_spend_change)

    -

    Trait Implementations

    impl Clone for ChangeSpendPolicy[src]

    Trait Implementations

    impl Clone for ChangeSpendPolicy[src]

    impl Copy for ChangeSpendPolicy[src]

    impl Debug for ChangeSpendPolicy[src]

    impl Default for ChangeSpendPolicy[src]

    impl Eq for ChangeSpendPolicy[src]

    impl Hash for ChangeSpendPolicy[src]

    impl Copy for ChangeSpendPolicy[src]

    impl Debug for ChangeSpendPolicy[src]

    impl Default for ChangeSpendPolicy[src]

    impl Eq for ChangeSpendPolicy[src]

    impl Hash for ChangeSpendPolicy[src]

    impl Ord for ChangeSpendPolicy[src]

    impl Ord for ChangeSpendPolicy[src]

    impl PartialEq<ChangeSpendPolicy> for ChangeSpendPolicy[src]

    impl PartialEq<ChangeSpendPolicy> for ChangeSpendPolicy[src]

    impl PartialOrd<ChangeSpendPolicy> for ChangeSpendPolicy[src]

    impl PartialOrd<ChangeSpendPolicy> for ChangeSpendPolicy[src]

    impl StructuralEq for ChangeSpendPolicy[src]

    impl StructuralPartialEq for ChangeSpendPolicy[src]

    Auto Trait Implementations

    Blanket Implementations

    impl<T> Any for T where
        T: 'static + ?Sized
    [src]

    impl StructuralEq for ChangeSpendPolicy[src]

    impl StructuralPartialEq for ChangeSpendPolicy[src]

    Auto Trait Implementations

    Blanket Implementations

    impl<T> Any for T where
        T: 'static + ?Sized
    [src]

    impl<T> Borrow<T> for T where
        T: ?Sized
    [src]

    impl<T> BorrowMut<T> for T where
        T: ?Sized
    [src]

    impl<Q, K> Equivalent<K> for Q where
        K: Borrow<Q> + ?Sized,
        Q: Eq + ?Sized
    [src]