feat: HyperlaneDb trait (#4609)
### Description Defines a `HyperlaneDb` trait for use in the validator submitter, so a mock can be passed in to simulate indexed data from reorged state. Although the `HyperlaneDb` trait can't be `Clone` to be object safe, as long as we use `Arc`s everywhere, all will be ok. Eventually the aim is to replace all direct usage of `HyperlaneRocksDb` with `Arc<dyn HyperlaneDb>`.pull/4619/head
Daniel Savu
2 months ago
committed by
GitHub
parent
4f92871c2b
commit
e2b5a4c785
@ -0,0 +1,34 @@ |
||||
use std::{io, path::PathBuf}; |
||||
|
||||
use hyperlane_core::{ChainCommunicationError, HyperlaneProtocolError}; |
||||
|
||||
/// DB Error type
|
||||
#[derive(thiserror::Error, Debug)] |
||||
pub enum DbError { |
||||
/// Rocks DB Error
|
||||
#[error("{0}")] |
||||
RockError(#[from] rocksdb::Error), |
||||
#[error("Failed to open {path}, canonicalized as {canonicalized}: {source}")] |
||||
/// Error opening the database
|
||||
OpeningError { |
||||
/// Rocksdb error during opening
|
||||
#[source] |
||||
source: rocksdb::Error, |
||||
/// Raw database path provided
|
||||
path: PathBuf, |
||||
/// Parsed path used
|
||||
canonicalized: PathBuf, |
||||
}, |
||||
/// Could not parse the provided database path string
|
||||
#[error("Invalid database path supplied {1:?}; {0}")] |
||||
InvalidDbPath(#[source] io::Error, String), |
||||
/// Hyperlane Error
|
||||
#[error("{0}")] |
||||
HyperlaneError(#[from] HyperlaneProtocolError), |
||||
} |
||||
|
||||
impl From<DbError> for ChainCommunicationError { |
||||
fn from(value: DbError) -> Self { |
||||
ChainCommunicationError::from_other(value) |
||||
} |
||||
} |
||||
@ -1,2 +1,162 @@ |
||||
pub use error::*; |
||||
use hyperlane_core::{ |
||||
GasPaymentKey, HyperlaneDomain, HyperlaneMessage, InterchainGasPayment, |
||||
InterchainGasPaymentMeta, MerkleTreeInsertion, PendingOperationStatus, H256, |
||||
}; |
||||
pub use rocks::*; |
||||
|
||||
pub use self::storage_types::{InterchainGasExpenditureData, InterchainGasPaymentData}; |
||||
|
||||
mod error; |
||||
mod rocks; |
||||
pub(crate) mod storage_types; |
||||
|
||||
#[allow(missing_docs)] |
||||
/// Hyperlane database interface
|
||||
pub trait HyperlaneDb: Send + Sync { |
||||
/// Retrieve the nonce of the highest processed message we're aware of
|
||||
fn retrieve_highest_seen_message_nonce(&self) -> DbResult<Option<u32>>; |
||||
|
||||
/// Retrieve a message by its nonce
|
||||
fn retrieve_message_by_nonce(&self, nonce: u32) -> DbResult<Option<HyperlaneMessage>>; |
||||
|
||||
/// Retrieve whether a message has been processed
|
||||
fn retrieve_processed_by_nonce(&self, nonce: &u32) -> DbResult<Option<bool>>; |
||||
|
||||
/// Get the origin domain of the database
|
||||
fn domain(&self) -> &HyperlaneDomain; |
||||
|
||||
fn store_message_id_by_nonce(&self, nonce: &u32, id: &H256) -> DbResult<()>; |
||||
|
||||
fn retrieve_message_id_by_nonce(&self, nonce: &u32) -> DbResult<Option<H256>>; |
||||
|
||||
fn store_message_by_id(&self, id: &H256, message: &HyperlaneMessage) -> DbResult<()>; |
||||
|
||||
fn retrieve_message_by_id(&self, id: &H256) -> DbResult<Option<HyperlaneMessage>>; |
||||
|
||||
fn store_dispatched_block_number_by_nonce( |
||||
&self, |
||||
nonce: &u32, |
||||
block_number: &u64, |
||||
) -> DbResult<()>; |
||||
|
||||
fn retrieve_dispatched_block_number_by_nonce(&self, nonce: &u32) -> DbResult<Option<u64>>; |
||||
|
||||
/// Store whether a message was processed by its nonce
|
||||
fn store_processed_by_nonce(&self, nonce: &u32, processed: &bool) -> DbResult<()>; |
||||
|
||||
fn store_processed_by_gas_payment_meta( |
||||
&self, |
||||
meta: &InterchainGasPaymentMeta, |
||||
processed: &bool, |
||||
) -> DbResult<()>; |
||||
|
||||
fn retrieve_processed_by_gas_payment_meta( |
||||
&self, |
||||
meta: &InterchainGasPaymentMeta, |
||||
) -> DbResult<Option<bool>>; |
||||
|
||||
fn store_interchain_gas_expenditure_data_by_message_id( |
||||
&self, |
||||
message_id: &H256, |
||||
data: &InterchainGasExpenditureData, |
||||
) -> DbResult<()>; |
||||
|
||||
fn retrieve_interchain_gas_expenditure_data_by_message_id( |
||||
&self, |
||||
message_id: &H256, |
||||
) -> DbResult<Option<InterchainGasExpenditureData>>; |
||||
|
||||
/// Store the status of an operation by its message id
|
||||
fn store_status_by_message_id( |
||||
&self, |
||||
message_id: &H256, |
||||
status: &PendingOperationStatus, |
||||
) -> DbResult<()>; |
||||
|
||||
/// Retrieve the status of an operation by its message id
|
||||
fn retrieve_status_by_message_id( |
||||
&self, |
||||
message_id: &H256, |
||||
) -> DbResult<Option<PendingOperationStatus>>; |
||||
|
||||
fn store_interchain_gas_payment_data_by_gas_payment_key( |
||||
&self, |
||||
key: &GasPaymentKey, |
||||
data: &InterchainGasPaymentData, |
||||
) -> DbResult<()>; |
||||
|
||||
fn retrieve_interchain_gas_payment_data_by_gas_payment_key( |
||||
&self, |
||||
key: &GasPaymentKey, |
||||
) -> DbResult<Option<InterchainGasPaymentData>>; |
||||
|
||||
fn store_gas_payment_by_sequence( |
||||
&self, |
||||
sequence: &u32, |
||||
payment: &InterchainGasPayment, |
||||
) -> DbResult<()>; |
||||
|
||||
fn retrieve_gas_payment_by_sequence( |
||||
&self, |
||||
sequence: &u32, |
||||
) -> DbResult<Option<InterchainGasPayment>>; |
||||
|
||||
fn store_gas_payment_block_by_sequence( |
||||
&self, |
||||
sequence: &u32, |
||||
block_number: &u64, |
||||
) -> DbResult<()>; |
||||
|
||||
fn retrieve_gas_payment_block_by_sequence(&self, sequence: &u32) -> DbResult<Option<u64>>; |
||||
|
||||
/// Store the retry count for a pending message by its message id
|
||||
fn store_pending_message_retry_count_by_message_id( |
||||
&self, |
||||
message_id: &H256, |
||||
count: &u32, |
||||
) -> DbResult<()>; |
||||
|
||||
/// Retrieve the retry count for a pending message by its message id
|
||||
fn retrieve_pending_message_retry_count_by_message_id( |
||||
&self, |
||||
message_id: &H256, |
||||
) -> DbResult<Option<u32>>; |
||||
|
||||
fn store_merkle_tree_insertion_by_leaf_index( |
||||
&self, |
||||
leaf_index: &u32, |
||||
insertion: &MerkleTreeInsertion, |
||||
) -> DbResult<()>; |
||||
|
||||
/// Retrieve the merkle tree insertion event by its leaf index
|
||||
fn retrieve_merkle_tree_insertion_by_leaf_index( |
||||
&self, |
||||
leaf_index: &u32, |
||||
) -> DbResult<Option<MerkleTreeInsertion>>; |
||||
|
||||
fn store_merkle_leaf_index_by_message_id( |
||||
&self, |
||||
message_id: &H256, |
||||
leaf_index: &u32, |
||||
) -> DbResult<()>; |
||||
|
||||
/// Retrieve the merkle leaf index of a message in the merkle tree
|
||||
fn retrieve_merkle_leaf_index_by_message_id(&self, message_id: &H256) -> DbResult<Option<u32>>; |
||||
|
||||
fn store_merkle_tree_insertion_block_number_by_leaf_index( |
||||
&self, |
||||
leaf_index: &u32, |
||||
block_number: &u64, |
||||
) -> DbResult<()>; |
||||
|
||||
fn retrieve_merkle_tree_insertion_block_number_by_leaf_index( |
||||
&self, |
||||
leaf_index: &u32, |
||||
) -> DbResult<Option<u64>>; |
||||
|
||||
fn store_highest_seen_message_nonce_number(&self, nonce: &u32) -> DbResult<()>; |
||||
|
||||
/// Retrieve the nonce of the highest processed message we're aware of
|
||||
fn retrieve_highest_seen_message_nonce_number(&self) -> DbResult<Option<u32>>; |
||||
} |
||||
|
||||
Loading…
Reference in new issue