Enum bdk::Utxo

pub fn sign(
    &self,
    psbt: &mut PartiallySignedTransaction,
    sign_options: SignOptions
) -> Result<bool, SignerError>

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

pub fn sign(
    &self,
    psbt: &mut PartiallySignedTransaction,
    sign_options: SignOptions
) -> Result<bool, SignerError>

Sign a transaction with all the walletâs signers, in the order specified by every signerâs SignerOrdering. This function returns the Result type with an encapsulated bool that has the value true if the PSBT was finalized, or false otherwise.

The SignOptions can be used to tweak the behavior of the software signers, and the way the transaction is finalized at the end. Note that it canât be guaranteed that every @@ -225,52 +225,52 @@ in this library will.

}; let finalized = wallet.sign(&mut psbt, SignOptions::default())?; assert!(finalized, "we should have signed all the inputs");

-

pub fn policies(
&self,
keychain: KeychainKind
) -> Result<Option<Policy>, DescriptorError>

Return the spending policies for the walletâs descriptor

-

pub fn public_descriptor(
&self,
keychain: KeychainKind
) -> Option<&ExtendedDescriptor>

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

pub fn policies(
&self,
keychain: KeychainKind
) -> Result<Option<Policy>, DescriptorError>

Return the spending policies for the walletâs descriptor

+

pub fn public_descriptor(
&self,
keychain: KeychainKind
) -> Option<&ExtendedDescriptor>

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: &mut PartiallySignedTransaction,
    sign_options: SignOptions
) -> Result<bool, SignerError>

Finalize a PSBT, i.e., for each input determine if sufficient data is available to pass +

pub fn finalize_psbt(
    &self,
    psbt: &mut PartiallySignedTransaction,
    sign_options: SignOptions
) -> Result<bool, SignerError>

Finalize a PSBT, i.e., for each input determine if sufficient data is available to pass validation and construct the respective scriptSig or scriptWitness. Please refer to BIP174 for further information.

Returns true if the PSBT could be finalized, and false otherwise.

The SignOptions can be used to tweak the behavior of the finalizer.

-

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

Return the secp256k1 context used for all signing operations

-

pub fn get_descriptor_for_keychain(
&self,
keychain: KeychainKind
) -> &ExtendedDescriptor

Returns the descriptor used to create addresses for a particular keychain.

-

pub fn derivation_index(&self, keychain: KeychainKind) -> Option<u32>

The derivation index of this wallet. It will return None if it has not derived any addresses. +

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

Return the secp256k1 context used for all signing operations

+

pub fn get_descriptor_for_keychain(
&self,
keychain: KeychainKind
) -> &ExtendedDescriptor

Returns the descriptor used to create addresses for a particular keychain.

+

pub fn derivation_index(&self, keychain: KeychainKind) -> Option<u32>

The derivation index of this wallet. It will return None if it has not derived any addresses. Otherwise, it will return the index of the highest address it has derived.

-

pub fn next_derivation_index(&self, keychain: KeychainKind) -> u32

The index of the next address that you would get if you were to ask the wallet for a new address

-

pub fn cancel_tx(&mut self, tx: &Transaction)

Informs the wallet that you no longer intend to broadcast a tx that was built from it.

+

pub fn next_derivation_index(&self, keychain: KeychainKind) -> u32

The index of the next address that you would get if you were to ask the wallet for a new address

+

pub fn cancel_tx(&mut self, tx: &Transaction)

Informs the wallet that you no longer intend to broadcast a tx that was built from it.

This frees up the change address used when creating the tx for use in future transactions.

-

pub fn get_psbt_input(
    &self,
    utxo: LocalOutput,
    sighash_type: Option<PsbtSighashType>,
    only_witness_utxo: bool
) -> Result<Input, CreateTxError<D::WriteError>>where
    D: PersistBackend<ChangeSet>,

get the corresponding PSBT Input for a LocalUtxo

-

pub fn descriptor_checksum(&self, keychain: KeychainKind) -> String

Return the checksum of the public descriptor associated to keychain

+

pub fn get_psbt_input(
    &self,
    utxo: LocalOutput,
    sighash_type: Option<PsbtSighashType>,
    only_witness_utxo: bool
) -> Result<Input, CreateTxError<D::WriteError>>where
    D: PersistBackend<ChangeSet>,

get the corresponding PSBT Input for a LocalUtxo

+

pub fn descriptor_checksum(&self, keychain: KeychainKind) -> String

Return the checksum of the public descriptor associated to keychain

Internally calls Self::get_descriptor_for_keychain to fetch the right descriptor

-

pub fn apply_update(&mut self, update: Update) -> Result<(), CannotConnectError>where
D: PersistBackend<ChangeSet>,

Applies an update to the wallet and stages the changes (but does not commit them).

+

pub fn apply_update(&mut self, update: Update) -> Result<(), CannotConnectError>where
D: PersistBackend<ChangeSet>,

Applies an update to the wallet and stages the changes (but does not commit them).

Usually you create an update by interacting with some blockchain data source and inserting transactions related to your wallet into it.

-

pub fn commit(&mut self) -> Result<bool, D::WriteError>where
D: PersistBackend<ChangeSet>,

Commits all currently staged changed to the persistence backend returning and error when +

pub fn commit(&mut self) -> Result<bool, D::WriteError>where
D: PersistBackend<ChangeSet>,

Commits all currently staged changed to the persistence backend returning and error when this fails.

This returns whether the update resulted in any changes.

-

pub fn staged(&self) -> &ChangeSetwhere
D: PersistBackend<ChangeSet>,

Returns the changes that will be committed with the next call to commit.

-

pub fn tx_graph(&self) -> &TxGraph<ConfirmationTimeHeightAnchor>

Get a reference to the inner TxGraph.

-

pub fn spk_index(&self) -> &KeychainTxOutIndex<KeychainKind>

Get a reference to the inner KeychainTxOutIndex.

-

pub fn local_chain(&self) -> &LocalChain

Get a reference to the inner LocalChain.

-

pub fn apply_block(
    &mut self,
    block: &Block,
    height: u32
) -> Result<(), CannotConnectError>where
    D: PersistBackend<ChangeSet>,

Introduces a block of height to the wallet, and tries to connect it to the +

pub fn staged(&self) -> &ChangeSetwhere
D: PersistBackend<ChangeSet>,

Returns the changes that will be committed with the next call to commit.

+

pub fn tx_graph(&self) -> &TxGraph<ConfirmationTimeHeightAnchor>

Get a reference to the inner TxGraph.

+

pub fn spk_index(&self) -> &KeychainTxOutIndex<KeychainKind>

Get a reference to the inner KeychainTxOutIndex.

+

pub fn local_chain(&self) -> &LocalChain

Get a reference to the inner LocalChain.

+

pub fn apply_block(
    &mut self,
    block: &Block,
    height: u32
) -> Result<(), CannotConnectError>where
    D: PersistBackend<ChangeSet>,

Introduces a block of height to the wallet, and tries to connect it to the prev_blockhash of the blockâs header.

This is a convenience method that is equivalent to calling apply_block_connected_to with prev_blockhash and height-1 as the connected_to parameter.

-

pub fn apply_block_connected_to(
    &mut self,
    block: &Block,
    height: u32,
    connected_to: BlockId
) -> Result<(), ApplyHeaderError>where
    D: PersistBackend<ChangeSet>,

Applies relevant transactions from block of height to the wallet, and connects the +

pub fn apply_block_connected_to(
    &mut self,
    block: &Block,
    height: u32,
    connected_to: BlockId
) -> Result<(), ApplyHeaderError>where
    D: PersistBackend<ChangeSet>,

Applies relevant transactions from block of height to the wallet, and connects the block to the internal chain.

The connected_to parameter informs the wallet how this block connects to the internal LocalChain. Relevant transactions are filtered from the block and inserted into the internal TxGraph.

-

pub fn apply_unconfirmed_txs<'t>(
    &mut self,
    unconfirmed_txs: impl IntoIterator<Item = (&'t Transaction, u64)>
)where
    D: PersistBackend<ChangeSet>,

Apply relevant unconfirmed transactions to the wallet.

+

pub fn apply_unconfirmed_txs<'t>(
    &mut self,
    unconfirmed_txs: impl IntoIterator<Item = (&'t Transaction, u64)>
)where
    D: PersistBackend<ChangeSet>,

Apply relevant unconfirmed transactions to the wallet.

Transactions that are not relevant are filtered out.

This method takes in an iterator of (tx, last_seen) where last_seen is the timestamp of when the transaction was last seen in the mempool. This is used for conflict resolution when there is conflicting unconfirmed transactions. The transaction with the later last_seen is prioritized.

-

Trait ImplementationsÂ§

impl<D> AsRef<TxGraph<ConfirmationTimeHeightAnchor>> for Wallet<D>

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

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

impl<D: Debug> Debug for Wallet<D>

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

Formats the value using the given formatter. Read more

Auto Trait ImplementationsÂ§

impl<D = ()> !UnwindSafe for Wallet<D>

Blanket ImplementationsÂ§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable Â· sourceÂ§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable Â· sourceÂ§

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable Â· sourceÂ§

fn from(t: T) -> T

Returns the argument unchanged.

+

Trait ImplementationsÂ§

impl<D> AsRef<TxGraph<ConfirmationTimeHeightAnchor>> for Wallet<D>

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

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

impl<D: Debug> Debug for Wallet<D>

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

Formats the value using the given formatter. Read more

Auto Trait ImplementationsÂ§

impl<D = ()> !RefUnwindSafe for Wallet<D>

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

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

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

impl<D = ()> !UnwindSafe for Wallet<D>

Blanket ImplementationsÂ§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable Â· sourceÂ§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable Â· sourceÂ§

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable Â· sourceÂ§

fn from(t: T) -> T

Returns the argument unchanged.