Struct NoteScreener 

pub struct NoteScreener<AUTH> { /* private fields */ }

Provides functionality for testing whether a note is relevant to the client or not.

Here, relevance is based on whether the note is able to be consumed by an account that is tracked in the provided store. This can be derived in a number of ways, such as looking at the combination of script root and note inputs. For example, a P2ID note is relevant for a specific account ID if this ID is its first note input.

Implementations

impl<AUTH> NoteScreener<AUTH>

where AUTH: TransactionAuthenticator + Sync,

pub fn new(store: Arc<dyn Store>, authenticator: Option<Arc<AUTH>>) -> Self

pub async fn check_relevance( &self, note: &Note, ) -> Result<Vec<NoteConsumability>, NoteScreenerError>

Returns a vector of tuples describing the relevance of the provided note to the accounts monitored by this screener.

Does a fast check for known scripts (P2ID, P2IDE, SWAP). We’re currently unable to execute notes that aren’t committed so a slow check for other scripts is currently not available.

If relevance can’t be determined, the screener defaults to setting the note as consumable.

Trait Implementations

impl<AUTH> OnNoteReceived for NoteScreener<AUTH>

where AUTH: TransactionAuthenticator + Sync,

fn on_note_received<'life0, 'async_trait>( &'life0 self, committed_note: CommittedNote, public_note: Option<InputNoteRecord>, ) -> Pin<Box<dyn Future<Output = Result<NoteUpdateAction, ClientError>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Default implementation of the OnNoteReceived callback. It queries the store for the committed note to check if it’s relevant. If the note wasn’t being tracked but it came in the sync response it may be a new public note, in that case we use the NoteScreener to check its relevance.