Struct AuthContext 

pub struct AuthContext { /* private fields */ }

AuthContext provides a lightweight execution context used during the authentication phase of a transaction.

It allows authenticator functions to:

• Inspect the programmable transaction block (PTB) inputs and commands
• Perform function-level permission checks
• Support OTP, time-locked auth, or regulatory rule enforcement

This struct is immutable during the auth phase and must not allow mutation of state or access to storage beyond what is declared.

It is guaranteed to be available to all smart accounts implementing a custom authenticator function.

Typical use:

public fun authenticate(account: &Account, signature: &vector<u8>, auth_ctx: &AuthContext, ctx: &TxContext) {
    assert!(ed25519::ed25519_verify(signature, &account.pub_key, ctx.digest()), EEd25519VerificationFailed);

    assert!(is_authorized(&extract_function_key(&auth_ctx)), EUnauthorized);
    ...
}

Implementations

impl AuthContext

pub fn new_from_components( auth_digest: MoveAuthenticatorDigest, sender_auth_digest: Digest, sponsor_auth_digest: Option<Digest>, sender_authenticator_function_ref_v1: Option<AuthenticatorFunctionRefV1>, sponsor_authenticator_function_ref_v1: Option<AuthenticatorFunctionRefV1>, ptb: &ProgrammableTransaction, tx_data_bytes: Vec<u8>, ) -> Self

pub fn new_for_testing() -> Self

pub fn digest(&self) -> &MoveAuthenticatorDigest

Returns the MoveAuthenticator digest.

pub fn sender_auth_digest(&self) -> &Digest

Returns the sender’s auth digest. For MoveAuthenticator signatures equals MoveAuthenticator::digest(); for others Blake2b256 of the serialized (flag-prefixed) signature bytes.

pub fn sponsor_auth_digest(&self) -> Option<&Digest>

Returns the sponsor’s auth digest for sponsored transactions, None otherwise. For MoveAuthenticator signatures equals MoveAuthenticator::digest(); for others Blake2b256 of the serialized (flag-prefixed) signature bytes.

pub fn sender_authenticator_function_ref_v1( &self, ) -> Option<&AuthenticatorFunctionRefV1>

Returns the sender’s authenticator function ref, present when the sender uses a MoveAuthenticator signature.

pub fn sponsor_authenticator_function_ref_v1( &self, ) -> Option<&AuthenticatorFunctionRefV1>

Returns the sponsor’s authenticator function ref, present when the sponsor uses a MoveAuthenticator signature.

pub fn tx_inputs(&self) -> &Vec<MoveCallArg>

pub fn tx_commands(&self) -> &Vec<MoveCommand>

pub fn tx_data_bytes(&self) -> &Vec<u8>

pub fn to_bcs_bytes(&self) -> Vec<u8>

pub fn to_move_bcs_bytes(&self) -> Vec<u8>

pub fn kind(module: &CompiledModule, token: &SignatureToken) -> AuthContextKind

Returns whether the type signature is &mut AuthContext, &AuthContext, or none of the above.

pub fn type_() -> StructTag

pub fn replace( &mut self, auth_digest: MoveAuthenticatorDigest, tx_inputs: Vec<MoveCallArg>, tx_commands: Vec<MoveCommand>, tx_data_bytes: Vec<u8>, sender_auth_digest: Digest, sponsor_auth_digest: Option<Digest>, sender_authenticator_function_ref_v1: Option<AuthenticatorFunctionRefV1>, sponsor_authenticator_function_ref_v1: Option<AuthenticatorFunctionRefV1>, )

Replaces the contents of the AuthContext with new values. This is intended for use within a Move test function, as the AuthContext should be immutable during normal use.

Trait Implementations

impl Clone for AuthContext

fn clone(&self) -> AuthContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthContext

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

Formats the value using the given formatter.

impl PartialEq for AuthContext

fn eq(&self, other: &AuthContext) -> 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 Serialize for AuthContext

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AuthContext

impl StructuralPartialEq for AuthContext