Struct PauseConfigNote 

pub struct PauseConfigNote { /* private fields */ }

A PauseConfig note: triggers a PausableManager 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 (pause, unpause). 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 account carrying the PausableManager component whose pause state is being managed. The sender is the account authorized for the action per the account’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 PauseConfigNote

pub fn builder() -> PauseConfigNoteBuilder

Builds a new PauseConfigNote 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 PauseConfigNote

pub const NUM_STORAGE_ITEMS: usize = 1

Number of storage items of a PauseConfig note: a single selector.

pub fn script() -> NoteScript

Returns the script of the PauseConfig note.

pub fn script_root() -> NoteScriptRoot

Returns the PauseConfig 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 account (the account the note is tagged for).

pub fn config(&self) -> PauseConfig

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 PauseConfigNote

fn clone(&self) -> PauseConfigNote

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PauseConfigNote

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

Formats the value using the given formatter.

impl From<PauseConfigNote> for Note

fn from(note: PauseConfigNote) -> Note

Converts to this type from the input type.

impl NoteConsumptionCost for PauseConfigNote

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.