pub struct Wallet<D> { /* private fields */ }
Expand description
A Bitcoin wallet
The Wallet
struct acts as a way of coherently interfacing with output descriptors and related transactions.
Its main components are:
Implementations
pub fn new_offline<E: IntoWalletDescriptor>(
descriptor: E,
change_descriptor: Option<E>,
network: Network,
database: D
) -> Result<Self, Error>
👎 Deprecated: Just use Wallet::new – all wallets are offline now!
pub fn new_offline<E: IntoWalletDescriptor>(
descriptor: E,
change_descriptor: Option<E>,
network: Network,
database: D
) -> Result<Self, Error>
Just use Wallet::new – all wallets are offline now!
Create a new “offline” wallet
Create a wallet.
The only way this can fail is if the descriptors passed in do not match the checksums in database
.
Return a derived address using the external descriptor, see AddressIndex
for
available address index selection strategies. If none of the keys in the descriptor are derivable
(ie. does not end with /*) then the same address will always be returned for any AddressIndex
.
pub fn get_internal_address(
&self,
address_index: AddressIndex
) -> Result<AddressInfo, Error>
pub fn get_internal_address(
&self,
address_index: AddressIndex
) -> Result<AddressInfo, Error>
Return a derived address using the internal (change) descriptor.
If the wallet doesn’t have an internal descriptor it will use the external descriptor.
see AddressIndex
for available address index selection strategies. If none of the keys
in the descriptor are derivable (ie. does not end with /*) then the same address will always
be returned for any AddressIndex
.
Ensures that there are at least max_addresses
addresses cached in the database if the
descriptor is derivable, or 1 address if it is not.
Will return Ok(true)
if there are new addresses generated (either external or internal),
and Ok(false)
if all the required addresses are already cached. This function is useful to
explicitly cache addresses in a wallet to do things like check Wallet::is_mine
on
transaction output scripts.
Return whether or not a script
is part of this wallet (either internal or external)
Return the list of unspent outputs of this wallet
Note that this method only operates on the internal database, which first needs to be
Wallet::sync
manually.
Returns the UTXO
owned by this wallet corresponding to outpoint
if it exists in the
wallet’s database.
Return a single transactions made and received by the wallet
Optionally fill the TransactionDetails::transaction
field with the raw transaction if
include_raw
is true
.
Note that this method only operates on the internal database, which first needs to be
Wallet::sync
manually.
Return the list of transactions made and received by the wallet
Optionally fill the TransactionDetails::transaction
field with the raw transaction if
include_raw
is true
.
Note that this methods only operate on the internal database, which first needs to be
Wallet::sync
manually.
Return the balance, meaning the sum of this wallet’s unspent outputs’ values
Note that this methods only operate on the internal database, which first needs to be
Wallet::sync
manually.
pub fn add_signer(
&mut self,
keychain: KeychainKind,
ordering: SignerOrdering,
signer: Arc<dyn Signer>
)
pub fn add_signer(
&mut self,
keychain: KeychainKind,
ordering: SignerOrdering,
signer: Arc<dyn Signer>
)
Add an external signer
See the signer
module for an example.
Get the signers
Example
let wallet = Wallet::new("wpkh(tprv8ZgxMBicQKsPe73PBRSmNbTfbcsZnwWhz5eVmhHpi31HW29Z7mc9B4cWGRQzopNUzZUT391DeDJxL2PefNunWyLgqCKRMDkU1s2s8bAfoSk/84'/0'/0'/0/*)", None, Network::Testnet, MemoryDatabase::new())?;
for secret_key in wallet.get_signers(KeychainKind::External).signers().iter().filter_map(|s| s.descriptor_secret_key()) {
// secret_key: tprv8ZgxMBicQKsPe73PBRSmNbTfbcsZnwWhz5eVmhHpi31HW29Z7mc9B4cWGRQzopNUzZUT391DeDJxL2PefNunWyLgqCKRMDkU1s2s8bAfoSk/84'/0'/0'/0/*
println!("secret_key: {}", secret_key);
}
Ok::<(), Box<dyn std::error::Error>>(())
Add an address validator
See the address_validator
module for an example.
Get the address validators
pub fn build_fee_bump(
&self,
txid: Txid
) -> Result<TxBuilder<'_, D, DefaultCoinSelectionAlgorithm, BumpFee>, Error>
pub fn build_fee_bump(
&self,
txid: Txid
) -> Result<TxBuilder<'_, D, DefaultCoinSelectionAlgorithm, BumpFee>, Error>
Bump the fee of a transaction previously created with this wallet.
Returns an error if the transaction is already confirmed or doesn’t explicitly signal
replace by fee (RBF). If the transaction can be fee bumped then it returns a TxBuilder
pre-populated with the inputs and outputs of the original transaction.
Example
let (mut psbt, _) = {
let mut builder = wallet.build_tx();
builder
.add_recipient(to_address.script_pubkey(), 50_000)
.enable_rbf();
builder.finish()?
};
let _ = wallet.sign(&mut psbt, SignOptions::default())?;
let tx = psbt.extract_tx();
// broadcast tx but it's taking too long to confirm so we want to bump the fee
let (mut psbt, _) = {
let mut builder = wallet.build_fee_bump(tx.txid())?;
builder
.fee_rate(FeeRate::from_sat_per_vb(5.0));
builder.finish()?
};
let _ = wallet.sign(&mut psbt, SignOptions::default())?;
let fee_bumped_tx = psbt.extract_tx();
// broadcast fee_bumped_tx to replace original
Sign a transaction with all the wallet’s signers, in the order specified by every signer’s
SignerOrdering
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
signers will follow the options, but the “software signers” (WIF keys and xprv
) defined
in this library will.
Example
let (mut psbt, _) = {
let mut builder = wallet.build_tx();
builder.add_recipient(to_address.script_pubkey(), 50_000);
builder.finish()?
};
let finalized = wallet.sign(&mut psbt, SignOptions::default())?;
assert!(finalized, "we should have signed all the inputs");
Return the spending policies for the wallet’s descriptor
pub fn public_descriptor(
&self,
keychain: KeychainKind
) -> Result<Option<ExtendedDescriptor>, Error>
pub fn public_descriptor(
&self,
keychain: KeychainKind
) -> Result<Option<ExtendedDescriptor>, Error>
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, Error>
pub fn finalize_psbt(
&self,
psbt: &mut PartiallySignedTransaction,
sign_options: SignOptions
) -> Result<bool, Error>
Try to finalize a PSBT
The SignOptions
can be used to tweak the behavior of the finalizer.
Return the secp256k1 context used for all signing operations
Returns the descriptor used to create addresses for a particular keychain
.
get the corresponding PSBT Input for a LocalUtxo
Return an immutable reference to the internal database
pub fn sync<B: WalletSync + GetHeight>(
&self,
blockchain: &B,
sync_opts: SyncOptions
) -> Result<(), Error>
pub fn sync<B: WalletSync + GetHeight>(
&self,
blockchain: &B,
sync_opts: SyncOptions
) -> Result<(), Error>
Sync the internal database with the blockchain
Return the checksum of the public descriptor associated to keychain
Internally calls Self::get_descriptor_for_keychain
to fetch the right descriptor