zebra_state/
lib.rs

Help
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.
10
11#![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")]
14
15#[macro_use]
16extern crate tracing;
17
18// 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;
22
23// Allow use in external tests
24#[cfg(any(test, feature = "proptest-impl"))]
25pub mod arbitrary;
26
27mod error;
28mod request;
29mod response;
30mod service;
31
32#[cfg(test)]
33mod tests;
34
35pub 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};
47
48#[cfg(feature = "indexer")]
49pub use request::Spend;
50
51pub 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    OutputIndex, OutputLocation, TransactionIndex, TransactionLocation,
61};
62
63// Allow use in the scanner
64#[cfg(feature = "shielded-scan")]
65pub use service::finalized_state::{
66    SaplingScannedDatabaseEntry, SaplingScannedDatabaseIndex, SaplingScannedResult,
67    SaplingScanningKey,
68};
69
70// Allow use in the scanner and external tests
71#[cfg(any(test, feature = "proptest-impl", feature = "shielded-scan"))]
72pub use service::finalized_state::{
73    DiskWriteBatch, FromDisk, ReadDisk, TypedColumnFamily, WriteDisk, WriteTypedBatch,
74};
75
76pub use service::{
77    finalized_state::{IntoDisk, ZebraDb},
78    ReadStateService,
79};
80
81// Allow use in external tests
82#[cfg(any(test, feature = "proptest-impl"))]
83pub use service::{
84    arbitrary::{populated_state, CHAIN_TIP_UPDATE_WAIT_LIMIT},
85    finalized_state::{RawBytes, KV, MAX_ON_DISK_HEIGHT},
86    init_test, init_test_services,
87};
88
89#[cfg(any(test, feature = "proptest-impl"))]
90pub use config::hidden::{
91    write_database_format_version_to_disk, write_state_database_format_version_to_disk,
92};
93
94// Allow use only inside the crate in production
95#[cfg(not(any(test, feature = "proptest-impl")))]
96#[allow(unused_imports)]
97pub(crate) use config::hidden::{
98    write_database_format_version_to_disk, write_state_database_format_version_to_disk,
99};
100
101pub use request::ContextuallyVerifiedBlock;
zebra_state/lib.rs

zebra_state/
lib.rs
