Struct Runtime

pub struct Runtime<D = StdDescr, K = XpubDerivable, L2 = Option<ImpossibleLayer2>>
where
    D: Descriptor<K>,
    L2: Layer2,
{ /* private fields */ }

Implementations

impl<D, K, L2> Runtime<D, K, L2>

where D: Descriptor<K>, L2: Layer2,

pub fn path(&self) -> &Option<PathBuf>

Method borrowing Runtime::path field.

pub fn wallet(&self) -> &Wallet<K, D, L2>

Method borrowing Runtime::wallet field.

pub fn wallet_mut(&mut self) -> &mut Wallet<K, D, L2>

Method returning mutable borrow of Runtime::wallet field.

pub fn warnings(&self) -> &Vec<Warning>

Method borrowing Runtime::warnings field.

impl<K, D> Runtime<D, K>

where D: Descriptor<K>,

pub fn new_standard(descr: D, network: Network) -> Runtime<D, K>

impl<K, D, L2> Runtime<D, K, L2>

where D: Descriptor<K>, L2: Layer2,

pub fn new_layer2( descr: D, l2_descr: <L2 as Layer2>::Descr, layer2: L2, network: Network, ) -> Runtime<D, K, L2>

pub fn set_name(&mut self, name: String)

pub fn sync<I>( &mut self, indexer: &I, ) -> Result<usize, Vec<<I as Indexer>::Error>>

where I: Indexer,

pub fn attach(wallet: Wallet<K, D, L2>) -> Runtime<D, K, L2>

pub fn detach(self) -> Wallet<K, D, L2>

pub fn reset_warnings(&mut self)

impl<K, D> Runtime<D, K>

where D: Descriptor<K> + for<'de> Serialize + for<'de> Deserialize<'de>,

pub fn load_standard(path: PathBuf) -> Result<Runtime<D, K>, LoadError>

pub fn load_standard_or_init<E>( data_dir: PathBuf, network: Network, init: impl FnOnce(LoadError) -> Result<D, E>, ) -> Result<Runtime<D, K>, LoadError>

where LoadError: From<E>,

impl<K, D, L2> Runtime<D, K, L2>

where D: Descriptor<K> + for<'de> Serialize + for<'de> Deserialize<'de>, L2: Layer2 + for<'de> Serialize + for<'de> Deserialize<'de>, <L2 as Layer2>::Descr: for<'de> Serialize + for<'de> Deserialize<'de>, <L2 as Layer2>::Data: for<'de> Serialize + for<'de> Deserialize<'de>, <L2 as Layer2>::Cache: for<'de> Serialize + for<'de> Deserialize<'de>,

pub fn load_layer2( path: PathBuf, ) -> Result<Runtime<D, K, L2>, LoadError<<L2 as Layer2>::LoadError>>

pub fn load_layer2_or_init<E1, E2>( data_dir: PathBuf, network: Network, init: impl FnOnce(LoadError<<L2 as Layer2>::LoadError>) -> Result<D, E1>, init_l2: impl FnOnce() -> Result<(L2, <L2 as Layer2>::Descr), E2>, ) -> Result<Runtime<D, K, L2>, LoadError<<L2 as Layer2>::LoadError>>

where LoadError<<L2 as Layer2>::LoadError>: From<E1> + From<E2>,

pub fn try_store(&self) -> Result<bool, StoreError<<L2 as Layer2>::StoreError>>

pub fn store_as( &mut self, path: PathBuf, ) -> Result<(), StoreError<<L2 as Layer2>::StoreError>>

pub fn store_default_path( &mut self, path: PathBuf, ) -> Result<(), StoreError<<L2 as Layer2>::StoreError>>

Methods from Deref<Target = Wallet<K, D, L2>>

pub fn set_name(&mut self, name: String)

pub fn update<B>( &mut self, indexer: &B, ) -> MayError<usize, Vec<<B as Indexer>::Error>>

where B: Indexer,

pub fn to_deriver(&self) -> D

where D: Clone, K: Clone,

pub fn last_derivation_index( &self, keychain: impl Into<Keychain>, ) -> NormalIndex

pub fn next_derivation_index( &mut self, keychain: impl Into<Keychain>, shift: bool, ) -> NormalIndex

pub fn next_address( &mut self, keychain: impl Into<Keychain>, shift: bool, ) -> Address

pub fn balance(&self) -> Sats

pub fn transactions(&self) -> &BTreeMap<Txid, WalletTx>

pub fn coins( &self, ) -> impl Iterator<Item = CoinRow<<<L2 as Layer2>::Cache as Layer2Cache>::Coin>>

pub fn address_coins( &self, ) -> HashMap<DerivedAddr, Vec<CoinRow<<<L2 as Layer2>::Cache as Layer2Cache>::Coin>>>

pub fn address_balance(&self) -> impl Iterator<Item = WalletAddr>

pub fn history( &self, ) -> impl Iterator<Item = TxRow<<<L2 as Layer2>::Cache as Layer2Cache>::Tx>>

pub fn utxo(&self, outpoint: Outpoint) -> Result<WalletUtxo, NonWalletItem>

pub fn all_utxos(&self) -> impl Iterator<Item = WalletUtxo>

pub fn coinselect<'a>( &'a self, up_to: Sats, selector: impl Fn(&WalletUtxo) -> bool + 'a, ) -> impl Iterator<Item = Outpoint> + 'a

pub fn store( &self, path: &Path, ) -> Result<(), StoreError<<L2 as Layer2>::StoreError>>

pub fn construct_psbt<'a, 'b>( &mut self, coins: impl IntoIterator<Item = Outpoint>, beneficiaries: impl IntoIterator<Item = &'b Beneficiary>, params: TxParams, ) -> Result<(Psbt, PsbtMeta), ConstructionError>

Methods from Deref<Target = WalletDescr<K, D, <L2 as Layer2>::Descr>>

pub fn generator(&self) -> &D

Method borrowing WalletDescr::generator field.

pub fn network(&self) -> Network

Method returning copy of WalletDescr::network field.

pub fn layer2(&self) -> &L2

Method borrowing WalletDescr::layer2 field.

pub fn _phantom(&self) -> &PhantomData<K>

Method borrowing WalletDescr::_phantom field.

pub fn addresses(&self, keychain: impl Into<Keychain>) -> AddrIter<'_, K, D>

Trait Implementations

impl<D, K, L2> Debug for Runtime<D, K, L2>

where D: Debug + Descriptor<K>, K: Debug, L2: Debug + Layer2,

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

Formats the value using the given formatter.

impl<K, D, L2> Deref for Runtime<D, K, L2>

where D: Descriptor<K>, L2: Layer2,

type Target = Wallet<K, D, L2>

The resulting type after dereferencing.

fn deref(&self) -> &<Runtime<D, K, L2> as Deref>::Target

Dereferences the value.

impl<K, D, L2> DerefMut for Runtime<D, K, L2>

where D: Descriptor<K>, L2: Layer2,

fn deref_mut(&mut self) -> &mut <Runtime<D, K, L2> as Deref>::Target

Mutably dereferences the value.