Struct diem_sdk::types::transaction::authenticator::AuthenticationKey

pub struct AuthenticationKey(_);

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 fn new(bytes: [u8; 32]) -> AuthenticationKey

Create an authentication key from bytes

pub const fn zero() -> AuthenticationKey

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

pub const LENGTH: usize = 32usize

The number of bytes in an authentication key.

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) -> AuthenticationKey

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, Global>

Construct a vector from this authentication key

pub fn random() -> AuthenticationKey

Create a random authentication key. For testing only

Trait Implementations

impl Arbitrary for AuthenticationKey

type Parameters = <[u8; 32] as Arbitrary>::Parameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<<[u8; 32] as Arbitrary>::Strategy, fn(_: [u8; 32]) -> AuthenticationKey>

The type of Strategy used to generate values of type Self.

fn arbitrary_with( _top: <AuthenticationKey as Arbitrary>::Parameters ) -> <AuthenticationKey as Arbitrary>::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

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 copy 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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<D>( deserializer: D ) -> Result<AuthenticationKey, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AuthenticationKey

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

Formats the value using the given formatter.

impl FromStr for AuthenticationKey

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<AuthenticationKey, Error>

Parses a string s to return a value of this type.

impl Hash for AuthenticationKey

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

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<(), Error>

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) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<AuthenticationKey> for AuthenticationKey

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<AuthenticationKey> 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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 as Serializer>::Ok, <S as Serializer>::Error>where S: Serializer,

Serialize this value into the given Serde serializer.

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, Global>> for AuthenticationKey

type Error = CryptoMaterialError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl ValidCryptoMaterial for AuthenticationKey

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

Convert the valid crypto material to bytes.

impl Copy for AuthenticationKey

impl Eq for AuthenticationKey

impl StructuralEq for AuthenticationKey

impl StructuralPartialEq for AuthenticationKey