Struct penumbra_view::Storage
source · pub struct Storage { /* private fields */ }
Implementations§
source§impl Storage
impl Storage
sourcepub async fn load_or_initialize(
storage_path: Option<impl AsRef<Utf8Path>>,
fvk: &FullViewingKey,
node: Url
) -> Result<Self>
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: ChainParameters ) -> Result<Self>
sourcepub async fn balances(
&self,
address_index: Option<AddressIndex>,
asset_id: Option<Id>
) -> Result<BTreeMap<Id, u128>>
pub async fn balances( &self, address_index: Option<AddressIndex>, asset_id: Option<Id> ) -> Result<BTreeMap<Id, u128>>
Query for account balance by address
sourcepub async fn note_by_commitment(
&self,
note_commitment: StateCommitment,
await_detection: bool
) -> Result<SpendableNoteRecord>
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.
sourcepub async fn swap_by_commitment(
&self,
swap_commitment: StateCommitment,
await_detection: bool
) -> Result<SwapRecord>
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.
sourcepub async fn unclaimed_swaps(&self) -> Result<Vec<SwapRecord>>
pub async fn unclaimed_swaps(&self) -> Result<Vec<SwapRecord>>
Query for all unclaimed swaps.
sourcepub async fn nullifier_status(
&self,
nullifier: Nullifier,
await_detection: bool
) -> Result<bool>
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.
sourcepub async fn last_sync_height(&self) -> Result<Option<u64>>
pub async fn last_sync_height(&self) -> Result<Option<u64>>
The last block height we’ve scanned to, if any.
pub async fn chain_params(&self) -> Result<ChainParameters>
pub async fn fmd_parameters(&self) -> Result<FmdParameters>
pub async fn full_viewing_key(&self) -> Result<FullViewingKey>
pub async fn state_commitment_tree(&self) -> Result<Tree>
sourcepub async fn transaction_hashes(
&self,
start_height: Option<u64>,
end_height: Option<u64>
) -> Result<Vec<(u64, Vec<u8>)>>
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.
sourcepub async fn transactions(
&self,
start_height: Option<u64>,
end_height: Option<u64>
) -> Result<Vec<(u64, Vec<u8>, Transaction)>>
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<DenomMetadata>>
pub async fn asset_by_id(&self, id: &Id) -> Result<Option<DenomMetadata>>
pub async fn assets_matching( &self, pattern: String ) -> Result<Vec<DenomMetadata>>
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: DenomMetadata) -> Result<()>
pub async fn record_unknown_asset(&self, id: Id) -> Result<()>
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<()>
sourcepub async fn scan_advice(
&self,
note_commitments: Vec<StateCommitment>
) -> Result<BTreeMap<StateCommitment, Note>>
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.
sourcepub async fn filter_nullifiers(
&self,
nullifiers: Vec<Nullifier>
) -> Result<Vec<Nullifier>>
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 ) -> 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>>
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for Storage
impl Send for Storage
impl Sync for Storage
impl Unpin for Storage
impl !UnwindSafe for Storage
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_mut()
into the pipe
function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
.tap_ref_mut()
only in debug builds, and is erased in release
builds.