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)

Constructors

constructor

Properties

LENGTH

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

Properties

Static ReadonlyLENGTH

LENGTH: number

Length of an Ed25519 public key

Methods

authKey

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

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

serialize

  • serialize(serializer): void

  • Parameters

    Returns void

toString

  • toString(): string

  • Get the public key as a hex string with a 0x prefix e.g. 0x123456...

    Returns string

toUint8Array

  • toUint8Array(): Uint8Array

  • Get the public key in bytes (Uint8Array).

    Returns Uint8Array

    Uint8Array representation of the public key

verifySignature

  • verifySignature(args): boolean

  • Verifies a signed data with a public key

    Parameters

    Returns boolean

Staticdeserialize

StaticisInstance

  • isInstance(publicKey): publicKey is Ed25519PublicKey

  • Parameters

    Returns publicKey is Ed25519PublicKey

StaticisPublicKey

  • isPublicKey(publicKey): publicKey is Ed25519PublicKey

  • Parameters

    Returns publicKey is Ed25519PublicKey

    Deprecated

    use instanceof Ed25519PublicKey instead.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods