signet_extract/
lib.rs

1//! Contains logic for extracting events and other data from host chain blocks.
2//!
3//! ## Usage
4//!
5//! Create a [`Extractor`] from a set of [`SignetSystemConstants`], then invoke
6//! [`Extractor::extract_signet`] to extract all relevant Signet events from a
7//! chain.
8//!
9//! These events will be returned as a series of [`Extracts`] objects, each of
10//! which containing the relevant [`ExtractedEvent`]s and a [`AggregateFills`]
11//! for a specific host block.
12//!
13//! [`SignetSystemConstants`]: signet_types::config::SignetSystemConstants
14//! [`AggregateFills`]: signet_types::AggregateFills
15
16#![warn(
17    missing_copy_implementations,
18    missing_debug_implementations,
19    missing_docs,
20    unreachable_pub,
21    clippy::missing_const_for_fn,
22    rustdoc::all
23)]
24#![cfg_attr(not(test), warn(unused_crate_dependencies))]
25#![deny(unused_must_use, rust_2018_idioms)]
26#![cfg_attr(docsrs, feature(doc_cfg))]
27
28mod block;
29pub use block::Extracts;
30
31mod events;
32pub use events::Events;
33
34mod extracted;
35pub use extracted::ExtractedEvent;
36
37mod extractor;
38pub use extractor::Extractor;
39
40mod r#trait;
41pub use r#trait::{Extractable, HasTxns};
42
43mod step;
44pub use step::ExtractStep;