Struct fuel_core::database::Database

pub struct Database { /* private fields */ }

Implementations

impl Database

pub fn get_block_height(&self) -> Result<Option<BlockHeight>, Error>

pub fn get_block_id(
    &self,
    height: BlockHeight
) -> Result<Option<Bytes32>, Error>

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

impl Database

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

pub fn owned_coins_by_asset_id(
    &self,
    owner: Address,
    asset_id: AssetId,
    start_coin: Option<UtxoId>,
    direction: Option<IterDirection>
) -> impl Iterator<Item = Result<UtxoId, Error>> + '_

impl Database

pub fn init_chain_name(&self, name: String) -> Result<(), Error>

pub fn get_chain_name(&self) -> Result<Option<String>, Error>

pub fn init_chain_height(&self, height: BlockHeight) -> Result<(), Error>

pub fn get_starting_chain_height(&self) -> Result<Option<BlockHeight>, Error>

impl Database

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

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

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
) -> Result<Option<Bytes32>, Error>

pub fn update_tx_status(
    &self,
    tx_id: &Bytes32,
    status: TransactionStatus
) -> Result<Option<TransactionStatus>, Error>

pub fn get_tx_status(
    &self,
    tx_id: &Bytes32
) -> Result<Option<TransactionStatus>, Error>

impl Database

pub fn open(path: &Path) -> Result<Self, Error>

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 DatabaseTransaction

fn as_ref(&self) -> &Database

Converts this type into a shared 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 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 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 From<&'_ Database> for DatabaseTransaction

fn from(source: &Database) -> Self

Converts to this type from the input type.

impl InterpreterStorage for Database

type DataError = Error

Error implementation for reasons unspecified in the protocol.

fn block_height(&self) -> Result<u32, Error>

Provide the current block height in which the transactions should be executed.

fn block_hash(&self, block_height: u32) -> Result<Bytes32, Error>

Provide the block hash from a given height.

fn coinbase(&self) -> Result<Address, Error>

Provide the coinbase address for the VM instructions implementation.

fn storage_contract(
    &self,
    id: &ContractId
) -> Result<Option<Cow<'_, Contract>>, Self::DataError>

Fetch a previously inserted contract code from the chain state for a given contract.

fn storage_contract_insert(
    &mut self,
    id: &ContractId,
    contract: &Contract
) -> Result<Option<Contract>, Self::DataError>

Append a contract to the chain, provided its identifier.

fn storage_contract_exists(
    &self,
    id: &ContractId
) -> Result<bool, Self::DataError>

Check if a provided contract exists in the chain.

fn storage_contract_root(
    &self,
    id: &ContractId
) -> Result<Option<Cow<'_, (Salt, Bytes32)>>, Self::DataError>

Fetch a previously inserted salt+root tuple from the chain state for a given contract.

fn storage_contract_root_insert(
    &mut self,
    id: &ContractId,
    salt: &Salt,
    root: &Bytes32
) -> Result<Option<(Salt, Bytes32)>, Self::DataError>

Append the salt+root of a contract that was appended to the chain.

fn merkle_contract_state(
    &self,
    id: &ContractId,
    key: &Bytes32
) -> Result<Option<Cow<'_, Bytes32>>, Self::DataError>

Fetch the value form a key-value mapping in a contract storage.

fn merkle_contract_state_insert(
    &mut self,
    contract: &ContractId,
    key: &Bytes32,
    value: &Bytes32
) -> Result<Option<Bytes32>, Self::DataError>

Insert a key-value mapping in a contract storage.

fn merkle_contract_asset_id_balance(
    &self,
    id: &ContractId,
    asset_id: &AssetId
) -> Result<Option<u64>, Self::DataError>

Fetch the balance of an asset ID in a contract storage.

fn merkle_contract_asset_id_balance_insert(
    &mut self,
    contract: &ContractId,
    asset_id: &AssetId,
    value: u64
) -> Result<Option<u64>, Self::DataError>

Update the balance of an asset ID in a contract storage.

impl MerkleStorage<ContractId, AssetId, u64> for Database

type Error = Error

Error implementation of the merkle storage functions

fn insert(
    &mut self,
    parent: &ContractId,
    key: &AssetId,
    value: &Word
) -> Result<Option<Word>, Error>

Append P->K->V mapping to the storage.

fn remove(
    &mut self,
    parent: &ContractId,
    key: &AssetId
) -> Result<Option<Word>, Error>

Remove P->K->V mapping from the storage.

fn get(
    &self,
    parent: &ContractId,
    key: &AssetId
) -> Result<Option<Cow<'_, Word>>, Error>

Retrieve Cow<V> such as P->K->V.

fn contains_key(
    &self,
    parent: &ContractId,
    key: &AssetId
) -> Result<bool, Error>

Return true if there is a P->K mapping to a value in the storage.

fn root(&mut self, parent: &ContractId) -> Result<MerkleRoot, Error>

Return the merkle root of the domain of P.

impl MerkleStorage<ContractId, Bytes32, Bytes32> for Database

type Error = Error

Error implementation of the merkle storage functions

fn insert(
    &mut self,
    parent: &ContractId,
    key: &Bytes32,
    value: &Bytes32
) -> Result<Option<Bytes32>, Error>

Append P->K->V mapping to the storage.

fn remove(
    &mut self,
    parent: &ContractId,
    key: &Bytes32
) -> Result<Option<Bytes32>, Error>

Remove P->K->V mapping from the storage.

fn get(
    &self,
    parent: &ContractId,
    key: &Bytes32
) -> Result<Option<Cow<'_, Bytes32>>, Error>

Retrieve Cow<V> such as P->K->V.

fn contains_key(
    &self,
    parent: &ContractId,
    key: &Bytes32
) -> Result<bool, Error>

Return true if there is a P->K mapping to a value in the storage.

fn root(&mut self, parent: &ContractId) -> Result<MerkleRoot, Error>

Return the merkle root of the domain of P.

impl Storage<Bytes32, FuelBlockDb> for Database

type Error = KvStoreError

Error implementation of the storage functions

fn insert(
    &mut self,
    key: &Bytes32,
    value: &FuelBlockDb
) -> Result<Option<FuelBlockDb>, KvStoreError>

Append K->V mapping to the storage.

fn remove(&mut self, key: &Bytes32) -> Result<Option<FuelBlockDb>, KvStoreError>

Remove K->V mapping from the storage.

fn get(
    &self,
    key: &Bytes32
) -> Result<Option<Cow<'_, FuelBlockDb>>, KvStoreError>

Retrieve Cow<V> such as K->V.

fn contains_key(&self, key: &Bytes32) -> Result<bool, KvStoreError>

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

impl Storage<Bytes32, Transaction> for Database

type Error = KvStoreError

Error implementation of the storage functions

fn insert(
    &mut self,
    key: &Bytes32,
    value: &Transaction
) -> Result<Option<Transaction>, KvStoreError>

Append K->V mapping to the storage.

fn remove(&mut self, key: &Bytes32) -> Result<Option<Transaction>, KvStoreError>

Remove K->V mapping from the storage.

fn get(
    &self,
    key: &Bytes32
) -> Result<Option<Cow<'_, Transaction>>, KvStoreError>

Retrieve Cow<V> such as K->V.

fn contains_key(&self, key: &Bytes32) -> Result<bool, KvStoreError>

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

impl Storage<Bytes32, Vec<Receipt, Global>> for Database

type Error = KvStoreError

Error implementation of the storage functions

fn insert(
    &mut self,
    key: &Bytes32,
    value: &Vec<Receipt>
) -> Result<Option<Vec<Receipt>>, KvStoreError>

Append K->V mapping to the storage.

fn remove(
    &mut self,
    key: &Bytes32
) -> Result<Option<Vec<Receipt>>, KvStoreError>

Remove K->V mapping from the storage.

fn get(
    &self,
    key: &Bytes32
) -> Result<Option<Cow<'_, Vec<Receipt>>>, KvStoreError>

Retrieve Cow<V> such as K->V.

fn contains_key(&self, key: &Bytes32) -> Result<bool, KvStoreError>

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

impl Storage<ContractId, (Salt, Bytes32)> for Database

type Error = Error

Error implementation of the storage functions

fn insert(
    &mut self,
    key: &ContractId,
    value: &(Salt, Bytes32)
) -> Result<Option<(Salt, Bytes32)>, Error>

Append K->V mapping to the storage.

fn remove(&mut self, key: &ContractId) -> Result<Option<(Salt, Bytes32)>, Error>

Remove K->V mapping from the storage.

fn get(
    &self,
    key: &ContractId
) -> Result<Option<Cow<'_, (Salt, Bytes32)>>, Error>

Retrieve Cow<V> such as K->V.

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

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

impl Storage<ContractId, Contract> for Database

type Error = Error

Error implementation of the storage functions

fn insert(
    &mut self,
    key: &ContractId,
    value: &Contract
) -> Result<Option<Contract>, Error>

Append K->V mapping to the storage.

fn remove(&mut self, key: &ContractId) -> Result<Option<Contract>, Error>

Remove K->V mapping from the storage.

fn get(&self, key: &ContractId) -> Result<Option<Cow<'_, Contract>>, Error>

Retrieve Cow<V> such as K->V.

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

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

impl Storage<ContractId, UtxoId> for Database

type Error = Error

Error implementation of the storage functions

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

Append K->V mapping to the storage.

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

Remove K->V mapping from the storage.

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

Retrieve Cow<V> such as K->V.

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

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

impl Storage<UtxoId, Coin> for Database

type Error = KvStoreError

Error implementation of the storage functions

fn insert(
    &mut self,
    key: &UtxoId,
    value: &Coin
) -> Result<Option<Coin>, KvStoreError>

Append K->V mapping to the storage.

fn remove(&mut self, key: &UtxoId) -> Result<Option<Coin>, KvStoreError>

Remove K->V mapping from the storage.

fn get(&self, key: &UtxoId) -> Result<Option<Cow<'_, Coin>>, KvStoreError>

Retrieve Cow<V> such as K->V.

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

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

impl TxPoolDb for Database

fn utxo(&self, utxo_id: &UtxoId) -> Result<Option<Coin>, KvStoreError>

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

impl Send for Database

impl Sync for Database