Class AuthenticationKey

Represents an authentication key used for account management. Each account stores an authentication key that enables account owners to rotate their private key(s) without changing the address that hosts their account. The authentication key is a SHA3-256 hash of data and is always 32 bytes in length.

See

Account Basics

Account addresses can be derived from the AuthenticationKey.

Hierarchy (view full)

Serializable
- AuthenticationKey

Index

Constructors

constructor

new AuthenticationKey(args): AuthenticationKey
Creates an instance of the AuthenticationKey using the provided hex input. This ensures that the hex input is valid and conforms to the required length for an Authentication Key.
Parameters
- args: {
  data: HexInput;
  }
  The arguments for constructing the AuthenticationKey.
  - data: HexInput
    The hex input data to be used for the Authentication Key.
Returns AuthenticationKey
Throws
Throws an error if the length of the provided hex input is not equal to the required Authentication Key length.
Overrides Serializable.constructor
- Defined in src/core/authenticationKey.ts:43

Methods

bcsToBytes

bcsToBytes(): Uint8Array
Serializes a Serializable value to its BCS representation. This function is the TypeScript SDK equivalent of bcs::to_bytes in Move.

Returns Uint8Array
the BCS representation of the Serializable instance as a byte buffer.
Inherited from Serializable.bcsToBytes
- Defined in src/bcs/serializer.ts:29

bcsToHex

bcsToHex(): Hex
Converts the BCS-serialized bytes of a value into a Hex instance. This function provides a Hex representation of the BCS-serialized data for easier handling and manipulation.

Returns Hex
A Hex instance with the BCS-serialized bytes loaded into its underlying Uint8Array.
Inherited from Serializable.bcsToHex
- Defined in src/bcs/serializer.ts:40

derivedAddress

derivedAddress(): AccountAddress
Derives an account address from an AuthenticationKey by translating the AuthenticationKey bytes directly to an AccountAddress.

Returns AccountAddress
AccountAddress - The derived account address.
- Defined in src/core/authenticationKey.ts:132

serialize

serialize(serializer): void
Serializes the fixed bytes data into a format suitable for transmission or storage.
Parameters
- serializer: Serializer
  The serializer instance used to perform the serialization.
Returns void
Overrides Serializable.serialize
- Defined in src/core/authenticationKey.ts:58

toString

toString(): string
Returns the hex string representation of the Serializable value with the 0x prefix.

Returns string
the hex formatas a string prefixed by 0x.
Inherited from Serializable.toString
- Defined in src/bcs/serializer.ts:57

toStringWithoutPrefix

toStringWithoutPrefix(): string
Returns the hex string representation of the Serializable value without the 0x prefix.

Returns string
the hex format as a string without 0x prefix.
Inherited from Serializable.toStringWithoutPrefix
- Defined in src/bcs/serializer.ts:49

toUint8Array

toUint8Array(): Uint8Array
Convert the internal data representation to a Uint8Array.

This function is useful for obtaining a byte representation of the data, which can be utilized for serialization or transmission.

Returns Uint8Array
Uint8Array representation of the internal data.
- Defined in src/core/authenticationKey.ts:79

`Static`deserialize

deserialize(deserializer): AuthenticationKey
Deserialize an AuthenticationKey from the byte buffer in a Deserializer instance.
Parameters
- deserializer: Deserializer
  The deserializer to deserialize the AuthenticationKey from.
Returns AuthenticationKey
An instance of AuthenticationKey.
- Defined in src/core/authenticationKey.ts:67

`Static`fromPublicKey

fromPublicKey(args): AuthenticationKey
Converts a PublicKey to an AuthenticationKey using the derivation scheme inferred from the provided PublicKey instance.
Parameters
- args: {
  publicKey: AccountPublicKey;
  }
  The arguments for the function.
  - publicKey: AccountPublicKey
    The PublicKey to be converted.
Returns AuthenticationKey
AuthenticationKey - The derived AuthenticationKey.
- Defined in src/core/authenticationKey.ts:122

`Static`fromPublicKeyAndScheme

fromPublicKeyAndScheme(args): AuthenticationKey
Derives an AuthenticationKey from the provided public key using a specified derivation scheme.
Parameters
- args: {
  publicKey: AccountPublicKey;
  scheme: AuthenticationKeyScheme;
  }
  The arguments for deriving the authentication key.
  - publicKey: AccountPublicKey
    The public key used for the derivation.
  - scheme: AuthenticationKeyScheme
    The scheme to use for deriving the authentication key.
Returns AuthenticationKey
Deprecated
Use fromPublicKey instead.
- Defined in src/core/authenticationKey.ts:110

`Static`fromSchemeAndBytes

fromSchemeAndBytes(args): AuthenticationKey
Generates an AuthenticationKey from the specified scheme and input bytes. This function is essential for creating a valid authentication key based on a given scheme.
Parameters
- args: {
  input: HexInput;
  scheme: AuthenticationKeyScheme;
  }
  The arguments for generating the AuthenticationKey.
  - input: HexInput
    The input data in hexadecimal format to derive the key.
  - scheme: AuthenticationKeyScheme
    The authentication key scheme to use.
Returns AuthenticationKey
An instance of AuthenticationKey containing the generated key data.
- Defined in src/core/authenticationKey.ts:92

Properties

`Readonly`data

data: Hex

The raw bytes of the authentication key.

`Static` `Readonly`LENGTH

LENGTH: number = 32

An authentication key is always a SHA3-256 hash of data, and is always 32 bytes.

The data to hash depends on the underlying public key type and the derivation scheme.

Class AuthenticationKey

See

Hierarchy (view full)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

data: HexInput

Returns AuthenticationKey

Throws

Methods

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

derivedAddress

Returns AccountAddress

serialize

Parameters

Returns void

toString

Returns string

toStringWithoutPrefix

Returns string

toUint8Array

Returns Uint8Array

Staticdeserialize

Parameters

Returns AuthenticationKey

StaticfromPublicKey

Parameters

publicKey: AccountPublicKey

Returns AuthenticationKey

StaticfromPublicKeyAndScheme

Parameters

publicKey: AccountPublicKey

scheme: AuthenticationKeyScheme

Returns AuthenticationKey

Deprecated

StaticfromSchemeAndBytes

Parameters

input: HexInput

scheme: AuthenticationKeyScheme

Returns AuthenticationKey

Properties

Readonlydata

Static ReadonlyLENGTH

Settings

On This Page

`Static`deserialize

`Static`fromPublicKey

`Static`fromPublicKeyAndScheme

`Static`fromSchemeAndBytes

`Readonly`data

`Static` `Readonly`LENGTH