Class Ed25519PublicKey

Represents the public key of an Ed25519 key pair.

Since AIP-55 Aptos supports Legacy and Unified authentication keys.

Ed25519 scheme is represented in the SDK as Legacy authentication key and also as AnyPublicKey that represents any Unified authentication key

Hierarchy (view full)

AccountPublicKey
- Ed25519PublicKey

Index

Constructors

Properties

Methods

authKey bcsToBytes bcsToHex serialize toString toUint8Array verifySignature deserialize isInstance isPublicKey

Constructors

constructor

new Ed25519PublicKey(hexInput): Ed25519PublicKey
Create a new PublicKey instance from a Uint8Array or String.
Parameters
- hexInput: HexInput
  A HexInput (string or Uint8Array)
Returns Ed25519PublicKey
Overrides AccountPublicKey.constructor
- Defined in src/core/crypto/ed25519.ts:70

Properties

`Private` `Readonly` key

key: Hex

Bytes of the public key

`Static` `Readonly` LENGTH

LENGTH: number = 32

Length of an Ed25519 public key

Methods

authKey

authKey(): AuthenticationKey
Get the authentication key associated with this public key

Returns AuthenticationKey
Overrides AccountPublicKey.authKey
- Defined in src/core/crypto/ed25519.ts:101

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 AccountPublicKey.bcsToBytes
- Defined in src/bcs/serializer.ts:27

bcsToHex

bcsToHex(): Hex
Helper function to get a value's BCS-serialized bytes as a Hex instance.

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

serialize

serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Overrides AccountPublicKey.serialize
- Defined in src/core/crypto/ed25519.ts:121

toString

toString(): string
Get the public key as a hex string with a 0x prefix e.g. 0x123456...

Returns string
Inherited from AccountPublicKey.toString
- Defined in src/core/crypto/publicKey.ts:36

toUint8Array

toUint8Array(): Uint8Array
Get the public key in bytes (Uint8Array).

Returns Uint8Array
Uint8Array representation of the public key
Overrides AccountPublicKey.toUint8Array
- Defined in src/core/crypto/ed25519.ts:113

verifySignature

verifySignature(args): boolean
Verifies a signed data with a public key
Parameters
- args: VerifySignatureArgs
Returns boolean
Overrides AccountPublicKey.verifySignature
- Defined in src/core/crypto/ed25519.ts:87

`Static` deserialize

deserialize(deserializer): Ed25519PublicKey
Parameters
- deserializer: Deserializer
Returns Ed25519PublicKey
- Defined in src/core/crypto/ed25519.ts:125

`Static` isInstance

isInstance(publicKey): publicKey is Ed25519PublicKey
Parameters
- publicKey: PublicKey
Returns publicKey is Ed25519PublicKey
- Defined in src/core/crypto/ed25519.ts:139

`Static` isPublicKey

isPublicKey(publicKey): publicKey is Ed25519PublicKey
Parameters
- publicKey: AccountPublicKey
Returns publicKey is Ed25519PublicKey
Deprecated
use instanceof Ed25519PublicKey instead.
- Defined in src/core/crypto/ed25519.ts:135