Struct AuthenticationKey 

pub struct AuthenticationKey(/* private fields */);

An authentication key used to verify account ownership.

The authentication key is derived from the public key and can be rotated to support key rotation.

Implementations

impl AuthenticationKey

pub fn new(bytes: [u8; 32]) -> Self

Creates an authentication key from bytes.

pub fn from_bytes(bytes: &[u8]) -> AptosResult<Self>

Creates an authentication key from a byte slice.

Errors

Returns an error if the byte slice length is not exactly 32 bytes.

pub fn from_hex(hex_str: &str) -> AptosResult<Self>

Creates an authentication key from a hex string.

Errors

This function will return an error if:

• The hex string is invalid or cannot be decoded
• The decoded bytes are not exactly 32 bytes long

pub fn as_bytes(&self) -> &[u8; 32]

Returns the authentication key as bytes.

pub fn to_bytes(&self) -> [u8; 32]

Returns the authentication key as a byte array.

pub fn to_hex(&self) -> String

Returns the authentication key as a hex string.

pub fn to_address(&self) -> AccountAddress

Derives the account address from this authentication key.

For most accounts, the address equals the authentication key.

Trait Implementations

impl Clone for AuthenticationKey

fn clone(&self) -> AuthenticationKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthenticationKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthenticationKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AuthenticationKey

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

Formats the value using the given formatter.

impl From<[u8; 32]> for AuthenticationKey

fn from(bytes: [u8; 32]) -> Self

Converts to this type from the input type.

impl From<AuthenticationKey> for [u8; 32]

fn from(key: AuthenticationKey) -> Self

Converts to this type from the input type.

impl From<AuthenticationKey> for AccountAddress

fn from(key: AuthenticationKey) -> Self

Converts to this type from the input type.

impl Hash for AuthenticationKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AuthenticationKey

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for AuthenticationKey

impl Eq for AuthenticationKey

impl StructuralPartialEq for AuthenticationKey