Struct FaucetPolicyConfigNote 

pub struct FaucetPolicyConfigNote { /* private fields */ }

A FaucetPolicyConfig note: triggers a TokenPolicyManager policy switch on the faucet that consumes it.

A single note script dispatches on a selector in the note’s storage to one of the component’s setters (set_mint_policy, set_burn_policy, set_send_policy, set_receive_policy). Authorization is enforced by those procedures through the account-wide Authority component against the note sender, so the note carries no assets and its authorization is bound to sender at creation time.

The note is always public (for network execution) and tagged for account — the faucet carrying the TokenPolicyManager component whose policy is being switched. The sender is the account authorized for the action per the faucet’s Authority configuration (the owner under Authority::OwnerControlled, or a role member under Authority::RbacControlled).

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

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

Implementations

impl FaucetPolicyConfigNote

pub fn builder() -> FaucetPolicyConfigNoteBuilder

Builds a new FaucetPolicyConfigNote that applies config to account.

Errors

Returns an error if:

• account 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 account.
• 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 FaucetPolicyConfigNote

pub const NUM_STORAGE_ITEMS: usize = 5

Number of storage items of a FaucetPolicyConfig note: a selector plus the policy root word.

pub fn script() -> NoteScript

Returns the script of the FaucetPolicyConfig note.

pub fn script_root() -> NoteScriptRoot

Returns the FaucetPolicyConfig note script root.

pub fn sender(&self) -> AccountId

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

pub fn account(&self) -> AccountId

Returns the account ID of the managed faucet (the account the note is tagged for).

pub fn config(&self) -> FaucetPolicyConfig

Returns the policy-switch action carried by the note.

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 FaucetPolicyConfigNote

fn clone(&self) -> FaucetPolicyConfigNote

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FaucetPolicyConfigNote

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

Formats the value using the given formatter.

impl From<FaucetPolicyConfigNote> for Note

fn from(note: FaucetPolicyConfigNote) -> Note

Converts to this type from the input type.

impl NoteConsumptionCost for FaucetPolicyConfigNote

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.