Struct AuthNetworkAccount 

pub struct AuthNetworkAccount { /* private fields */ }

An AccountComponent implementing an authentication scheme that restricts what notes an account can consume to a fixed allowlist of note script roots, and what transaction scripts may run against the account to a fixed allowlist of tx script roots.

This is intended for network-owned accounts (e.g. the AggLayer bridge or a network faucet) whose only legitimate inputs are a known, finite set of system-issued notes and scripts.

The component exports a single auth procedure, auth_network_transaction, that rejects the transaction unless:

• the transaction script root, if any, is present in the component’s tx-script allowlist, and
• every consumed input note has a script root present in the component’s note-script allowlist.

Because a network account has no signature gate by default, a transaction script is an unconstrained code path that could call the account’s procedures directly. The tx-script allowlist constrains this to a fixed set of owner-approved scripts; an empty tx-script allowlist permits no transaction scripts at all.

IMPORTANT: an allowlisted root pins a script’s code (its MAST root), not the inputs it runs on. A tx script still receives caller-controlled TX_SCRIPT_ARGS and advice-provider inputs, and a note script receives caller-controlled NOTE_ARGS; on an open network account anyone can supply those. A root should therefore only be allowlisted when the script’s effect is safe for every possible input. The canonical example is a tx script that sets the transaction expiration delta to a hardcoded constant: its effect is fixed regardless of caller or inputs, and the kernel only ever lets a script tighten the current transaction’s expiration window (never extend it), so the worst a caller can do is make their own transaction expire sooner. Allowlisting a script whose effect depends on its inputs re-opens the very code path the allowlist exists to constrain.

The note allowlist is stored in the standardized NetworkAccountNoteAllowlist slot so off-chain services can identify a network account by checking for this slot.

Both allowlists are fixed at account creation: this component intentionally exports no procedure to mutate them after deployment. That is a limitation of this component rather than a safety requirement, and a user who needs a mutable allowlist can write their own component today. Note that the node would likely not yet respect updates made to the list after deployment, but there is in principle nothing preventing us from supporting mutation in the future.

Implementations

impl AuthNetworkAccount

pub const NAME: &'static str = "miden::standards::auth::network_account"

The name of the component.

pub const fn name() -> AccountComponentName

Returns the canonical AccountComponentName of this component.

pub fn code() -> &'static AccountComponentCode

Returns the AccountComponentCode of this component.

pub fn with_allowed_notes( allowed_script_roots: BTreeSet<NoteScriptRoot>, ) -> Result<AuthNetworkAccount, NetworkAccountNoteAllowlistError>

Creates a new AuthNetworkAccount component with the provided list of allowed input-note script roots.

Errors

Returns an error if allowed_script_roots is empty since the account could not consume any notes.

pub fn with_allowed_tx_scripts( self, allowed_tx_script_roots: BTreeSet<TransactionScriptRoot>, ) -> AuthNetworkAccount

Sets the allowlist of transaction script roots this account will execute, replacing any previously configured tx-script allowlist.

An empty set (the default) means the account permits no transaction scripts.

Only scripts whose effect is safe for every possible input should be allowlisted: a root pins the script’s code but not its TX_SCRIPT_ARGS or advice inputs, which the (arbitrary) transaction submitter controls. See the AuthNetworkAccount type docs for the full rationale.

pub fn allowed_note_scripts_slot() -> &'static StorageSlotName

Returns the storage slot holding the allowlist of allowed input-note script roots.

pub fn allowed_note_scripts_slot_schema() -> (StorageSlotName, StorageSlotSchema)

Returns the storage slot schema for the note-script allowlist slot.

pub fn allowed_tx_scripts_slot() -> &'static StorageSlotName

Returns the storage slot holding the allowlist of allowed transaction script roots.

pub fn allowed_tx_scripts_slot_schema() -> (StorageSlotName, StorageSlotSchema)

Returns the storage slot schema for the tx-script allowlist slot.

pub fn component_metadata() -> AccountComponentMetadata

Returns the AccountComponentMetadata for this component.

Trait Implementations

impl From<AuthNetworkAccount> for AccountComponent

fn from(component: AuthNetworkAccount) -> AccountComponent

Converts to this type from the input type.