Struct NetworkAccount 

pub struct NetworkAccount { /* private fields */ }

A wrapper around an Account that is guaranteed to be a network account.

Specification

An Account is a network account if and only if all of the following hold:

• It MUST be public, i.e. Account::is_public returns true. The network needs to read account storage to identify the account and route notes to it, so private accounts cannot be network accounts.
• Its storage MUST contain a valid NetworkAccountNoteAllowlist slot. Concretely:
  • the storage slot named NetworkAccountNoteAllowlist::slot_name MUST be present,
  • the slot MUST be a StorageMap (not a value slot),
  • the map MUST be non-empty (the allowlist contains at least one allowed NoteScriptRoot).

The allowlist slot is the shared abstraction across every network-account component, so off-chain services can identify a network account by inspecting its storage for this slot without needing to know which specific component the account uses.

Implementations

impl NetworkAccount

pub fn new( account: Account, ) -> Result<NetworkAccount, NetworkAccountNoteAllowlistError>

Attempts to construct a NetworkAccount from account.

Returns an error if:

• the account is not public, or
• the account’s storage does not contain a valid NetworkAccountNoteAllowlist slot (see NetworkAccountNoteAllowlist::try_from for the exact storage-level checks).

pub fn into_account(self) -> Account

Consumes self and returns the underlying Account.

pub fn as_account(&self) -> &Account

Returns a reference to the underlying Account.

pub fn id(&self) -> AccountId

Returns the AccountId of the underlying account.

pub fn storage(&self) -> &AccountStorage

Returns a reference to the AccountStorage of the underlying account.

pub fn allowed_notes(&self) -> &NetworkAccountNoteAllowlist

Returns the NetworkAccountNoteAllowlist decoded from the underlying account’s storage.

Trait Implementations

impl Clone for NetworkAccount

fn clone(&self) -> NetworkAccount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkAccount

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

Formats the value using the given formatter.

impl Eq for NetworkAccount

impl PartialEq for NetworkAccount

fn eq(&self, other: &NetworkAccount) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for NetworkAccount

impl TryFrom<Account> for NetworkAccount

type Error = NetworkAccountNoteAllowlistError

The type returned in the event of a conversion error.

fn try_from( account: Account, ) -> Result<NetworkAccount, <NetworkAccount as TryFrom<Account>>::Error>

Performs the conversion.