Struct ShieldedWallet 

pub struct ShieldedWallet<U>
where
    U: ShieldedUtils,
{
    pub utils: U,
    pub tree: BridgeTree,
    pub synced_height: BlockHeight,
    pub spents: IndexSet<NotePosition>,
    pub pos_map: IndexMap<ViewingKey, BTreeSet<NotePosition>>,
    pub nf_map: IndexMap<Nullifier, NotePosition>,
    pub note_map: IndexMap<NotePosition, CompactNote>,
    pub memo_map: IndexMap<NotePosition, MemoBytes>,
    pub asset_types: IndexMap<AssetType, AssetData>,
    pub conversions: EpochedConversions,
    pub note_index: BTreeMap<MaspIndexedTx, NotePosition>,
    pub sync_status: ContextSyncStatus,
}

Represents the current state of the shielded pool from the perspective of the chosen viewing keys.

Fields

utils: U

Location where this shielded context is saved

tree: BridgeTree

The commitment tree produced by scanning all transactions in the MASP

synced_height: BlockHeight

Block height to which the wallet has been synced to

spents: IndexSet<NotePosition>

The set of note positions that have been spent

pos_map: IndexMap<ViewingKey, BTreeSet<NotePosition>>

Maps viewing keys to applicable note positions

The inner set includes notes that have already been spent

nf_map: IndexMap<Nullifier, NotePosition>

Maps a nullifier to the note position to which it applies

note_map: IndexMap<NotePosition, CompactNote>

Maps note positions to their corresponding notes

memo_map: IndexMap<NotePosition, MemoBytes>

Maps note positions to their corresponding memos

asset_types: IndexMap<AssetType, AssetData>

Maps asset types to their decodings

conversions: EpochedConversions

A conversions cache

note_index: BTreeMap<MaspIndexedTx, NotePosition>

Maps a shielded tx to the index of its first output note.

sync_status: ContextSyncStatus

The sync state of the context

Implementations

impl<U> ShieldedWallet<U>

where U: ShieldedUtils + MaybeSend + MaybeSync,

pub async fn load(&mut self)

Try to load the last saved shielded wallet from the given context directory. If the file is missing, an empty wallet is created. Otherwise, we load the wallet and attempt to migrate it to the latest version. This function panics if that fails.

pub async fn try_load<F, X>(&mut self, on_error: F)

where F: Fn(Error) -> X, X: Future<Output = ()>,

Same as the load function, but is provided an async closure as an error handler. This is useful for calling this function from non-CLI frontends.

pub async fn load_confirmed(&mut self)

Try to load the last saved confirmed shielded context from the given context directory.If the file is missing, an empty wallet is created. Otherwise, we load the wallet and attempt to migrate it to the latest version. This function panics if that fails.

pub async fn save(&self) -> Result<(), Error>

Save this shielded context into its associated context directory. If the state to be saved is confirmed than also delete the speculative one (if available)

pub async fn sync<M, T, I>( &mut self, env: impl TaskEnvironment, config: ShieldedSyncConfig<M, T, I>, last_query_height: Option<BlockHeight>, sks: &[DatedKeypair<ExtendedSpendingKey>], fvks: &[DatedKeypair<ViewingKey>], ) -> Result<(), Report>

where M: MaspClient + Send + Sync + Unpin + 'static, T: ProgressBar, I: ShutdownSignal,

Sync the current state of the multi-asset shielded pool in a ShieldedContext with the state on-chain.

pub fn save_decrypted_shielded_outputs( &mut self, vk: &ViewingKey, note_pos: NotePosition, note: Note, pa: PaymentAddress, memo: MemoBytes, ) -> Result<(), Report>

pub fn save_shielded_spends( &mut self, transaction: &Transaction, update_tree: bool, ) -> Result<(), Report>

pub async fn compute_shielded_balance( &mut self, vk: &ViewingKey, ) -> Result<Option<ValueSum<AssetType, i128>>, Report>

Compute the total unspent notes associated with the viewing key in the context. If the key is not in the context, then we do not know the balance and hence we return None.

pub async fn pre_cache_transaction( &mut self, masp_tx: &Transaction, ) -> Result<(), Report>

Updates the internal state with the data of the newly generated transaction. More specifically invalidate the spent notes, but do not cache the newly produced output descriptions and therefore the merkle tree (this is because we don’t know the exact position in the tree where the new notes will be appended)

Trait Implementations

impl<U> BorshDeserialize for ShieldedWallet<U>

where U: ShieldedUtils + Default,

fn deserialize_reader<__R>(reader: &mut __R) -> Result<ShieldedWallet<U>, Error>

where __R: Read,

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl<U> BorshSerialize for ShieldedWallet<U>

where U: ShieldedUtils,

fn serialize<__W>(&self, writer: &mut __W) -> Result<(), Error>

where __W: Write,

impl<U> Debug for ShieldedWallet<U>

where U: Debug + ShieldedUtils,

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

Formats the value using the given formatter.

impl<U> Default for ShieldedWallet<U>

where U: Default + ShieldedUtils,

fn default() -> ShieldedWallet<U>

Returns the “default value” for a type.

impl<U> From<ShieldedContext<U>> for ShieldedWallet<U>

where U: ShieldedUtils,

fn from(ctx: ShieldedContext<U>) -> ShieldedWallet<U>

Converts to this type from the input type.

impl<U> From<ShieldedWallet<U>> for ShieldedWallet<U>

where U: ShieldedUtils,

fn from(wallet: ShieldedWallet<U>) -> ShieldedWallet<U>

Converts to this type from the input type.

impl<U> From<ShieldedWallet<U>> for ShieldedWallet<U>

where U: ShieldedUtils,

fn from(wallet: ShieldedWallet<U>) -> ShieldedWallet<U>

Converts to this type from the input type.