Class AuthenticationKey

Each account stores an authentication key. Authentication key enables account owners to rotate their private key(s) associated with the account without changing the address that hosts their account.

See

https://aptos.dev/concepts/accounts | Account Basics

Account addresses can be derived from AuthenticationKey

Hierarchy

AuthenticationKey

Index

Constructors

constructor

new AuthenticationKey(bytes: Uint8Array): AuthenticationKey
Parameters
- bytes: Uint8Array
Returns AuthenticationKey
- Defined in src/aptos_types/authentication_key.ts:28

Properties

`Readonly` bytes

bytes: Uint8Array

`Static` `Readonly` DERIVE_RESOURCE_ACCOUNT_SCHEME

DERIVE_RESOURCE_ACCOUNT_SCHEME: number = 255

`Static` `Readonly` ED25519_SCHEME

ED25519_SCHEME: number = 0

`Static` `Readonly` LENGTH

LENGTH: number = 32

`Static` `Readonly` MULTI_ED25519_SCHEME

MULTI_ED25519_SCHEME: number = 1

Methods

derivedAddress

derivedAddress(): HexString
Derives an account address from AuthenticationKey. Since current AccountAddress is 32 bytes, AuthenticationKey bytes are directly translated to AccountAddress.

Returns HexString
- Defined in src/aptos_types/authentication_key.ts:70

`Static` fromEd25519PublicKey

fromEd25519PublicKey(publicKey: Ed25519PublicKey): AuthenticationKey
Parameters
- publicKey: Ed25519PublicKey
Returns AuthenticationKey
- Defined in src/aptos_types/authentication_key.ts:53

`Static` fromMultiEd25519PublicKey

fromMultiEd25519PublicKey(publicKey: MultiEd25519PublicKey): AuthenticationKey
Converts a K-of-N MultiEd25519PublicKey to AuthenticationKey with: auth_key = sha3-256(p_1 | … | p_n | K | 0x01). K represents the K-of-N required for authenticating the transaction. 0x01 is the 1-byte scheme for multisig.
Parameters
- publicKey: MultiEd25519PublicKey
Returns AuthenticationKey
- Defined in src/aptos_types/authentication_key.ts:40

Class AuthenticationKey

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

bytes: Uint8Array

Returns AuthenticationKey

Properties

`Readonly` bytes

`Static` `Readonly` DERIVE_RESOURCE_ACCOUNT_SCHEME

`Static` `Readonly` ED25519_SCHEME

`Static` `Readonly` LENGTH

`Static` `Readonly` MULTI_ED25519_SCHEME

Methods

derivedAddress

Returns HexString

`Static` fromEd25519PublicKey

Parameters

publicKey: Ed25519PublicKey

Returns AuthenticationKey

`Static` fromMultiEd25519PublicKey

Parameters

publicKey: MultiEd25519PublicKey

Returns AuthenticationKey

Settings

Member Visibility

Theme

Class AuthenticationKey

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

bytes: Uint8Array

Returns AuthenticationKey

Properties

Readonly bytes

Static Readonly DERIVE_RESOURCE_ACCOUNT_SCHEME

Static Readonly ED25519_SCHEME

Static Readonly LENGTH

Static Readonly MULTI_ED25519_SCHEME

Methods

derivedAddress

Returns HexString

Static fromEd25519PublicKey

Parameters

publicKey: Ed25519PublicKey

Returns AuthenticationKey

Static fromMultiEd25519PublicKey

Parameters

publicKey: MultiEd25519PublicKey

Returns AuthenticationKey

Settings

Member Visibility

Theme

`Readonly` bytes

`Static` `Readonly` DERIVE_RESOURCE_ACCOUNT_SCHEME

`Static` `Readonly` ED25519_SCHEME

`Static` `Readonly` LENGTH

`Static` `Readonly` MULTI_ED25519_SCHEME

`Static` fromEd25519PublicKey

`Static` fromMultiEd25519PublicKey