Struct MinBurnAmountConfigNote 

pub struct MinBurnAmountConfigNote { /* private fields */ }

A MinBurnAmountConfig note: updates the minimum burn amount of a faucet’s MinBurnAmount burn policy by calling its set_min_burn_amount procedure on the faucet that consumes it.

The new threshold is carried in the note’s storage as [min_burn_amount] (see the Note conversion below). Because the storage is fixed at note creation and bound into the note commitment, the authorized party is the note sender: the consuming faucet’s set_min_burn_amount procedure authorizes the sender through the account-wide Authority component.

The note is always public (for network execution) and tagged for target - the faucet carrying the MinBurnAmount component whose threshold is being updated. The sender is the account authorized for the update per the faucet’s Authority configuration (the owner under OwnerControlled, or a role member under RbacControlled).

The note is bound to the target account by a NetworkAccountTarget attachment: the script asserts that the consuming account matches that target before calling set_min_burn_amount, so the note cannot be consumed by a third-party account that merely accepts its sender.

Note that the threshold only takes effect while MinBurnAmount is the faucet’s active burn policy; it is stored on the component either way, so it can be configured before the policy is switched in.

Construct one with the builder; convert it into a protocol Note infallibly via Note::from.

Implementations

impl MinBurnAmountConfigNote

pub fn builder() -> MinBurnAmountConfigNoteBuilder

Builds a new MinBurnAmountConfigNote setting min_burn_amount on target.

Errors

Returns an error if:

• target is not a public account (the note is bound to it via a NetworkAccountTarget, which requires a public target).
• the attachments carry a NetworkAccountTarget for an account other than target.
• the attachments exceed their protocol limit (see NoteAttachments::new); the target attachment occupies one of the available slots when the caller does not supply it.

impl MinBurnAmountConfigNote

pub const NUM_STORAGE_ITEMS: usize = 1

Number of storage items of a MinBurnAmountConfig note: the new minimum burn amount.

Must be kept in sync with NUM_STORAGE_ITEMS in the note script, which asserts the count.

pub fn script() -> NoteScript

Returns the script of the MinBurnAmountConfig note.

pub fn script_root() -> NoteScriptRoot

Returns the MinBurnAmountConfig note script root.

pub fn sender(&self) -> AccountId

Returns the account ID of the note’s sender (the account authorized for the update).

pub fn target(&self) -> AccountId

Returns the account ID of the managed faucet: the account the note is tagged for and bound to via its NetworkAccountTarget attachment (only this account can consume the note).

pub fn min_burn_amount(&self) -> AssetAmount

Returns the minimum burn amount the note sets on the faucet.

pub fn serial_number(&self) -> Word

Returns the note’s serial number.

pub fn attachments(&self) -> &NoteAttachments

Returns the attachments carried by the note.

Trait Implementations

impl Clone for MinBurnAmountConfigNote

fn clone(&self) -> MinBurnAmountConfigNote

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MinBurnAmountConfigNote

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<MinBurnAmountConfigNote> for Note

fn from(note: MinBurnAmountConfigNote) -> Note

Converts to this type from the input type.

impl NoteConsumptionCost for MinBurnAmountConfigNote

fn consumption_cycles() -> u32

Cycles of the canonical network-account transaction consuming this note (maximum across the benchmarked execution paths - an estimate, not a worst case).

fn created_notes() -> Vec<NoteScriptRoot>

Script roots of all the notes this note’s consumption is expected to create.