1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
// Copyright 2023-, Semiotic AI, Inc.
// SPDX-License-Identifier: Apache-2.0
//! Point of entry for managing TAP receipts and RAVs.
//!
//! The [`crate::manager`] module provides facilities for managing TAP receipt
//! and RAV validation, as well as storage flow.
//!
//! This module should be the primary interface for the receiver of funds to
//! verify, store, and manage TAP receipts and RAVs.
//! The [`Manager`] struct within this module allows the user to specify what
//! checks should be performed on receipts, as well as
//! when these checks should occur (either when a receipt is first received,
//! or when it is being added to a RAV request).
//!
//! The [`Manager`] uses a context that implements user-defined [`adapters`]
//! for storage handling.
//! This design offers a high degree of flexibility, letting the user define
//! their own behavior for these critical operations.
//!
//! This solution is flexible enough to enable certain methods depending on the
//! context provided. This is important because the context can be customized
//! to include only the necessary adapters for the user's specific use case.
//! For example, if the user wants to use two different applications, one to
//! handle receipt storage and another to handle RAV storage, they
//! can create two different contexts with the appropriate adapters.
//!
//! # Adapters
//! There are 6 main adapters that can be implemented to customize the behavior
//! of the [`Manager`].
//! You can find more information about these adapters in the [`adapters`] module.
//!
//! # Example
//!
//! ```rust
//! use async_trait::async_trait;
//! use tap_core::{
//! receipt::{
//! ReceiptWithState,
//! state::Checking,
//! checks::CheckList,
//! ReceiptError,
//! Context
//! },
//! manager::{
//! Manager,
//! adapters::ReceiptStore
//! },
//! };
//!
//! struct MyContext;
//!
//! #[async_trait]
//! impl<T: Send + 'static> ReceiptStore<T> for MyContext {
//! type AdapterError = ReceiptError;
//!
//! async fn store_receipt(&self, receipt: ReceiptWithState<Checking, T>) -> Result<u64, Self::AdapterError> {
//! // ...
//! # Ok(0)
//! }
//! }
//! # #[tokio::main(flavor = "current_thread")]
//! # async fn main() {
//! # use thegraph_core::alloy::{dyn_abi::Eip712Domain, primitives::Address, signers::local::PrivateKeySigner};
//! # use tap_graph::{Receipt, SignedReceipt};
//! # use tap_core::signed_message::Eip712SignedMessage;
//! # let domain_separator = Eip712Domain::default();
//! # let wallet = PrivateKeySigner::random();
//! # let message = Receipt::new(Address::from([0x11u8; 20]), 100).unwrap();
//!
//! let receipt = Eip712SignedMessage::new(&domain_separator, message, &wallet).unwrap();
//!
//! let manager = Manager::new(domain_separator, MyContext, CheckList::empty());
//! manager.verify_and_store_receipt(&Context::new(), receipt).await.unwrap()
//! # }
//! ```
//!
pub use Manager;