Class Ed25519PrivateKey

Represents the private key of an Ed25519 key pair.

Hierarchy

Serializable
- Ed25519PrivateKey

Implements

PrivateKey

Index

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
Overrides Serializable.constructor
- Defined in src/core/crypto/ed25519.ts:151

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
Inherited from Serializable.bcsToBytes
- Defined in src/bcs/serializer.ts:27

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
Inherited from Serializable.bcsToHex
- Defined in src/bcs/serializer.ts:37

publicKey

publicKey(): Ed25519PublicKey
Derive the Ed25519PublicKey for this private key.

Returns Ed25519PublicKey
Ed25519PublicKey
Implementation of PrivateKey.publicKey
- Defined in src/core/crypto/ed25519.ts:222

serialize

serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Overrides Serializable.serialize
- Defined in src/core/crypto/ed25519.ts:262

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
Implementation of PrivateKey.sign
- Defined in src/core/crypto/ed25519.ts:233

toString

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

Returns string
string representation of the private key
- Defined in src/core/crypto/ed25519.ts:254

toUint8Array

toUint8Array(): Uint8Array
Get the private key in bytes (Uint8Array).

Returns Uint8Array
Uint8Array representation of the private key
Implementation of PrivateKey.toUint8Array
- Defined in src/core/crypto/ed25519.ts:245

`Static` deserialize

deserialize(deserializer): Ed25519PrivateKey
Parameters
- deserializer: Deserializer
Returns Ed25519PrivateKey
- Defined in src/core/crypto/ed25519.ts:266

`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
- Defined in src/core/crypto/ed25519.ts:184

`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
- Defined in src/core/crypto/ed25519.ts:200

`Static` generate

generate(): Ed25519PrivateKey
Generate a new random private key.

Returns Ed25519PrivateKey
Ed25519PrivateKey
- Defined in src/core/crypto/ed25519.ts:168

`Static` isPrivateKey

isPrivateKey(privateKey): privateKey is Ed25519PrivateKey
Parameters
- privateKey: PrivateKey
Returns privateKey is Ed25519PrivateKey
Deprecated
use instanceof Ed25519PrivateKey instead.
- Defined in src/core/crypto/ed25519.ts:276

Class Ed25519PrivateKey

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

hexInput: HexInput

Returns Ed25519PrivateKey

Properties

Private Readonly signingKey

Static Readonly LENGTH

Static Readonly SLIP_0010_SEED

Methods

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

publicKey

Returns Ed25519PublicKey

serialize

Parameters

serializer: Serializer

Returns void

sign

Parameters

message: HexInput

Returns Ed25519Signature

toString

Returns string

toUint8Array

Returns Uint8Array

Static deserialize

Parameters

deserializer: Deserializer

Returns Ed25519PrivateKey

Static fromDerivationPath

Parameters

path: string

mnemonics: string

Returns Ed25519PrivateKey

Static Private fromDerivationPathInner

Parameters

path: string

seed: Uint8Array

offset: number = HARDENED_OFFSET

Returns Ed25519PrivateKey

Static generate

Returns Ed25519PrivateKey

Static isPrivateKey

Parameters

privateKey: PrivateKey

Returns privateKey is Ed25519PrivateKey

Deprecated

Settings

Member Visibility

Theme

On This Page

`Private` `Readonly` signingKey

`Static` `Readonly` LENGTH

`Static` `Readonly` SLIP_0010_SEED

`Static` deserialize

`Static` fromDerivationPath

`Static` `Private` fromDerivationPathInner

`Static` generate

`Static` isPrivateKey