Crate essential_node_db

The node’s DB interface and sqlite implementation.

The core capability of the node is to:

1. Receive blocks from an L1 relayer and derive state from their solutions.
2. Receive contracts from the p2p network so that they’re available for validation.

As a part of satisfying these requirements, this crate provides the basic functions required for safely creating the necessary tables and inserting/ querying/updating them as necessary.

Modules

• finalized
  Finalized queries query for the most recent version of a key less than or equal to a given block number or solution index for blocks that have been finalized.
• sql
  Provides the SQL statements used by essential-node-db via const strs.

Structs

• DecodeError
  Any error that might occur during decoding of a type returned by the DB.

Enums

• QueryError
  A database or decoding error returned by a query.

Traits

• AcquireConnection
  Types that may be provided to subscribe_blocks to provide access to Connections while streaming.
• AwaitNewBlock
  Types that may be provided to subscribe_blocks to asynchronously await the availability of a new block.

Functions

• create_tables
  Create all tables.
• decode
  Decodes the given blob into a value of type T.
• delete_state
  Deletes the state for a given contract content address and key.
• encode
  Encodes the given value into a blob.
• finalize_block
  Finalizes the block with the given hash. This sets the block to be the only block at a particular block number.
• get_block_number
  Fetches the block number for a given block.
• get_contract
  Fetches a contract by its content address.
• get_contract_predicates
  Fetches the predicates of the contract with the given content address.
• get_contract_progress
  Fetches the contract progress.
• get_contract_salt
  Fetches the salt of the contract with the given content address.
• get_latest_finalized_block_address
  Fetches the latest finalized block hash.
• get_predicate
  Fetches a predicate by its predicate content address.
• get_solution
  Fetches a solution by its content address.
• get_state_progress
  Fetches the last progress on state derivation.
• get_validation_progress
  Fetches the last progress on validation.
• insert_block
  For the given block:
• insert_contract
  For the given contract:
• insert_contract_progress
  Inserts the new progress for syncing contracts.
• insert_failed_block
  Inserts a failed block.
• list_blocks
  Lists all blocks in the given range.
• list_blocks_by_time
  Lists blocks and their solutions within a specific time range with pagination.
• list_contracts
  Lists contracts and their predicates within a given DA block range.
• list_failed_blocks
  List failed blocks as (block number, solution hash) within a given range.
• list_unchecked_blocks
  Lists all unchecked blocks in the given range.
• query_state
  Fetches the state value for the given contract content address and key pair.
• subscribe_blocks
  Subscribe to all blocks from the given starting block number.
• update_state
  Updates the state for a given contract content address and key.
• update_state_progress
  Updates the progress on state derivation.
• update_validation_progress
  Updates the progress on validation.