1//! State contextual verification and storage code for Zebra.
2//!
3//! # Correctness
4//!
5//! Await UTXO and block commit requests should be wrapped in a timeout, because:
6//! - await UTXO requests wait for a block containing that UTXO, and
7//! - contextual verification and state updates wait for all previous blocks.
8//!
9//! Otherwise, verification of out-of-order and invalid blocks can hang indefinitely.
1011#![doc(html_favicon_url = "https://zfnd.org/wp-content/uploads/2022/03/zebra-favicon-128.png")]
12#![doc(html_logo_url = "https://zfnd.org/wp-content/uploads/2022/03/zebra-icon.png")]
13#![doc(html_root_url = "https://docs.rs/zebra_state")]
1415#[macro_use]
16extern crate tracing;
1718// TODO: only export the Config struct and a few other important methods
19pub mod config;
20// Most constants are exported by default
21pub mod constants;
2223// Allow use in external tests
24#[cfg(any(test, feature = "proptest-impl"))]
25pub mod arbitrary;
2627mod error;
28mod request;
29mod response;
30mod service;
3132#[cfg(test)]
33mod tests;
3435pub use config::{
36 check_and_delete_old_databases, check_and_delete_old_state_databases,
37 database_format_version_on_disk, state_database_format_version_on_disk, Config,
38};
39pub use constants::{state_database_format_version_in_code, MAX_BLOCK_REORG_HEIGHT};
40pub use error::{
41 BoxError, CloneError, CommitSemanticallyVerifiedError, DuplicateNullifierError,
42 ValidateContextError,
43};
44pub use request::{
45 CheckpointVerifiedBlock, HashOrHeight, ReadRequest, Request, SemanticallyVerifiedBlock,
46};
4748#[cfg(feature = "indexer")]
49pub use request::Spend;
5051pub use response::{GetBlockTemplateChainInfo, KnownBlock, MinedTx, ReadResponse, Response};
52pub use service::{
53 chain_tip::{ChainTipBlock, ChainTipChange, ChainTipSender, LatestChainTip, TipAction},
54 check,
55 finalized_state::FinalizedState,
56 init, init_read_only,
57 non_finalized_state::NonFinalizedState,
58 spawn_init, spawn_init_read_only,
59 watch_receiver::WatchReceiver,
60 OutputLocation, TransactionIndex, TransactionLocation,
61};
6263// Allow use in the scanner and external tests
64#[cfg(any(test, feature = "proptest-impl"))]
65pub use service::finalized_state::{ReadDisk, TypedColumnFamily, WriteTypedBatch};
6667pub use service::{
68 finalized_state::{DiskWriteBatch, FromDisk, IntoDisk, WriteDisk, ZebraDb},
69 ReadStateService,
70};
7172// Allow use in external tests
73#[cfg(any(test, feature = "proptest-impl"))]
74pub use service::{
75 arbitrary::{populated_state, CHAIN_TIP_UPDATE_WAIT_LIMIT},
76 finalized_state::{RawBytes, KV, MAX_ON_DISK_HEIGHT},
77 init_test, init_test_services,
78};
7980#[cfg(any(test, feature = "proptest-impl"))]
81pub use config::hidden::{
82 write_database_format_version_to_disk, write_state_database_format_version_to_disk,
83};
8485// Allow use only inside the crate in production
86#[cfg(not(any(test, feature = "proptest-impl")))]
87#[allow(unused_imports)]
88pub(crate) use config::hidden::{
89 write_database_format_version_to_disk, write_state_database_format_version_to_disk,
90};
9192pub use request::ContextuallyVerifiedBlock;