@aptos-labs/ts-sdk - v6.1.0
    Preparing search index...

    Class Ed25519PrivateKey

    Represents the private key of an Ed25519 key pair.

    Hierarchy (View Summary)

    Implements

    Index

    Implementation - BCS

    bcsToBytes bcsToHex

    Implementation - Serialization

    constructor LENGTH SLIP_0010_SEED clear isCleared publicKey sign toString toUint8Array fromDerivationPath generate isPrivateKey

    Methods

    serialize toAIP80String toHexString toStringWithoutPrefix deserialize

    Implementation - BCS

    • 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.

    • 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.

    Implementation - Serialization

    LENGTH: number = 32

    Length of an Ed25519 private key

    SLIP_0010_SEED: "ed25519 seed"

    The Ed25519 key seed to use for BIP-32 compatibility See more https://github.com/satoshilabs/slips/blob/master/slip-0010.md

    • Clears the private key from memory by overwriting it with random bytes. After calling this method, the private key can no longer be used for signing or deriving public keys.

      Note: Due to JavaScript's memory management, this cannot guarantee complete removal of sensitive data from memory, but it significantly reduces the window of exposure.

      Returns void

    • Returns whether the private key has been cleared from memory.

      Returns boolean

      true if the key has been cleared, false otherwise

    • Sign the given message with the private key. This function generates a digital signature for the specified message, ensuring its authenticity and integrity.

      Parameters

      • message: HexInput

        A message as a string or Uint8Array in HexInput format.

      Returns Ed25519Signature

      A digital signature for the provided message.

      Error if the private key has been cleared from memory.

    • Get the private key as a hex string with the 0x prefix.

      Returns string

      string representation of the private key.

      Error if the private key has been cleared from memory.

    • Get the private key in bytes (Uint8Array).

      Returns Uint8Array

      Uint8Array representation of the private key

      Error if the private key has been cleared from memory.

    • Derives a private key from a mnemonic seed phrase using a specified BIP44 path. To derive multiple keys from the same phrase, change the path

      IMPORTANT: Ed25519 supports hardened derivation only, as it lacks a key homomorphism, making non-hardened derivation impossible.

      Parameters

      • path: string

        The BIP44 path used for key derivation.

      • mnemonics: string

        The mnemonic seed phrase from which the key will be derived.

      Returns Ed25519PrivateKey

      Error if the provided path is not a valid hardened path.

    Methods

    • Get the private key as a AIP-80 compliant hex string.

      Read about AIP-80

      Returns string

      AIP-80 compliant string representation of the private key.

      Error if the private key has been cleared from memory.

    • Get the private key as a hex string with the 0x prefix.

      Returns string

      string representation of the private key.

      Error if the private key has been cleared from memory.

    Settings

    Member Visibility

    On This Page

    Implementation - BCS
    Implementation - Serialization
    Methods