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

Implementation - BCS

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:45

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

Implementation - Serialization

constructor

new Ed25519PublicKey(hexInput): Ed25519PublicKey
Creates an instance of the Ed25519Signature class from a hex input. This constructor validates the length of the signature to ensure it meets the required specifications.
Parameters
- hexInput: HexInput
  The hex input representing the Ed25519 signature.
Returns Ed25519PublicKey
Throws
Error if the signature length is not equal to Ed25519Signature.LENGTH.
Overrides AccountPublicKey.constructor
- Defined in src/core/crypto/ed25519.ts:88

`Static` `Readonly`LENGTH

LENGTH: number = 32

Length of an Ed25519 public key

authKey

authKey(): AuthenticationKey
Generates an authentication key from the public key using the Ed25519 scheme. This function is essential for creating a secure authentication key that can be used for further cryptographic operations.

Returns AuthenticationKey
The generated authentication key.
Overrides AccountPublicKey.authKey
- Defined in src/core/crypto/ed25519.ts:149

serialize

serialize(serializer): void
Serializes the data into a byte array using the provided serializer. This allows for the conversion of data into a format suitable for transmission or storage.
Parameters
- serializer: Serializer
  The serializer instance used to perform the serialization.
Returns void
Overrides AccountPublicKey.serialize
- Defined in src/core/crypto/ed25519.ts:179

toString

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

Returns string
The public key in hex format.
Inherited from AccountPublicKey.toString
- Defined in src/core/crypto/publicKey.ts:84

toUint8Array

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

Returns Uint8Array
Uint8Array representation of the data.
Overrides AccountPublicKey.toUint8Array
- Defined in src/core/crypto/ed25519.ts:163

verifySignature

verifySignature(args): boolean
Verifies a signed message using a public key.
Parameters
- args: VerifySignatureArgs
  The arguments for verification.
Returns boolean
Overrides AccountPublicKey.verifySignature
- Defined in src/core/crypto/ed25519.ts:109

verifySignatureAsync

verifySignatureAsync(args): Promise<boolean>
Note: Ed25519Signatures can be verified syncronously.

Verifies the provided signature against the given message. This function helps ensure the integrity and authenticity of the message by confirming that the signature is valid.
Parameters
- args: VerifySignatureAsyncArgs
  The arguments for signature verification.
Returns Promise<boolean>
A boolean indicating whether the signature is valid for the given message.
Overrides AccountPublicKey.verifySignatureAsync
- Defined in src/core/crypto/ed25519.ts:137

`Static`deserialize

deserialize(deserializer): Ed25519PublicKey
Deserialize bytes into an Ed25519Signature object. This function is used to convert serialized byte data into a usable Ed25519Signature instance.
Parameters
- deserializer: Deserializer
  The deserializer instance used to read the byte data.
Returns Ed25519PublicKey
- Defined in src/core/crypto/ed25519.ts:191

`Static`isInstance

isInstance(publicKey): publicKey is Ed25519PublicKey
Determines if the provided public key is a valid Ed25519 public key. This function checks for the presence of the "key" property and verifies that its data length matches the expected length for Ed25519 public keys.
Parameters
- publicKey: PublicKey
  The public key to validate.
Returns publicKey is Ed25519PublicKey
A boolean indicating whether the public key is a valid Ed25519 public key.
- Defined in src/core/crypto/ed25519.ts:221

`Static`isPublicKey

isPublicKey(publicKey): publicKey is Ed25519PublicKey
Determine if the provided public key is an instance of Ed25519PublicKey.
Parameters
- publicKey: AccountPublicKey
  The public key to check.
Returns publicKey is Ed25519PublicKey
True if the public key is an instance of Ed25519PublicKey, otherwise false.

Deprecated
use instanceof Ed25519PublicKey instead.
- Defined in src/core/crypto/ed25519.ts:207

Methods

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

Class Ed25519PublicKey

Hierarchy (view full)

Index

Implementation - BCS

Implementation - Serialization

Methods

Implementation - BCS

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

Implementation - Serialization

constructor

Parameters

Returns Ed25519PublicKey

Throws

Static ReadonlyLENGTH

authKey

Returns AuthenticationKey

serialize

Parameters

Returns void

toString

Returns string

toUint8Array

Returns Uint8Array

verifySignature

Parameters

Returns boolean

verifySignatureAsync

Parameters

Returns Promise<boolean>

Staticdeserialize

Parameters

Returns Ed25519PublicKey

StaticisInstance

Parameters

Returns publicKey is Ed25519PublicKey

StaticisPublicKey

Parameters

Returns publicKey is Ed25519PublicKey

Deprecated

Methods

toStringWithoutPrefix

Returns string

Settings

On This Page

`Static` `Readonly`LENGTH

`Static`deserialize

`Static`isInstance

`Static`isPublicKey