Struct fuel_core::database::Database

pub struct Database { /* private fields */ }

Implementations

impl Database

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

pub fn get_current_block( &self ) -> StorageResult<Option<Cow<'_, CompressedBlock>>>

Get the current block at the head of the chain.

pub fn block_time(&self, height: &BlockHeight) -> StorageResult<Tai64>

pub fn get_block_id( &self, height: &BlockHeight ) -> StorageResult<Option<BlockId>>

pub fn all_block_ids( &self, start: Option<BlockHeight>, direction: IterDirection ) -> impl Iterator<Item = DatabaseResult<(BlockHeight, BlockId)>> + '_

pub fn ids_of_genesis_block(&self) -> DatabaseResult<(BlockHeight, BlockId)>

pub fn ids_of_latest_block( &self ) -> DatabaseResult<Option<(BlockHeight, BlockId)>>

impl Database

pub fn get_contract_config_by_id( &self, contract_id: ContractId ) -> StorageResult<ContractConfig>

pub fn contract_balances( &self, contract: ContractId, start_asset: Option<AssetId>, direction: Option<IterDirection> ) -> impl Iterator<Item = DatabaseResult<(AssetId, Word)>> + '_

pub fn get_contract_config(&self) -> StorageResult<Option<Vec<ContractConfig>>>

impl Database

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

pub fn all_messages( &self, start: Option<MessageId>, direction: Option<IterDirection> ) -> impl Iterator<Item = DatabaseResult<CompressedMessage>> + '_

pub fn get_message_config(&self) -> StorageResult<Option<Vec<MessageConfig>>>

pub fn is_message_spent(&self, message_id: &MessageId) -> StorageResult<bool>

pub fn message_status( &self, message_id: &MessageId ) -> StorageResult<MessageStatus>

impl Database

pub fn get_sealed_block_by_id( &self, block_id: &BlockId ) -> StorageResult<Option<SealedBlock>>

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

Returns SealedBlock by height. Reusable across different trait implementations

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

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

pub fn get_sealed_block_header( &self, block_id: &BlockId ) -> StorageResult<Option<SealedBlockHeader>>

pub fn get_transactions_on_block( &self, block_id: &BlockId ) -> StorageResult<Option<Vec<Transaction>>>

impl Database

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

pub fn get_coin_config(&self) -> DatabaseResult<Option<Vec<CoinConfig>>>

impl Database

pub fn init(&self, config: &ChainConfig) -> DatabaseResult<()>

Ensures the database is initialized and that the database version is correct

pub fn get_chain_name(&self) -> DatabaseResult<Option<String>>

impl Database

pub fn all_transactions( &self, start: Option<&Bytes32>, direction: Option<IterDirection> ) -> impl Iterator<Item = DatabaseResult<Transaction>> + '_

pub fn owned_transactions( &self, owner: Address, start: Option<OwnedTransactionIndexCursor>, direction: Option<IterDirection> ) -> impl Iterator<Item = DatabaseResult<(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 record_tx_id_owner( &self, owner: &Address, block_height: BlockHeight, tx_idx: TransactionIndex, tx_id: &Bytes32 ) -> DatabaseResult<Option<Bytes32>>

pub fn update_tx_status( &self, id: &Bytes32, status: TransactionStatus ) -> DatabaseResult<Option<TransactionStatus>>

pub fn get_tx_status( &self, id: &Bytes32 ) -> DatabaseResult<Option<TransactionStatus>>

impl Database

pub fn new(data_source: DataSource) -> Self

pub fn open(path: &Path, capacity: impl Into<Option<usize>>) -> Result<Self>

pub fn in_memory() -> Self

pub fn transaction(&self) -> DatabaseTransaction

Trait Implementations

impl AsMut<Database> for DatabaseTransaction

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

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

impl AsRef<Database> for Database

fn as_ref(&self) -> &Database

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

impl AsRef<Database> for DatabaseTransaction

fn as_ref(&self) -> &Database

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

impl BlockProducerDatabase for Database

fn get_block( &self, height: &BlockHeight ) -> StorageResult<Cow<'_, CompressedBlock>>

Gets the committed block at the height.

fn block_header_merkle_root( &self, height: &BlockHeight ) -> StorageResult<Bytes32>

Gets the block header BMT MMR root at height.

fn current_block_height(&self) -> StorageResult<BlockHeight>

Fetch the current block height.

impl ChainConfigDb for Database

Implement ChainConfigDb so that Database can be passed to StateConfig's generate_state_config() method

fn get_coin_config(&self) -> StorageResult<Option<Vec<CoinConfig>>>

Returns all unspent coin configs available in the database.

fn get_contract_config(&self) -> StorageResult<Option<Vec<ContractConfig>>>

Returns alive contract configs available in the database.

fn get_message_config(&self) -> StorageResult<Option<Vec<MessageConfig>>>

Returns all unspent message configs available in the database.

fn get_block_height(&self) -> StorageResult<BlockHeight>

Returns the last available block height.

impl Clone for Database

fn clone(&self) -> Database

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContractStorageTrait for Database

Implemented to satisfy: GenesisCommitment for ContractRef<&'a mut Database>

type InnerError = Error

impl Database for Database

fn block_header(&self, height: &BlockHeight) -> StorageResult<BlockHeader>

Gets the block header at height.

fn block_header_merkle_root( &self, height: &BlockHeight ) -> StorageResult<Bytes32>

Gets the block header BMT MMR root at height.

impl DatabaseBlocks for Database

fn block_id(&self, height: &BlockHeight) -> StorageResult<BlockId>

fn blocks_ids( &self, start: Option<BlockHeight>, direction: IterDirection ) -> BoxedIter<'_, StorageResult<(BlockHeight, BlockId)>>

fn ids_of_latest_block(&self) -> StorageResult<(BlockHeight, BlockId)>

impl DatabaseChain for Database

fn chain_name(&self) -> StorageResult<String>

fn base_chain_height(&self) -> StorageResult<DaBlockHeight>

impl DatabaseCoins for Database

fn owned_coins_ids( &self, owner: &Address, start_coin: Option<UtxoId>, direction: IterDirection ) -> BoxedIter<'_, StorageResult<UtxoId>>

impl DatabaseContracts for Database

fn contract_balances( &self, contract: ContractId, start_asset: Option<AssetId>, direction: IterDirection ) -> BoxedIter<'_, StorageResult<ContractBalance>>

impl DatabaseMessages for Database

fn owned_message_ids( &self, owner: &Address, start_message_id: Option<MessageId>, direction: IterDirection ) -> BoxedIter<'_, StorageResult<MessageId>>

fn all_messages( &self, start_message_id: Option<MessageId>, direction: IterDirection ) -> BoxedIter<'_, StorageResult<Message>>

impl DatabaseTransactions for Database

fn tx_status(&self, tx_id: &TxId) -> StorageResult<TransactionStatus>

fn owned_transactions_ids( &self, owner: Address, start: Option<TxPointer>, direction: IterDirection ) -> BoxedIter<'_, StorageResult<(TxPointer, TxId)>>

impl Debug for Database

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

Formats the value using the given formatter.

impl Default for Database

Construct an ephemeral database uses rocksdb when rocksdb features are enabled uses in-memory when rocksdb features are disabled

fn default() -> Self

Returns the “default value” for a type.

impl ExecutorDatabase for Database

fn seal_block( &mut self, block_id: &BlockId, consensus: &Consensus ) -> StorageResult<Option<Consensus>>

Assigns the Consensus data to the block under the block_id. Return the previous value at the height, if any.

impl From<&Database> for DatabaseTransaction

fn from(source: &Database) -> Self

Converts to this type from the input type.

impl ImporterDatabase for Database

fn latest_block_height(&self) -> StorageResult<BlockHeight>

Returns the latest block height.

impl MerkleRootStorage<BlockHeight, FuelBlocks> for Database

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

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

impl MerkleRootStorage<ContractId, ContractsAssets> for Database

fn root(&self, _: &ContractId) -> Result<MerkleRoot, Self::Error>

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

impl MerkleRootStorage<ContractId, ContractsState> for Database

fn root(&self, _: &ContractId) -> Result<MerkleRoot, Self::Error>

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

impl StorageInspect<Coins> for Database

type Error = Error

fn get( &self, key: &UtxoId ) -> Result<Option<Cow<'_, CompressedCoin>>, Self::Error>

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

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

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

impl StorageInspect<ContractsAssets> for Database

type Error = Error

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

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

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

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

impl StorageInspect<ContractsRawCode> for Database

type Error = Error

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

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

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

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

impl StorageInspect<ContractsState> for Database

type Error = Error

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

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

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

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

impl StorageInspect<FuelBlocks> for Database

type Error = Error

fn get( &self, key: &BlockId ) -> Result<Option<Cow<'_, CompressedBlock>>, Self::Error>

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

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

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

impl StorageInspect<Messages> for Database

type Error = Error

fn get( &self, key: &MessageId ) -> Result<Option<Cow<'_, CompressedMessage>>, Self::Error>

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

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

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

impl<T> StorageInspect<T> for Databasewhere T: Mappable + DatabaseColumn, T::Key: ToDatabaseKey, T::OwnedValue: DeserializeOwned,

type Error = Error

fn get(&self, key: &T::Key) -> StorageResult<Option<Cow<'_, T::OwnedValue>>>

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

fn contains_key(&self, key: &T::Key) -> StorageResult<bool>

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

impl StorageMutate<Coins> for Database

fn insert( &mut self, key: &UtxoId, value: &CompressedCoin ) -> Result<Option<CompressedCoin>, Self::Error>

Append Key->Value mapping to the storage.

fn remove( &mut self, key: &UtxoId ) -> Result<Option<CompressedCoin>, Self::Error>

Remove Key->Value mapping from the storage.

impl StorageMutate<ContractsAssets> for Database

fn insert( &mut self, key: &<ContractsAssets as Mappable>::Key, value: &<ContractsAssets as Mappable>::Value ) -> Result<Option<<ContractsAssets as Mappable>::OwnedValue>, Self::Error>

Append Key->Value mapping to the storage.

fn remove( &mut self, key: &<ContractsAssets as Mappable>::Key ) -> Result<Option<<ContractsAssets as Mappable>::OwnedValue>, Self::Error>

Remove Key->Value mapping from the storage.

impl StorageMutate<ContractsRawCode> for Database

fn insert( &mut self, key: &<ContractsRawCode as Mappable>::Key, value: &<ContractsRawCode as Mappable>::Value ) -> Result<Option<<ContractsRawCode as Mappable>::OwnedValue>, Self::Error>

Append Key->Value mapping to the storage.

fn remove( &mut self, key: &<ContractsRawCode as Mappable>::Key ) -> Result<Option<<ContractsRawCode as Mappable>::OwnedValue>, Self::Error>

Remove Key->Value mapping from the storage.

impl StorageMutate<ContractsState> for Database

fn insert( &mut self, key: &<ContractsState as Mappable>::Key, value: &<ContractsState as Mappable>::Value ) -> Result<Option<<ContractsState as Mappable>::OwnedValue>, Self::Error>

Append Key->Value mapping to the storage.

fn remove( &mut self, key: &<ContractsState as Mappable>::Key ) -> Result<Option<<ContractsState as Mappable>::OwnedValue>, Self::Error>

Remove Key->Value mapping from the storage.

impl StorageMutate<FuelBlocks> for Database

fn insert( &mut self, key: &BlockId, value: &CompressedBlock ) -> Result<Option<CompressedBlock>, Self::Error>

Append Key->Value mapping to the storage.

fn remove( &mut self, key: &BlockId ) -> Result<Option<CompressedBlock>, Self::Error>

Remove Key->Value mapping from the storage.

impl StorageMutate<Messages> for Database

fn insert( &mut self, key: &MessageId, value: &CompressedMessage ) -> Result<Option<CompressedMessage>, Self::Error>

Append Key->Value mapping to the storage.

fn remove( &mut self, key: &MessageId ) -> Result<Option<CompressedMessage>, Self::Error>

Remove Key->Value mapping from the storage.

impl<T> StorageMutate<T> for Databasewhere T: Mappable + DatabaseColumn, T::Key: ToDatabaseKey, T::Value: Serialize, T::OwnedValue: DeserializeOwned,

fn insert( &mut self, key: &T::Key, value: &T::Value ) -> StorageResult<Option<T::OwnedValue>>

Append Key->Value mapping to the storage.

fn remove(&mut self, key: &T::Key) -> StorageResult<Option<T::OwnedValue>>

Remove Key->Value mapping from the storage.

impl Transaction<Database> for DatabaseTransaction

fn commit(&mut self) -> StorageResult<()>

Commits the pending state changes into the storage.

impl Transactional for Database

type Storage = Database

The storage used when creating the transaction.

fn transaction(&self) -> StorageTransaction<Database>

Creates and returns the storage transaction.

impl TxPoolDb for Database

fn utxo(&self, utxo_id: &UtxoId) -> StorageResult<Option<CompressedCoin>>

fn contract_exist(&self, contract_id: &ContractId) -> StorageResult<bool>

fn message( &self, message_id: &MessageId ) -> StorageResult<Option<CompressedMessage>>

fn is_message_spent(&self, message_id: &MessageId) -> StorageResult<bool>

fn current_block_height(&self) -> StorageResult<BlockHeight>

impl DatabasePort for Database

impl Send for Database

• SAFETY: we are safe to do it because DataSource is Send+Sync and there is nowhere it is overwritten it is not Send+Sync by default because Storage insert fn takes &mut self

impl Sync for Database