Trait snarkvm_compiler::BlockStorage

source · [−]

pub trait BlockStorage<N: Network>: Clone + Sync {
    type IDMap: for<'a> Map<'a, u32, N::BlockHash>;
    type ReverseIDMap: for<'a> Map<'a, N::BlockHash, u32>;
    type HeaderMap: for<'a> Map<'a, N::BlockHash, Header<N>>;
    type TransactionsMap: for<'a> Map<'a, N::BlockHash, Vec<N::TransactionID>>;
    type ReverseTransactionsMap: for<'a> Map<'a, N::TransactionID, N::BlockHash>;
    type TransactionStorage: TransactionStorage<N, TransitionStorage = Self::TransitionStorage>;
    type TransitionStorage: TransitionStorage<N>;
    type SignatureMap: for<'a> Map<'a, N::BlockHash, Signature<N>>;

Show 22 methods
    fn open() -> Result<Self>;
    fn id_map(&self) -> &Self::IDMap;
    fn reverse_id_map(&self) -> &Self::ReverseIDMap;
    fn header_map(&self) -> &Self::HeaderMap;
    fn transactions_map(&self) -> &Self::TransactionsMap;
    fn reverse_transactions_map(&self) -> &Self::ReverseTransactionsMap;
    fn transaction_store(
        &self
    ) -> &TransactionStore<N, Self::TransactionStorage>;
    fn signature_map(&self) -> &Self::SignatureMap;

    fn start_atomic(&self) { ... }
    fn is_atomic_in_progress(&self) -> bool { ... }
    fn abort_atomic(&self) { ... }
    fn finish_atomic(&self) -> Result<()> { ... }
    fn insert(&self, block: &Block<N>) -> Result<()> { ... }
    fn remove(&self, block_hash: &N::BlockHash) -> Result<()> { ... }
    fn find_block_hash(
        &self,
        transaction_id: &N::TransactionID
    ) -> Result<Option<N::BlockHash>> { ... }
    fn get_previous_block_hash(
        &self,
        height: u32
    ) -> Result<Option<N::BlockHash>> { ... }
    fn get_block_hash(&self, height: u32) -> Result<Option<N::BlockHash>> { ... }
    fn get_block_height(&self, block_hash: &N::BlockHash) -> Result<Option<u32>> { ... }
    fn get_block_header(
        &self,
        block_hash: &N::BlockHash
    ) -> Result<Option<Header<N>>> { ... }
    fn get_block_transactions(
        &self,
        block_hash: &N::BlockHash
    ) -> Result<Option<Transactions<N>>> { ... }
    fn get_block_signature(
        &self,
        block_hash: &N::BlockHash
    ) -> Result<Option<Signature<N>>> { ... }
    fn get_block(&self, block_hash: &N::BlockHash) -> Result<Option<Block<N>>> { ... }
}

Expand description

A trait for block storage.

Required Associated Types

type IDMap: for<'a> Map<'a, u32, N::BlockHash>

The mapping of block height to block hash.

type ReverseIDMap: for<'a> Map<'a, N::BlockHash, u32>

The mapping of block hash to block height.

type HeaderMap: for<'a> Map<'a, N::BlockHash, Header<N>>

The mapping of block hash to block header.

type TransactionsMap: for<'a> Map<'a, N::BlockHash, Vec<N::TransactionID>>

The mapping of block hash to [transaction ID].

type ReverseTransactionsMap: for<'a> Map<'a, N::TransactionID, N::BlockHash>

The mapping of transaction ID to block hash.

type TransactionStorage: TransactionStorage<N, TransitionStorage = Self::TransitionStorage>

The transaction storage.

type TransitionStorage: TransitionStorage<N>

The transition storage.

type SignatureMap: for<'a> Map<'a, N::BlockHash, Signature<N>>

The mapping of block hash to block signature.

Required Methods

fn open() -> Result<Self>

Initializes the block storage.

fn id_map(&self) -> &Self::IDMap

Returns the ID map.

fn reverse_id_map(&self) -> &Self::ReverseIDMap

Returns the reverse ID map.

fn header_map(&self) -> &Self::HeaderMap

Returns the header map.

fn transactions_map(&self) -> &Self::TransactionsMap

Returns the transactions map.

fn reverse_transactions_map(&self) -> &Self::ReverseTransactionsMap

Returns the reverse transactions map.

fn transaction_store(&self) -> &TransactionStore<N, Self::TransactionStorage>

Returns the transaction store.

fn signature_map(&self) -> &Self::SignatureMap

Returns the signature map.

Provided Methods

fn start_atomic(&self)

Starts an atomic batch write operation.

fn is_atomic_in_progress(&self) -> bool

Checks if an atomic batch is in progress.

fn abort_atomic(&self)

Aborts an atomic batch write operation.

fn finish_atomic(&self) -> Result<()>

Finishes an atomic batch write operation.

fn insert(&self, block: &Block<N>) -> Result<()>

Stores the given block into storage.

fn remove(&self, block_hash: &N::BlockHash) -> Result<()>

Removes the block for the given block hash.

fn find_block_hash(
&self,
transaction_id: &N::TransactionID
) -> Result<Option<N::BlockHash>>

Returns the block hash that contains the given transaction ID.

fn get_previous_block_hash(&self, height: u32) -> Result<Option<N::BlockHash>>

Returns the previous block hash of the given block height.

fn get_block_hash(&self, height: u32) -> Result<Option<N::BlockHash>>

Returns the block hash for the given block height.

fn get_block_height(&self, block_hash: &N::BlockHash) -> Result<Option<u32>>

Returns the block height for the given block hash.

fn get_block_header(
&self,
block_hash: &N::BlockHash
) -> Result<Option<Header<N>>>

Returns the block header for the given block hash.

fn get_block_transactions(
&self,
block_hash: &N::BlockHash
) -> Result<Option<Transactions<N>>>

Returns the block transactions for the given block hash.

fn get_block_signature(
&self,
block_hash: &N::BlockHash
) -> Result<Option<Signature<N>>>

Returns the block signature for the given block hash.

fn get_block(&self, block_hash: &N::BlockHash) -> Result<Option<Block<N>>>

Returns the block for the given block hash.

Implementors

impl<N: Network> BlockStorage<N> for BlockMemory<N>

type IDMap = MemoryMap<u32, <N as Network>::BlockHash>

type ReverseIDMap = MemoryMap<<N as Network>::BlockHash, u32>

type HeaderMap = MemoryMap<<N as Network>::BlockHash, Header<N>>

type TransactionsMap = MemoryMap<<N as Network>::BlockHash, Vec<<N as Network>::TransactionID, Global>>

type ReverseTransactionsMap = MemoryMap<<N as Network>::TransactionID, <N as Network>::BlockHash>

type TransactionStorage = TransactionMemory<N>

type TransitionStorage = TransitionMemory<N>

type SignatureMap = MemoryMap<<N as Network>::BlockHash, Signature<N>>