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_current_block(&self) -> Result<Option<Cow<'_, FuelBlockDb>>, Error>

Get the current block at the head of the chain.

pub fn block_time(&self, height: u32) -> Result<Tai64, 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>> + '_

pub fn genesis_block_ids(&self) -> Result<(BlockHeight, Bytes32), Error>

impl Database

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

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

impl Database

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

pub fn get_contract_config(&self) -> Result<Option<Vec<ContractConfig>>, Error>

impl Database

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

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

pub fn get_message_config(&self) -> Result<Option<Vec<MessageConfig>>, Error>

impl Database

pub fn get_sealed_block(
    &self,
    block_id: &Bytes32
) -> Result<Option<SealedFuelBlock>, KvStoreError>

pub fn get_genesis(&self) -> Result<Genesis, KvStoreError>

pub fn get_sealed_block_header(
    &self,
    block_id: &Bytes32
) -> Result<Option<SealedFuelBlockHeader>, KvStoreError>

impl Database

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

pub fn get_chain_name(&self) -> Result<Option<String>, 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,
    id: &Bytes32,
    status: TransactionStatus
) -> Result<Option<TransactionStatus>, Error>

pub fn get_tx_status(
    &self,
    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 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 BlockDb for Database

fn block_height(&self) -> Result<BlockHeight>

fn seal_block(
    &mut self,
    block_id: BlockId,
    consensus: FuelBlockConsensus
) -> Result<()>

impl BlockProducer<Database> for PoACoordinatorAdapter

fn produce_and_execute_block<'life0, 'async_trait>(
    &'life0 self,
    height: BlockHeight,
    max_gas: Word
) -> Pin<Box<dyn Future<Output = Result<UncommittedResult<DBTransaction<Database>>>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

fn dry_run<'life0, 'async_trait>(
    &'life0 self,
    transaction: Transaction,
    height: Option<BlockHeight>,
    utxo_validation: Option<bool>
) -> Pin<Box<dyn Future<Output = Result<Vec<Receipt>>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

impl BlockProducerDatabase for Database

fn get_block(
    &self,
    fuel_height: BlockHeight
) -> Result<Option<Cow<'_, FuelBlockDb>>>

Fetch previously committed block at given height.

fn current_block_height(&self) -> Result<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) -> Result<Option<Vec<CoinConfig>>>

Returns all unspent coin configs available in the database.

fn get_contract_config(&self) -> Result<Option<Vec<ContractConfig>>, Error>

Returns alive contract configs available in the database.

fn get_message_config(&self) -> Result<Option<Vec<MessageConfig>>, Error>

Returns all unspent message configs available in the database.

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

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 DatabaseTransaction<Database> for DatabaseTransaction

fn database(&self) -> &Database

Returns the reference to the Database instance.

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

Returns the mutable reference to the Database instance.

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 Executor<Database> for Executor

fn execute_without_commit(
    &self,
    block: ExecutionBlock
) -> Result<UncommittedResult<DBTransaction<Database>>, Error>

Executes the block and returns the result of execution with uncommitted database transaction.

fn dry_run(
    &self,
    block: ExecutionBlock,
    utxo_validation: Option<bool>
) -> Result<Vec<Vec<Receipt>>, Error>

Executes the block without committing it to the database. During execution collects the receipts to return them. The utxo_validation field can be used to disable the validation of utxos during execution.

impl Executor<Database> for ExecutorAdapter

fn execute_without_commit(
    &self,
    block: ExecutionBlock
) -> Result<UncommittedResult<DBTransaction<Database>>, Error>

Executes the block and returns the result of execution with uncommitted database transaction.

fn dry_run(
    &self,
    block: ExecutionBlock,
    utxo_validation: Option<bool>
) -> Result<Vec<Vec<Receipt>>, Error>

Executes the block without committing it to the database. During execution collects the receipts to return them. The utxo_validation field can be used to disable the validation of utxos during execution.

impl From<&Database> for DatabaseTransaction

fn from(source: &Database) -> Self

Converts to this type from the input type.

impl MerkleRootStorage<ContractId, ContractsAssets<'_>> for Database

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

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

impl MerkleRootStorage<ContractId, ContractsState<'_>> for Database

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

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

impl P2pDb for Database

fn get_sealed_block<'life0, 'async_trait>(
    &'life0 self,
    height: BlockHeight
) -> Pin<Box<dyn Future<Output = Option<Arc<SealedFuelBlock>>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

impl RelayerDb for Database

fn get_chain_height<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = BlockHeight> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

current best block number

fn get_sealed_block<'life0, 'async_trait>(
    &'life0 self,
    height: BlockHeight
) -> Pin<Box<dyn Future<Output = Option<Arc<SealedFuelBlock>>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

fn set_finalized_da_height<'life0, 'async_trait>(
    &'life0 self,
    block: DaBlockHeight
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

set finalized da height that represent last block from da layer that got finalized.

fn get_finalized_da_height<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Option<DaBlockHeight>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Assume it is always set as initialization of database.

fn get_last_published_fuel_height<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Option<BlockHeight>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Get the last fuel block height that was published to the da layer.

fn set_last_published_fuel_height<'life0, 'async_trait>(
    &'life0 self,
    block_height: BlockHeight
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Set the last fuel block height that was published to the da layer.

fn insert_message<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    message: &'life1 CheckedMessage
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Add bridge message to database. Messages are not revertible.

impl StorageInspect<Coins> for Database

type Error = KvStoreError

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

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

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

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: &(&ContractId, &AssetId)
) -> Result<Option<Cow<'_, Word>>, Error>

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

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

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

impl StorageInspect<ContractsInfo> for Database

type Error = Error

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

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

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

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

impl StorageInspect<ContractsLatestUtxo> for Database

type Error = Error

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

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

fn contains_key(&self, key: &ContractId) -> 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: &ContractId) -> Result<Option<Cow<'_, Contract>>, Error>

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

fn contains_key(&self, key: &ContractId) -> Result<bool, 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: &(&ContractId, &Bytes32)
) -> Result<Option<Cow<'_, Bytes32>>, Error>

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

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

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

impl StorageInspect<FuelBlocks> for Database

type Error = KvStoreError

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

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

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

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

impl StorageInspect<Messages> for Database

type Error = KvStoreError

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

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

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

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

impl StorageInspect<Receipts> for Database

type Error = KvStoreError

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

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

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

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

impl StorageInspect<SealedBlockConsensus> for Database

type Error = KvStoreError

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

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

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

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

impl StorageInspect<Transactions> for Database

type Error = KvStoreError

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

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

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

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: &Coin
) -> Result<Option<Coin>, KvStoreError>

Append Key->Value mapping to the storage.

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

Remove Key->Value mapping from the storage.

impl StorageMutate<ContractsAssets<'_>> for Database

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

Append Key->Value mapping to the storage.

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

Remove Key->Value mapping from the storage.

impl StorageMutate<ContractsInfo> for Database

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

Append Key->Value mapping to the storage.

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

Remove Key->Value mapping from the storage.

impl StorageMutate<ContractsLatestUtxo> for Database

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

Append Key->Value mapping to the storage.

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

Remove Key->Value mapping from the storage.

impl StorageMutate<ContractsRawCode> for Database

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

Append Key->Value mapping to the storage.

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

Remove Key->Value mapping from the storage.

impl StorageMutate<ContractsState<'_>> for Database

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

Append Key->Value mapping to the storage.

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

Remove Key->Value mapping from the storage.

impl StorageMutate<FuelBlocks> for Database

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

Append Key->Value mapping to the storage.

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

Remove Key->Value mapping from the storage.

impl StorageMutate<Messages> for Database

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

Append Key->Value mapping to the storage.

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

Remove Key->Value mapping from the storage.

impl StorageMutate<Receipts> for Database

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

Append Key->Value mapping to the storage.

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

Remove Key->Value mapping from the storage.

impl StorageMutate<SealedBlockConsensus> for Database

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

Append Key->Value mapping to the storage.

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

Remove Key->Value mapping from the storage.

impl StorageMutate<Transactions> for Database

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

Append Key->Value mapping to the storage.

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

Remove Key->Value mapping from the storage.

impl TxPoolDb for Database

fn current_block_height(&self) -> Result<BlockHeight, KvStoreError>

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

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

fn message(
    &self,
    message_id: &MessageId
) -> Result<Option<Message>, KvStoreError>

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