Class Ed25519PrivateKey

Represents the private key of an Ed25519 key pair.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

signingKey LENGTH SLIP_0010_SEED

Methods

bcsToBytes bcsToHex publicKey serialize sign toString toUint8Array deserialize fromDerivationPath fromDerivationPathInner generate isPrivateKey

Constructors

constructor

Properties

Private Readonly signingKey

signingKey: Hex

The Ed25519 signing key

Static Readonly LENGTH

LENGTH: number = 32

Length of an Ed25519 private key

Static Readonly SLIP_0010_SEED

SLIP_0010_SEED: "ed25519 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

Methods

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

publicKey

serialize

sign

toString

  • toString(): string

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

    Returns string

    string representation of the private key

toUint8Array

Static deserialize

Static fromDerivationPath

  • fromDerivationPath(path, mnemonics): Ed25519PrivateKey

  • Derives a private key from a mnemonic seed phrase.

    To derive multiple keys from the same phrase, change the path

    IMPORTANT: Ed25519 supports hardened derivation only (since it lacks a key homomorphism, so non-hardened derivation cannot work)

    Parameters

    • path: string

      the BIP44 path

    • mnemonics: string

      the mnemonic seed phrase

    Returns Ed25519PrivateKey

Static Private fromDerivationPathInner

  • fromDerivationPathInner(path, seed, offset?): Ed25519PrivateKey

  • A private inner function so we can separate from the main fromDerivationPath() method to add tests to verify we create the keys correctly.

    Parameters

    • path: string

      the BIP44 path

    • seed: Uint8Array

      the seed phrase created by the mnemonics

    • offset: number = HARDENED_OFFSET

      the offset used for key derivation, defaults to 0x80000000

    Returns Ed25519PrivateKey

Static generate

Static isPrivateKey

Settings

Member Visibility

Theme

On This Page

constructorsigningKeyLENGTHSLIP_0010_SEEDbcsToBytesbcsToHexpublicKeyserializesigntoStringtoUint8ArraydeserializefromDerivationPathfromDerivationPathInnergenerateisPrivateKey