Struct lwk_wollet::Wollet

pub struct Wollet { /* private fields */ }

A watch-only wallet defined by a CT descriptor.

Implementations

impl Wollet

pub fn apply_update(&mut self, update: Update) -> Result<(), Error>

pub fn apply_update_no_persist(&mut self, update: Update) -> Result<(), Error>

impl Wollet

pub fn new( network: ElementsNetwork, persister: Arc<dyn Persister + Send + Sync>, descriptor: WolletDescriptor ) -> Result<Self, Error>

Create a new wallet

pub fn with_fs_persist<P: AsRef<Path>>( network: ElementsNetwork, descriptor: WolletDescriptor, datadir: P ) -> Result<Self, Error>

Create a new wallet persisting on file system

pub fn without_persist( network: ElementsNetwork, descriptor: WolletDescriptor ) -> Result<Self, Error>

Create a new wallet which not persist anything

pub fn policy_asset(&self) -> AssetId

Get the network policy asset

pub fn tx_builder(&self) -> WolletTxBuilder<'_>

Creates a transaction builder with a reference to this wallet

pub fn network(&self) -> ElementsNetwork

Get the network

pub fn descriptor(&self) -> &ConfidentialDescriptor<DescriptorPublicKey>

Get a reference of the wallet descriptor

pub fn wollet_descriptor(&self) -> WolletDescriptor

Get a copy of the wallet descriptor

pub fn tip(&self) -> Result<(u32, BlockHash), Error>

Get the blockchain tip

pub fn address(&self, index: Option<u32>) -> Result<AddressResult, Error>

Get a wallet address

If Some return the address at the given index, otherwise the last unused address.

pub fn change(&self, index: Option<u32>) -> Result<AddressResult, Error>

Get a wallet change address

If a specific descriptor is given for change addresses it’s used to derive this address Otherwise this is the same as address()

If Some return the address at the given index, otherwise the last unused address.

pub fn txos_inner(&self, unspent: bool) -> Result<Vec<WalletTxOut>, Error>

pub fn utxos(&self) -> Result<Vec<WalletTxOut>, Error>

Get the wallet UTXOs

pub fn balance(&self) -> Result<HashMap<AssetId, u64>, Error>

Get the wallet balance

pub fn transactions(&self) -> Result<Vec<WalletTx>, Error>

Get the wallet transactions with their heights (if confirmed)

pub fn transaction(&self, txid: &Txid) -> Result<Option<WalletTx>, Error>

Get a wallet transaction

pub fn issuances(&self) -> Result<Vec<IssuanceDetails>, Error>

Get the wallet (re)issuances

pub fn issuance(&self, asset: &AssetId) -> Result<IssuanceDetails, Error>

Get the issuance details for a certain asset

This only works if the asset was issued by this wallet

pub fn get_details( &self, pset: &PartiallySignedTransaction ) -> Result<PsetDetails, Error>

Get the PSET details with respect to the wallet

pub fn add_details( &self, pset: &mut PartiallySignedTransaction ) -> Result<(), Error>

Add the PSET details with respect to the wallet

pub fn signers(&self) -> Vec<Fingerprint>

Get the signers’ fingerprints involved in this descriptor

pub fn combine( &self, psets: &[PartiallySignedTransaction] ) -> Result<PartiallySignedTransaction, Error>

Combine a vector of PSET

pub fn finalize( &self, pset: &mut PartiallySignedTransaction ) -> Result<Transaction, Error>

pub fn updates(&self) -> Result<Vec<Update>, PersistError>

Trait Implementations

impl Debug for Wollet

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

Formats the value using the given formatter.