Struct GenericDatabase 

pub struct GenericDatabase<Storage, Metadata> { /* private fields */ }

Implementations

impl GenericDatabase<IterableKeyValueViewWrapper<<OffChain as DatabaseDescription>::Column>, <OffChain as DatabaseDescription>::Height>

pub fn get_block_height( &self, id: &BlockId, ) -> StorageResult<Option<BlockHeight>>

impl GenericDatabase<IterableKeyValueViewWrapper<<OnChain as DatabaseDescription>::Column>, <OnChain as DatabaseDescription>::Height>

pub fn latest_compressed_block(&self) -> StorageResult<Option<CompressedBlock>>

pub fn get_current_block(&self) -> StorageResult<Option<CompressedBlock>>

Get the current block at the head of the chain.

pub fn get_full_block( &self, height: &BlockHeight, ) -> StorageResult<Option<Block>>

Retrieve the full block and all associated transactions

impl GenericDatabase<IterableKeyValueViewWrapper<<OnChain as DatabaseDescription>::Column>, <OnChain as DatabaseDescription>::Height>

pub fn block_history_proof( &self, message_block_height: &BlockHeight, commit_block_height: &BlockHeight, ) -> StorageResult<MerkleProof>

impl GenericDatabase<IterableKeyValueViewWrapper<<OffChain as DatabaseDescription>::Column>, <OffChain as DatabaseDescription>::Height>

pub fn owned_coins_ids( &self, owner: &Address, start_coin: Option<UtxoId>, direction: Option<IterDirection>, ) -> impl Iterator<Item = StorageResult<UtxoId>> + '_ + use<'_>

impl GenericDatabase<IterableKeyValueViewWrapper<<OnChain as DatabaseDescription>::Column>, <OnChain as DatabaseDescription>::Height>

pub fn coin(&self, utxo_id: &UtxoId) -> StorageResult<CompressedCoin>

impl GenericDatabase<IterableKeyValueViewWrapper<<OnChain as DatabaseDescription>::Column>, <OnChain as DatabaseDescription>::Height>

pub fn iter_contract_state( &self, ) -> impl Iterator<Item = StorageResult<TableEntry<ContractsState>>> + '_

pub fn iter_contract_balance( &self, ) -> impl Iterator<Item = StorageResult<TableEntry<ContractsAssets>>> + '_

pub fn iter_contracts_code( &self, ) -> impl Iterator<Item = StorageResult<TableEntry<ContractsRawCode>>> + '_

pub fn iter_contracts_latest_utxo( &self, ) -> impl Iterator<Item = StorageResult<TableEntry<ContractsLatestUtxo>>> + '_

pub fn contract_code( &self, contract_id: ContractId, ) -> StorageResult<TableEntry<ContractsRawCode>>

pub fn contract_latest_utxo( &self, contract_id: ContractId, ) -> StorageResult<TableEntry<ContractsLatestUtxo>>

pub fn filter_contract_balances( &self, contract: ContractId, start_asset: Option<AssetId>, direction: Option<IterDirection>, ) -> impl Iterator<Item = StorageResult<TableEntry<ContractsAssets>>> + '_

impl GenericDatabase<DataSource<OnChain, GenesisStage>, Empty>

pub fn genesis_coins_root(&self) -> Result<MerkleRoot>

pub fn genesis_messages_root(&self) -> Result<MerkleRoot>

pub fn genesis_contracts_root(&self) -> Result<MerkleRoot>

pub fn processed_transactions_root(&self) -> Result<MerkleRoot>

impl GenericDatabase<IterableKeyValueViewWrapper<<OffChain as DatabaseDescription>::Column>, <OffChain as DatabaseDescription>::Height>

pub fn owned_message_ids( &self, owner: &Address, start_message_id: Option<Nonce>, direction: Option<IterDirection>, ) -> impl Iterator<Item = StorageResult<Nonce>> + '_ + use<'_>

pub fn message_is_spent(&self, id: &Nonce) -> StorageResult<bool>

impl GenericDatabase<IterableKeyValueViewWrapper<<OnChain as DatabaseDescription>::Column>, <OnChain as DatabaseDescription>::Height>

pub fn all_messages( &self, start: Option<Nonce>, direction: Option<IterDirection>, ) -> impl Iterator<Item = StorageResult<Message>> + '_

pub fn iter_messages( &self, ) -> impl Iterator<Item = StorageResult<TableEntry<Messages>>> + '_

pub fn message_exists(&self, id: &Nonce) -> StorageResult<bool>

impl<Description, Stage> GenericDatabase<DataSource<Description, Stage>, Empty>

where Description: DatabaseDescription, Self: StorageInspect<MetadataTable<Description>, Error = Error>,

pub fn check_version(&self) -> StorageResult<()>

Ensures the version is correct.

pub fn latest_height_from_metadata( &self, ) -> StorageResult<Option<Description::Height>>

pub fn indexation_available(&self, kind: IndexationKind) -> StorageResult<bool>

impl GenericDatabase<IterableKeyValueViewWrapper<<OnChain as DatabaseDescription>::Column>, <OnChain as DatabaseDescription>::Height>

pub fn get_sealed_block_by_height( &self, height: &BlockHeight, ) -> StorageResult<Option<SealedBlock>>

Returns SealedBlock by height. Reusable across different trait implementations

pub fn genesis_height(&self) -> StorageResult<Option<BlockHeight>>

pub fn genesis_block(&self) -> StorageResult<Option<CompressedBlock>>

pub fn get_genesis(&self) -> StorageResult<Genesis>

pub fn get_sealed_block_headers( &self, block_height_range: Range<u32>, ) -> StorageResult<Option<Vec<SealedBlockHeader>>>

pub fn get_sealed_block_header( &self, height: &BlockHeight, ) -> StorageResult<Option<SealedBlockHeader>>

pub fn get_transactions_on_blocks( &self, block_height_range: Range<u32>, ) -> StorageResult<Option<Vec<Transactions>>>

impl GenericDatabase<IterableKeyValueViewWrapper<<OffChain as DatabaseDescription>::Column>, <OffChain as DatabaseDescription>::Height>

pub fn owned_transactions( &self, owner: Address, start: Option<OwnedTransactionIndexCursor>, direction: Option<IterDirection>, ) -> impl Iterator<Item = StorageResult<(TxPointer, Bytes32)>> + '_

Iterates over a KV mapping of [address + block height + tx idx] => transaction id. This allows for efficient lookup of transaction ids associated with an address, sorted by block age and ordering within a block. The cursor tracks the [block height + tx idx] for pagination purposes.

pub fn get_tx_status( &self, id: &Bytes32, ) -> StorageResult<Option<TransactionExecutionStatus>>

impl GenericDatabase<IterableKeyValueViewWrapper<<OnChain as DatabaseDescription>::Column>, <OnChain as DatabaseDescription>::Height>

pub fn maybe_latest_height(&self) -> StorageResult<Option<BlockHeight>>

pub fn latest_height(&self) -> StorageResult<BlockHeight>

pub fn latest_block(&self) -> StorageResult<CompressedBlock>

impl<DbDesc> GenericDatabase<DataSource<DbDesc, RegularStage<DbDesc>>, Empty>

where DbDesc: DatabaseDescription,

pub fn entries<'a, T>( &'a self, prefix: Option<Vec<u8>>, direction: IterDirection, ) -> impl Iterator<Item = StorageResult<TableEntry<T>>> + 'a

where T: Mappable + 'a, Self: IterableTable<T>,

pub fn shutdown(self)

impl<Description> GenericDatabase<DataSource<Description, GenesisStage>, Empty>

where Description: DatabaseDescription,

pub fn new(data_source: DataSourceType<Description>) -> Self

impl<Description> GenericDatabase<DataSource<Description, RegularStage<Description>>, Empty>

where Description: DatabaseDescription, Database<Description>: StorageInspect<MetadataTable<Description>, Error = Error>,

pub fn new(data_source: DataSourceType<Description>) -> Self

pub fn open_rocksdb( path: &Path, state_rewind_policy: StateRewindPolicy, database_config: DatabaseConfig, ) -> Result<Self>

pub fn into_genesis( self, ) -> Result<GenesisDatabase<Description>, GenesisDatabase<Description>>

Converts the regular database to an unchecked database.

Returns an error in the case regular database is initialized with the GenesisDatabase, to highlight that it is a bad idea and it is unsafe.

impl<Description, Stage> GenericDatabase<DataSource<Description, Stage>, Empty>

where Description: DatabaseDescription, Stage: Default,

pub fn in_memory() -> Self

pub fn rocksdb_temp( state_rewind_policy: StateRewindPolicy, database_config: DatabaseConfig, ) -> Result<Self>

impl<Description> GenericDatabase<DataSource<Description, RegularStage<Description>>, Empty>

where Description: DatabaseDescription,

pub fn rollback_last_block(&self) -> StorageResult<()>

impl<Storage, Metadata> GenericDatabase<Storage, Metadata>

pub fn inner_storage(&self) -> &Storage

pub fn metadata(&self) -> Option<&Metadata>

pub fn from_storage_and_metadata( storage: Storage, metadata: Option<Metadata>, ) -> Self

pub fn into_inner(self) -> (Storage, Option<Metadata>)

impl<Column, Height> GenericDatabase<IterableKeyValueViewWrapper<Column>, Height>

where Column: StorageColumn + 'static,

pub fn into_key_value_view(self) -> KeyValueView<Column, Height>

Downgrades the IterableKeyValueView into the KeyValueView.

Trait Implementations

impl<Storage, Metadata> AsMut<Storage> for GenericDatabase<Storage, Metadata>

fn as_mut(&mut self) -> &mut Storage

Converts this type into a mutable reference of the (usually inferred) input type.

impl<Storage, Metadata> AsRef<Storage> for GenericDatabase<Storage, Metadata>

fn as_ref(&self) -> &Storage

Converts this type into a shared reference of the (usually inferred) input type.

impl<Storage: Clone, Metadata: Clone> Clone for GenericDatabase<Storage, Metadata>

fn clone(&self) -> GenericDatabase<Storage, Metadata>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Storage: Debug, Metadata: Debug> Debug for GenericDatabase<Storage, Metadata>

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

Formats the value using the given formatter.

impl<Storage, Metadata> Deref for GenericDatabase<Storage, Metadata>

type Target = Storage

The resulting type after dereferencing.

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

Dereferences the value.

impl<Storage, Metadata> DerefMut for GenericDatabase<Storage, Metadata>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<Storage, Metadata> IterableStore for GenericDatabase<Storage, Metadata>

where Storage: IterableStore,

fn iter_store( &self, column: Self::Column, prefix: Option<&[u8]>, start: Option<&[u8]>, direction: IterDirection, ) -> BoxedIter<'_, KVItem>

Returns an iterator over the values in the storage.

fn iter_store_keys( &self, column: Self::Column, prefix: Option<&[u8]>, start: Option<&[u8]>, direction: IterDirection, ) -> BoxedIter<'_, KeyItem>

Returns an iterator over keys in the storage.

impl<Storage, Metadata> KeyValueInspect for GenericDatabase<Storage, Metadata>

where Storage: KeyValueInspect,

type Column = <Storage as KeyValueInspect>::Column

The type of the column.

fn exists(&self, key: &[u8], column: Self::Column) -> StorageResult<bool>

Checks if the value exists in the storage.

fn size_of_value( &self, key: &[u8], column: Self::Column, ) -> StorageResult<Option<usize>>

Returns the size of the value in the storage.

fn get(&self, key: &[u8], column: Self::Column) -> StorageResult<Option<Value>>

Returns the value from the storage.

fn read( &self, key: &[u8], column: Self::Column, offset: usize, buf: &mut [u8], ) -> StorageResult<bool>

Reads the value from the storage into the buf and returns the whether the value exists.

impl<Key, M, Storage, Metadata> MerkleRootStorage<Key, M> for GenericDatabase<Storage, Metadata>

where M: Mappable, StructuredStorage<Storage>: MerkleRootStorage<Key, M, Error = Error>,

fn root(&self, key: &Key) -> Result<MerkleRoot, Self::Error>

Return the merkle root of the stored Type in the storage.

impl<Storage, Error, Metadata> PredicateStorageRequirements for GenericDatabase<Storage, Metadata>

where Self: StorageRead<BlobData, Error = Error>, Error: Debug,

fn storage_error_to_string(error: Error) -> String

Converts the storage error to a string.

impl<M, Storage, Metadata> StorageInspect<M> for GenericDatabase<Storage, Metadata>

where M: Mappable, StructuredStorage<Storage>: StorageInspect<M, Error = Error>,

type Error = Error

fn get( &self, key: &M::Key, ) -> Result<Option<Cow<'_, M::OwnedValue>>, Self::Error>

Retrieve Cow<Value> such as Key->Value.

fn contains_key(&self, key: &M::Key) -> Result<bool, Self::Error>

Return true if there is a Key mapping to a value in the storage.

impl<M, Storage, Metadata> StorageRead<M> for GenericDatabase<Storage, Metadata>

where M: Mappable, StructuredStorage<Storage>: StorageRead<M, Error = Error>,

fn read( &self, key: &M::Key, offset: usize, buf: &mut [u8], ) -> Result<bool, Self::Error>

Read the value stored at the given key into the provided buffer if the value exists. Errors if the buffer cannot be filled completely, or if attempting to read past the end of the value.

fn read_alloc(&self, key: &M::Key) -> Result<Option<Vec<u8>>, Self::Error>

Same as read but allocates a new buffer and returns it.

impl<M, Storage, Metadata> StorageSize<M> for GenericDatabase<Storage, Metadata>

where M: Mappable, StructuredStorage<Storage>: StorageSize<M, Error = Error>,

fn size_of_value(&self, key: &M::Key) -> Result<Option<usize>, Self::Error>

Return the number of bytes stored at this key.