Struct iota_sdk::wallet::core::Wallet

pub struct Wallet<S: SecretManage = SecretManager> { /* private fields */ }

Available on crate feature wallet only.

The wallet, used to create and get accounts. One wallet can hold many accounts, but they should all share the same secret_manager type with the same seed/mnemonic.

Implementations

impl<S: 'static + SecretManage> Wallet<S>

where Error: From<S::Error>,

pub async fn recover_accounts( &self, account_start_index: u32, account_gap_limit: u32, address_gap_limit: u32, sync_options: Option<SyncOptions> ) -> Result<Vec<Account<S>>>

Find accounts with unspent outputs.

Arguments:

• account_start_index: The index of the first account to search for.
• account_gap_limit: The number of accounts to search for, after the last account with unspent outputs.
• address_gap_limit: The number of addresses to search for, after the last address with unspent outputs, in each account.
• sync_options: Optional parameter to specify the sync options. The address_start_index and force_syncing fields will be overwritten to skip existing addresses.

Returns:

A vector of Account

impl Wallet

pub async fn generate_ed25519_address( &self, account_index: u32, address_index: u32, options: impl Into<Option<GenerateAddressOptions>> + Send ) -> Result<Ed25519Address>

Generate an address without storing it

let public_addresses = wallet
    .generate_ed25519_addresses(
        0,
        false,
        0,
        None,
    )
    .await?;

impl<S: 'static + SecretManage> Wallet<S>

where Error: From<S::Error>,

pub async fn get_bech32_hrp(&self) -> Result<Hrp>

Get the bech32 hrp from the first account address or if not existent, from the client

impl<S: 'static + SecretManage> Wallet<S>

where Error: From<S::Error>,

pub async fn start_background_syncing( &self, options: Option<SyncOptions>, interval: Option<Duration> ) -> Result<()>

Start the background syncing process for all accounts, default interval is 7 seconds

pub async fn stop_background_syncing(&self) -> Result<()>

Stop the background syncing of the accounts

impl<S: 'static + SecretManage> Wallet<S>

pub fn client(&self) -> &Client

pub async fn client_options(&self) -> ClientBuilder

impl<S: 'static + SecretManage> Wallet<S>

where Error: From<S::Error>, WalletBuilder<S>: SaveLoadWallet,

pub async fn set_client_options( &self, client_options: ClientBuilder ) -> Result<()>

pub async fn update_node_auth( &self, url: Url, auth: Option<NodeAuth> ) -> Result<()>

Update the authentication for a node.

impl<S: SecretManage> Wallet<S>

pub async fn get_account<I: Into<AccountIdentifier> + Send>( &self, identifier: I ) -> Result<Account<S>>

Get an account with an AccountIdentifier

impl<S: 'static + SecretManage> Wallet<S>

where Error: From<S::Error>,

pub async fn get_or_create_account( &self, alias: impl Into<String> + Send ) -> Result<Account<S>>

impl Wallet<LedgerSecretManager>

pub async fn get_ledger_nano_status(&self) -> Result<LedgerNanoStatus>

Get the ledger nano status

impl Wallet

pub async fn get_ledger_nano_status(&self) -> Result<LedgerNanoStatus>

Get the ledger nano status

impl Wallet

pub async fn get_chrysalis_data( &self ) -> Result<Option<HashMap<String, String>>>

impl Wallet

pub async fn set_stronghold_password( &self, password: impl Into<Password> + Send ) -> Result<()>

Sets the Stronghold password

pub async fn change_stronghold_password( &self, current_password: impl Into<Password> + Send, new_password: impl Into<Password> + Send ) -> Result<()>

Change the Stronghold password to another one and also re-encrypt the values in the loaded snapshot with it.

pub async fn set_stronghold_password_clear_interval( &self, timeout: Option<Duration> ) -> Result<()>

Sets the Stronghold password clear interval

pub async fn store_mnemonic(&self, mnemonic: Mnemonic) -> Result<()>

Stores a mnemonic into the Stronghold vault

pub async fn clear_stronghold_password(&self) -> Result<()>

Clears the Stronghold password from memory.

pub async fn is_stronghold_password_available(&self) -> Result<bool>

Checks if the Stronghold password is available.

impl Wallet<StrongholdAdapter>

pub async fn set_stronghold_password( &self, password: impl Into<Password> + Send ) -> Result<()>

Sets the Stronghold password

pub async fn change_stronghold_password( &self, current_password: impl Into<Password> + Send, new_password: impl Into<Password> + Send ) -> Result<()>

Change the Stronghold password to another one and also re-encrypt the values in the loaded snapshot with it.

pub async fn set_stronghold_password_clear_interval( &self, timeout: Option<Duration> ) -> Result<()>

Sets the Stronghold password clear interval

pub async fn store_mnemonic(&self, mnemonic: Mnemonic) -> Result<()>

Stores a mnemonic into the Stronghold vault

pub async fn clear_stronghold_password(&self) -> Result<()>

Clears the Stronghold password from memory.

pub async fn is_stronghold_password_available(&self) -> Result<bool>

Checks if the Stronghold password is available.

impl Wallet

pub async fn backup( &self, backup_path: PathBuf, stronghold_password: impl Into<Password> + Send ) -> Result<()>

Backup the wallet data in a Stronghold file. stronghold_password must be the current one when Stronghold is used as SecretManager.

pub async fn restore_backup( &self, backup_path: PathBuf, stronghold_password: impl Into<Password> + Send, ignore_if_coin_type_mismatch: Option<bool>, ignore_if_bech32_hrp_mismatch: Option<Hrp> ) -> Result<()>

Restore the wallet from a Stronghold backup file. Replaces client_options, coin_type, secret_manager and accounts. Returns an error if accounts were already created If Stronghold is used as secret_manager, the existing Stronghold file will be overwritten. If a mnemonic was stored, it will be gone. if ignore_if_coin_type_mismatch.is_some(), client options will not be restored if ignore_if_coin_type_mismatch == Some(true), client options coin type and accounts will not be restored if the coin type doesn’t match if ignore_if_bech32_hrp_mismatch == Some(“rms”), but addresses have something different like “smr”, no accounts will be restored.

impl Wallet<StrongholdSecretManager>

pub async fn backup( &self, backup_path: PathBuf, stronghold_password: impl Into<Password> + Send ) -> Result<()>

Backup the wallet data in a Stronghold file stronghold_password must be the current one when Stronghold is used as SecretManager.

pub async fn restore_backup( &self, backup_path: PathBuf, stronghold_password: impl Into<Password> + Send, ignore_if_coin_type_mismatch: Option<bool>, ignore_if_bech32_hrp_mismatch: Option<&str> ) -> Result<()>

Restore a backup from a Stronghold file Replaces client_options, coin_type, secret_manager and accounts. Returns an error if accounts were already created If Stronghold is used as secret_manager, the existing Stronghold file will be overwritten. If a mnemonic was stored, it will be gone. if ignore_if_coin_type_mismatch.is_some(), client options will not be restored if ignore_if_coin_type_mismatch == Some(true), client options coin type and accounts will not be restored if the coin type doesn’t match if ignore_if_bech32_hrp_mismatch == Some(“rms”), but addresses have something different like “smr”, no accounts will be restored.

impl<S: SecretManage> Wallet<S>

pub async fn verify_integrity(&self) -> Result<()>

Checks if there is no missing account for example indexes [0, 1, 3] should panic (for now, later return error, automatically fix?) Also checks for each account if there is a gap in an address list and no address is duplicated

impl<S: 'static + SecretManage> Wallet<S>

where Error: From<S::Error>,

pub fn builder() -> WalletBuilder<S>

Initialises the wallet builder.

pub fn create_account(&self) -> AccountBuilder<S>

Create a new account

impl<S: 'static + SecretManage> Wallet<S>

where Error: From<S::Error>,

pub async fn get_accounts(&self) -> Result<Vec<Account<S>>>

Get all accounts

pub async fn get_account_aliases(&self) -> Result<Vec<String>>

Get all account aliases

pub async fn remove_latest_account(&self) -> Result<()>

Removes the latest account (account with the largest account index).

pub async fn balance(&self) -> Result<Balance>

Get the balance of all accounts added together

pub async fn sync(&self, options: Option<SyncOptions>) -> Result<Balance>

Sync all accounts

Methods from Deref<Target = WalletInner<S>>

pub fn get_secret_manager(&self) -> &Arc<RwLock<S>>

Get the SecretManager

pub async fn listen<F, I: IntoIterator<Item = WalletEventType> + Send>( &self, events: I, handler: F )

where I::IntoIter: Send, F: Fn(&Event) + 'static + Send + Sync,

Available on crate feature events only.

Listen to wallet events, empty vec will listen to all events

pub async fn clear_listeners<I: IntoIterator<Item = WalletEventType> + Send>( &self, events: I )

where I::IntoIter: Send,

Available on crate feature events only.

Remove wallet event listeners, empty vec will remove all listeners

pub fn generate_mnemonic(&self) -> Result<Mnemonic>

Generates a new random mnemonic.

pub fn verify_mnemonic(&self, mnemonic: &MnemonicRef) -> Result<()>

Verify that a &str is a valid mnemonic.

pub async fn emit_test_event(&self, event: WalletEvent)

Available on crate feature events only.

Helper function to test events. Emits a provided event with account index 0.

Trait Implementations

impl<S: SecretManage> Clone for Wallet<S>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug + SecretManage> Debug for Wallet<S>

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

Formats the value using the given formatter.

impl<S: SecretManage> Deref for Wallet<S>

type Target = WalletInner<S>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S: SecretManage> Drop for Wallet<S>

fn drop(&mut self)

Executes the destructor for this type.