tap_core 6.0.2

Core Timeline Aggregation Protocol library: a fast, efficient and trustless unidirectional micro-payments system.
Documentation 
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

// Copyright 2023-, Semiotic AI, Inc.
// SPDX-License-Identifier: Apache-2.0

use async_trait::async_trait;
use thegraph_core::alloy::sol_types::SolStruct;

use crate::signed_message::Eip712SignedMessage;

/// Stores the latest RAV in the storage.
///
/// # Example
///
/// For example code see [crate::manager::context::memory::RAVStorage]

#[async_trait]
pub trait RavStore<T: SolStruct> {
    /// Defines the user-specified error type.
    ///
    /// This error type should implement the `Error` and `Debug` traits from
    /// the standard library.
    /// Errors of this type are returned to the user when an operation fails.
    type AdapterError: std::error::Error + std::fmt::Debug + Send + Sync + 'static;

    /// Updates the storage with the latest validated `SignedRAV`.
    ///
    /// This method should be implemented to store the most recent validated
    /// `SignedRAV` into your chosen storage system. Any errors that occur
    /// during this process should be captured and returned as an `AdapterError`.
    async fn update_last_rav(&self, rav: Eip712SignedMessage<T>) -> Result<(), Self::AdapterError>;
}

/// Reads the RAV from storage
///
/// # Example
///
/// For example code see [crate::manager::context::memory::RAVStorage]

#[async_trait]
pub trait RavRead<T: SolStruct> {
    /// Defines the user-specified error type.
    ///
    /// This error type should implement the `Error` and `Debug` traits from
    /// the standard library.
    /// Errors of this type are returned to the user when an operation fails.
    type AdapterError: std::error::Error + std::fmt::Debug + Send + Sync + 'static;

    /// Retrieves the latest `SignedRAV` from the storage.
    ///
    /// If no `SignedRAV` is available, this method should return `None`.
    async fn last_rav(&self) -> Result<Option<Eip712SignedMessage<T>>, Self::AdapterError>;
}