Struct AuthenticationKey 

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

A struct that represents an account authentication key. An account’s address is the last 16 bytes of authentication key used to create it

Implementations

impl AuthenticationKey

pub const LENGTH: usize = 32

The number of bytes in an authentication key.

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

Create an authentication key from bytes

pub const fn zero() -> Self

Return an authentication key that is impossible (in expectation) to sign for–useful for intentionally relinquishing control of an account.

pub fn from_preimage(preimage: &AuthenticationKeyPreimage) -> AuthenticationKey

Create an authentication key from a preimage by taking its sha3 hash

pub fn ed25519(public_key: &Ed25519PublicKey) -> AuthenticationKey

Create an authentication key from an Ed25519 public key

pub fn multi_ed25519(public_key: &MultiEd25519PublicKey) -> Self

Create an authentication key from a MultiEd25519 public key

pub fn derived_address(&self) -> AccountAddress

Return an address derived from the last AccountAddress::LENGTH bytes of this authentication key.

pub fn prefix(&self) -> [u8; 16]

Return the first AccountAddress::LENGTH bytes of this authentication key

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

Construct a vector from this authentication key

pub fn random() -> Self

Create a random authentication key. For testing only

Trait Implementations

impl AsRef<[u8]> for AuthenticationKey

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

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 Copy for AuthenticationKey

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 Eq for AuthenticationKey

impl FromStr for AuthenticationKey

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this 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 LowerHex for AuthenticationKey

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

Formats the value using the given formatter.

impl Ord for AuthenticationKey

fn cmp(&self, other: &AuthenticationKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AuthenticationKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for AuthenticationKey

fn partial_cmp(&self, other: &AuthenticationKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

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 StructuralPartialEq for AuthenticationKey

impl TryFrom<&[u8]> for AuthenticationKey

type Error = CryptoMaterialError

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<AuthenticationKey, CryptoMaterialError>

Performs the conversion.

impl TryFrom<Vec<u8>> for AuthenticationKey

type Error = CryptoMaterialError

The type returned in the event of a conversion error.

fn try_from(bytes: Vec<u8>) -> Result<AuthenticationKey, CryptoMaterialError>

Performs the conversion.

impl ValidCryptoMaterial for AuthenticationKey

fn to_bytes(&self) -> Vec<u8>

Convert the valid crypto material to bytes.