Class Ed25519PrivateKey

Represents the private key of an Ed25519 key pair.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

LENGTH SLIP_0010_SEED

Methods

bcsToBytes bcsToHex publicKey serialize sign toString toUint8Array deserialize fromDerivationPath generate isPrivateKey

Constructors

constructor

  • new Ed25519PrivateKey(hexInput): Ed25519PrivateKey

  • Create a new PrivateKey instance from a Uint8Array or String.

    Parameters

    • hexInput: HexInput

      HexInput (string or Uint8Array)

    Returns Ed25519PrivateKey

Properties

Static ReadonlyLENGTH

LENGTH: number

Length of an Ed25519 private key

Static ReadonlySLIP_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

  • publicKey(): Ed25519PublicKey

  • Derive the Ed25519PublicKey for this private key.

    Returns Ed25519PublicKey

    Ed25519PublicKey

serialize

  • serialize(serializer): void

  • Parameters

    Returns void

sign

  • sign(message): Ed25519Signature

  • Sign the given message with the private key.

    Parameters

    • message: HexInput

      a message as a string or Uint8Array

    Returns Ed25519Signature

    Signature

toString

  • toString(): string

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

    Returns string

    string representation of the private key

toUint8Array

  • toUint8Array(): Uint8Array

  • Get the private key in bytes (Uint8Array).

    Returns Uint8Array

    Uint8Array representation of the private key

Staticdeserialize

StaticfromDerivationPath

  • 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

Staticgenerate

  • generate(): Ed25519PrivateKey

  • Generate a new random private key.

    Returns Ed25519PrivateKey

    Ed25519PrivateKey

StaticisPrivateKey

  • isPrivateKey(privateKey): privateKey is Ed25519PrivateKey

  • Parameters

    Returns privateKey is Ed25519PrivateKey

    Deprecated

    use instanceof Ed25519PrivateKey instead.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods