miden-client 0.16.0

Client library that facilitates interaction with the Miden network
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

//! Side-effect-only observer trait for per-note arrivals during sync.

use alloc::boxed::Box;

use async_trait::async_trait;
use miden_protocol::note::NoteAttachments;

use crate::ClientError;
use crate::rpc::domain::note::CommittedNote;
use crate::sync::StateSyncUpdate;

/// Per-note + post-sync side-channel into [`crate::sync::StateSync`].
/// Attach via `StateSync::with_note_observer(...)`. Multiple observers
/// run independently; errors are logged, never abort sync.
#[async_trait(?Send)]
pub trait NoteObserver {
    /// Identifier surfaced on `tracing::warn!` events for this observer.
    fn name(&self) -> &'static str;

    /// Per-note hook. Runs before the screener verdict, so before the note's id is recomputed and
    /// its inclusion proof verified. `attachments` is empty for a note that carries none.
    ///
    /// Returns `true` to mark the enclosing block as relevant even if the screener discards it,
    /// so sync persists its header.
    async fn observe(
        &self,
        committed_note: &CommittedNote,
        attachments: &NoteAttachments,
    ) -> Result<bool, ClientError>;

    /// Post-sync hook, invoked once after the sync window closes.
    /// Default impl is a no-op for observers that only need `observe()`.
    async fn apply(&self, _sync_update: &StateSyncUpdate) -> Result<(), ClientError> {
        Ok(())
    }
}