Struct mutiny_core::MutinyWallet

pub struct MutinyWallet<S: MutinyStorage> {
    pub storage: S,
    pub node_manager: Arc<NodeManager<S>>,
    pub nostr: Arc<NostrManager<S>>,
    /* private fields */
}

MutinyWallet is the main entry point for the library. It contains the NodeManager, which is the main interface to manage the bitcoin and the lightning functionality.

Fields

storage: S

node_manager: Arc<NodeManager<S>>

nostr: Arc<NostrManager<S>>

Implementations

impl<S: MutinyStorage> MutinyWallet<S>

pub async fn new( storage: S, config: MutinyWalletConfig ) -> Result<MutinyWallet<S>, MutinyError>

pub async fn start(&mut self) -> Result<(), MutinyError>

Starts up all the nodes again. Not needed after NodeManager’s new() function.

pub async fn pay_subscription_invoice( &self, inv: &Bolt11Invoice ) -> Result<(), MutinyError>

Pay the subscription invoice. This will post a NWC automatically afterwards.

pub async fn sync_nostr_contacts( &self, npub: XOnlyPublicKey, timeout: Option<Duration> ) -> Result<(), MutinyError>

Get contacts from the given npub and sync them to the wallet

pub async fn stop(&self) -> Result<(), MutinyError>

Stops all of the nodes and background processes. Returns after node has been stopped.

pub async fn change_password( &mut self, old: Option<String>, new: Option<String> ) -> Result<(), MutinyError>

pub async fn reset_onchain_tracker(&mut self) -> Result<(), MutinyError>

Resets BDK’s keychain tracker. This will require a re-sync of the blockchain.

This can be useful if you get stuck in a bad state.

pub async fn restore_mnemonic( storage: S, m: Mnemonic ) -> Result<(), MutinyError>

Restores the mnemonic after deleting the previous state.

Backup the state beforehand. Does not restore lightning data. Should refresh or restart afterwards. Wallet should be stopped.

Trait Implementations

impl<S: Clone + MutinyStorage> Clone for MutinyWallet<S>

fn clone(&self) -> MutinyWallet<S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.