Struct AllowlistConfigNote 

pub struct AllowlistConfigNote { /* private fields */ }

An AllowlistConfig note: triggers an AllowlistManager admin action on the account that consumes it.

A single note script dispatches on a selector in the note’s storage to one of the component’s admin procedures (allow_account, disallow_account). 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 and tagged for target — the account carrying the AllowlistManager component whose allowlist is being managed. The sender is the account authorized for the action per the target’s Authority configuration (the owner under Authority::OwnerControlled, or a role member under Authority::RbacControlled).

The note is bound to target 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 AllowlistConfigNote

pub fn builder() -> AllowlistConfigNoteBuilder

Builds a new AllowlistConfigNote that applies config to 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 AllowlistConfigNote

pub const NUM_STORAGE_ITEMS: usize = 3

Number of storage items of an AllowlistConfig note: a selector followed by the account ID the action operates on.

Both actions carry the same arguments, so the layout is fixed at [selector, account_suffix, account_prefix].

pub fn script() -> NoteScript

Returns the script of the AllowlistConfig note.

pub fn script_root() -> NoteScriptRoot

Returns the AllowlistConfig 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 target(&self) -> AccountId

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

pub fn config(&self) -> AllowlistConfig

Returns the admin 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 AllowlistConfigNote

fn clone(&self) -> AllowlistConfigNote

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AllowlistConfigNote

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

Formats the value using the given formatter.

impl From<AllowlistConfigNote> for Note

fn from(note: AllowlistConfigNote) -> Note

Converts to this type from the input type.

impl NoteConsumptionCost for AllowlistConfigNote

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.