Struct iota_sdk::wallet::account::SyncOptions

pub struct SyncOptions {
    pub addresses: Vec<Bech32Address>,
    pub address_start_index: u32,
    pub address_start_index_internal: u32,
    pub force_syncing: bool,
    pub sync_incoming_transactions: bool,
    pub sync_pending_transactions: bool,
    pub account: AccountSyncOptions,
    pub alias: AliasSyncOptions,
    pub nft: NftSyncOptions,
    pub sync_only_most_basic_outputs: bool,
    pub sync_native_token_foundries: bool,
}

Available on crate feature wallet only.

The synchronization options

Fields

addresses: Vec<Bech32Address>

Specific Bech32 encoded addresses of the account to sync, if addresses are provided, then address_start_index will be ignored

address_start_index: u32

Address index from which to start syncing addresses. 0 by default, using a higher index will be faster because addresses with a lower index will be skipped, but could result in a wrong balance for that reason

address_start_index_internal: u32

Address index from which to start syncing internal addresses. 0 by default, using a higher index will be faster because addresses with a lower index will be skipped, but could result in a wrong balance for that reason

force_syncing: bool

Usually syncing is skipped if it’s called in between 200ms, because there can only be new changes every milestone and calling it twice “at the same time” will not return new data When this to true, we will sync anyways, even if it’s called 0ms after the las sync finished.

sync_incoming_transactions: bool

Try to sync transactions from incoming outputs with their inputs. Some data may not be obtained if it has been pruned.

sync_pending_transactions: bool

Checks pending transactions and promotes/reattaches them if necessary.

account: AccountSyncOptions

Specifies what outputs should be synced for the ed25519 addresses from the account.

alias: AliasSyncOptions

Specifies what outputs should be synced for the address of an alias output.

nft: NftSyncOptions

Specifies what outputs should be synced for the address of an nft output.

sync_only_most_basic_outputs: bool

Specifies if only basic outputs with an AddressUnlockCondition alone should be synced, will overwrite account, alias and nft options.

sync_native_token_foundries: bool

Sync native token foundries, so their metadata can be returned in the balance.

Trait Implementations

impl Clone for SyncOptions

fn clone(&self) -> SyncOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SyncOptions

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

Formats the value using the given formatter.

impl Default for SyncOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SyncOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SyncOptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SyncOptions

fn eq(&self, other: &SyncOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SyncOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SyncOptions

impl StructuralPartialEq for SyncOptions