Struct NoteConsumptionChecker 

pub struct NoteConsumptionChecker<'a, STORE, AUTH>(/* private fields */);

This struct performs input notes check against provided target account.

The check is performed using the NoteConsumptionChecker::check_notes_consumability procedure. Essentially runs the transaction to make sure that provided input notes could be consumed by the account.

Implementations

impl<'a, STORE, AUTH> NoteConsumptionChecker<'a, STORE, AUTH>

where STORE: DataStore + Sync, AUTH: TransactionAuthenticator + Sync,

pub fn new(tx_executor: &'a TransactionExecutor<'a, 'a, STORE, AUTH>) -> Self

Creates a new NoteConsumptionChecker instance with the given transaction executor.

pub async fn check_notes_consumability( &self, target_account_id: AccountId, block_ref: BlockNumber, input_notes: InputNotes<InputNote>, tx_args: TransactionArgs, ) -> Result<NoteConsumptionInfo, NoteCheckerError>

Checks whether some set of the provided input notes could be consumed by the provided account by executing the transaction with varying combination of notes.

This function attempts to find the maximum set of notes that can be successfully executed together by the target account.

If some notes succeed but others fail, the failed notes are removed from the candidate set and the remaining notes (successful + unattempted) are retried in the next iteration. This process continues until either all remaining notes succeed or no notes can be successfully executed

Example Execution Flow

Given notes A, B, C, D, E:

• Try [A, B, C, D, E] → A, B succeed, C fails → Remove C, try again.
• Try [A, B, D, E] → A, B, D succeed, E fails → Remove E, try again.
• Try [A, B, D] → All succeed → Return successful=[A, B, D], failed=[C, E].

Returns

Returns NoteConsumptionInfo containing:

• successful: Notes that can be consumed together by the account.
• failed: Notes that failed during execution attempts.