Struct Storage

pub struct Storage { /* private fields */ }

Implementations

impl Storage

pub async fn load_or_initialize( storage_path: Option<impl AsRef<Utf8Path>>, fvk: &FullViewingKey, node: Url, ) -> Result<Self>

If the database at storage_path exists, Self::load it, otherwise, Self::initialize it.

pub async fn load(path: impl AsRef<Utf8Path>) -> Result<Self>

pub async fn initialize( storage_path: Option<impl AsRef<Utf8Path>>, fvk: FullViewingKey, params: AppParameters, ) -> Result<Self>

pub async fn load_asset_metadata( &self, registry_path: impl AsRef<Utf8Path>, ) -> Result<()>

Loads asset metadata from a JSON file and use to update the database.

pub async fn balances( &self, address_index: Option<AddressIndex>, asset_id: Option<Id>, ) -> Result<Vec<BalanceEntry>>

Query for account balance by address

pub async fn note_by_commitment( &self, note_commitment: StateCommitment, await_detection: bool, ) -> Result<SpendableNoteRecord>

Query for a note by its note commitment, optionally waiting until the note is detected.

pub async fn swap_by_commitment( &self, swap_commitment: StateCommitment, await_detection: bool, ) -> Result<SwapRecord>

Query for a swap by its swap commitment, optionally waiting until the note is detected.

pub async fn unclaimed_swaps(&self) -> Result<Vec<SwapRecord>>

Query for all unclaimed swaps.

pub async fn nullifier_status( &self, nullifier: Nullifier, await_detection: bool, ) -> Result<bool>

Query for a nullifier’s status, optionally waiting until the nullifier is detected.

pub async fn last_sync_height(&self) -> Result<Option<u64>>

The last block height we’ve scanned to, if any.

pub async fn app_params(&self) -> Result<AppParameters>

pub async fn gas_prices(&self) -> Result<GasPrices>

pub async fn fmd_parameters(&self) -> Result<Parameters>

pub async fn full_viewing_key(&self) -> Result<FullViewingKey>

pub async fn state_commitment_tree(&self) -> Result<Tree>

pub async fn transaction_hashes( &self, start_height: Option<u64>, end_height: Option<u64>, ) -> Result<Vec<(u64, Vec<u8>)>>

Returns a tuple of (block height, transaction hash) for all transactions in a given range of block heights.

pub async fn transactions( &self, start_height: Option<u64>, end_height: Option<u64>, ) -> Result<Vec<(u64, Vec<u8>, Transaction)>>

Returns a tuple of (block height, transaction hash, transaction) for all transactions in a given range of block heights.

pub async fn transaction_by_hash( &self, tx_hash: &[u8], ) -> Result<Option<(u64, Transaction)>>

pub async fn note_by_nullifier( &self, nullifier: Nullifier, await_detection: bool, ) -> Result<SpendableNoteRecord>

pub async fn all_assets(&self) -> Result<Vec<Metadata>>

pub async fn asset_by_id(&self, id: &Id) -> Result<Option<Metadata>>

pub async fn assets_matching(&self, pattern: String) -> Result<Vec<Metadata>>

pub async fn notes( &self, include_spent: bool, asset_id: Option<Id>, address_index: Option<AddressIndex>, amount_to_spend: Option<Amount>, ) -> Result<Vec<SpendableNoteRecord>>

pub async fn notes_for_voting( &self, address_index: Option<AddressIndex>, votable_at_height: u64, ) -> Result<Vec<(SpendableNoteRecord, IdentityKey)>>

pub async fn record_asset(&self, asset: Metadata) -> Result<()>

pub async fn record_auction_with_state( &self, auction_id: AuctionId, auction_state: u64, ) -> Result<()>

pub async fn update_auction_with_note_commitment( &self, auction_id: AuctionId, note_commitment: StateCommitment, ) -> Result<()>

pub async fn fetch_auctions_by_account( &self, account_filter: Option<AddressIndex>, include_inactive: bool, ) -> Result<Vec<(AuctionId, SpendableNoteRecord, u64)>>

pub async fn record_position(&self, position: Position) -> Result<()>

pub async fn update_position( &self, position_id: Id, position_state: State, ) -> Result<()>

pub async fn record_empty_block(&self, height: u64) -> Result<()>

pub async fn give_advice(&self, note: Note) -> Result<()>

pub async fn scan_advice( &self, note_commitments: Vec<StateCommitment>, ) -> Result<BTreeMap<StateCommitment, Note>>

Return advice about note contents for use in scanning.

Given a list of note commitments, this method checks whether any of them correspond to notes that have been recorded in the database but not yet observed during scanning.

pub async fn filter_nullifiers( &self, nullifiers: Vec<Nullifier>, ) -> Result<Vec<Nullifier>>

Filters for nullifiers whose notes we control

pub async fn record_block( &self, filtered_block: FilteredBlock, transactions: Vec<Transaction>, sct: &mut Tree, channel: Channel, ) -> Result<()>

pub async fn owned_position_ids( &self, position_state: Option<State>, trading_pair: Option<TradingPair>, ) -> Result<Vec<Id>>

pub async fn notes_by_sender( &self, return_address: &Address, ) -> Result<Vec<SpendableNoteRecord>>

pub async fn transactions_matching_memo( &self, pattern: String, ) -> Result<Vec<(u64, Vec<u8>, Transaction, String)>>

Get all transactions with a matching memo text. The pattern argument should include SQL wildcards, such as % and _, to match substrings, e.g. %foo%.

Trait Implementations

impl Clone for Storage

fn clone(&self) -> Storage

Returns a copy of the value.

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

Performs copy-assignment from source.