Class PrivateKeyNamespace

_key

chainCode

• get chainCode(): null | Uint8Array<ArrayBufferLike>

  Get the public key associated with this private key.

  The public key can be freely given and used by other parties to verify the signatures generated by this private key.

  Returns null | Uint8Array<ArrayBufferLike>

publicKey

• get publicKey(): PublicKey

  Get the public key associated with this private key.

  The public key can be freely given and used by other parties to verify the signatures generated by this private key.

  Returns PublicKey

type

• get type(): string

  Returns string

_signTransactionLegacy

• _signTransactionLegacy(
      transaction: Transaction,
  ): Uint8Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>[]

  deprecated - This method is deprecated and will be removed in future versions. Use the signTransaction method with the legacy=false flag or don't pass it all for the modern approach.

  Parameters

  • transaction: Transaction

  Returns Uint8Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>[]

_toProtobufKey

• _toProtobufKey(): IKey

  Returns IKey

derive

• derive(index: number): Promise<PrivateKey>

  Derive a new private key at the given wallet index.

  Only currently supported for keys created with fromMnemonic(); other keys will throw an error.

  You can check if a key supports derivation with .supportsDerivation()

  Parameters

  • index: number

  Returns Promise<PrivateKey>

  Throws

  If this key does not support derivation.

getRecoveryId

• getRecoveryId(
      r: Uint8Array<ArrayBufferLike>,
      s: Uint8Array<ArrayBufferLike>,
      message: Uint8Array<ArrayBufferLike>,
  ): number

  Recover the recovery ID used in the signature for the given message.

  Note: This method only works for ECDSA secp256k1 keys.

  Parameters

  • r: Uint8Array<ArrayBufferLike>

    32-byte r component of the signature
  • s: Uint8Array<ArrayBufferLike>

    32-byte s component of the signature
  • message: Uint8Array<ArrayBufferLike>

    The original (unhashed) message

  Returns number

  Recovery ID (0–3), or -1 if not found or not applicable

isDerivable

• isDerivable(): boolean

  Check if derive can be called on this private key.

  This is only the case if the key was created from a mnemonic.

  Returns boolean

legacyDerive

• legacyDerive(index: number): Promise<PrivateKey>

  Parameters

  • index: number

  Returns Promise<PrivateKey>

  Throws

  If this key does not support derivation.

sign

• sign(bytes: Uint8Array<ArrayBufferLike>): Uint8Array<ArrayBufferLike>

  Sign a message with this private key.

  Parameters

  • bytes: Uint8Array<ArrayBufferLike>

  Returns Uint8Array<ArrayBufferLike>

  • The signature bytes without the message

signTransaction

• signTransaction(
      transaction: Transaction,
      legacy: true,
  ): Uint8Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>[]

  Parameters

  • transaction: Transaction
  • legacy: true

  Returns Uint8Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>[]

  Deprecated

  • Use legacy=false flag to use the modern approach or don't pass it at all.
• signTransaction(transaction: Transaction, legacy?: false): SignatureMap

  Parameters

  • transaction: Transaction
  • Optionallegacy: false

  Returns SignatureMap

toAccountId

• toAccountId(shard: number | Long, realm: number | Long): AccountId

  Parameters

  • shard: number | Long
  • realm: number | Long

  Returns AccountId

toBytes

• toBytes(): Uint8Array<ArrayBufferLike>

  Returns Uint8Array<ArrayBufferLike>

toBytesDer

• toBytesDer(): Uint8Array<ArrayBufferLike>

  Returns Uint8Array<ArrayBufferLike>

toBytesRaw

• toBytesRaw(): Uint8Array<ArrayBufferLike>

  Returns Uint8Array<ArrayBufferLike>

toKeystore

• toKeystore(passphrase?: string): Promise<Uint8Array<ArrayBufferLike>>

  Create a keystore with a given passphrase.

  The key can be recovered later with fromKeystore().

  Note that this will not retain the ancillary data used for deriving child keys, thus .derive() on the restored key will throw even if this instance supports derivation.

  Parameters

  • Optionalpassphrase: string = ""

  Returns Promise<Uint8Array<ArrayBufferLike>>

toString

• toString(): string

  Returns string

toStringDer

• toStringDer(): string

  Returns string

toStringRaw

• toStringRaw(): string

  Returns string

StaticfromBytes

• fromBytes(data: Uint8Array<ArrayBufferLike>): PrivateKey

  Construct a private key from bytes. Requires DER header.

  Parameters

  • data: Uint8Array<ArrayBufferLike>

  Returns PrivateKey

StaticfromBytesECDSA

• fromBytesECDSA(data: Uint8Array<ArrayBufferLike>): PrivateKey

  Construct a ECDSA private key from bytes.

  Parameters

  • data: Uint8Array<ArrayBufferLike>

  Returns PrivateKey

StaticfromBytesED25519

• fromBytesED25519(data: Uint8Array<ArrayBufferLike>): PrivateKey

  Construct a ED25519 private key from bytes.

  Parameters

  • data: Uint8Array<ArrayBufferLike>

  Returns PrivateKey

StaticfromKeystore

• fromKeystore(
      data: Uint8Array<ArrayBufferLike>,
      passphrase?: string,
  ): Promise<PrivateKey>

  Recover a private key from a keystore, previously created by .toKeystore().

  This key will not support child key derivation.

  Parameters

  • data: Uint8Array<ArrayBufferLike>
  • Optionalpassphrase: string = ""

  Returns Promise<PrivateKey>

  Throws

  If the passphrase is incorrect or the hash fails to validate.

StaticfromMnemonic

• fromMnemonic(
      mnemonic: string | Mnemonic,
      passphrase?: string,
  ): Promise<PrivateKey>

  Parameters

  • mnemonic: string | Mnemonic
  • Optionalpassphrase: string = ""

  Returns Promise<PrivateKey>

  Deprecated

  • Use Mnemonic.from[Words|String]().to[Ed25519|Ecdsa]PrivateKey() instead

  Recover a private key from a mnemonic phrase (and optionally a password).

StaticfromPem

• fromPem(data: string, passphrase?: string): Promise<PrivateKey>

  Recover a private key from a pem string; the private key may be encrypted.

  This method assumes the .pem file has been converted to a string already.

  If passphrase is not null or empty, this looks for the first ENCRYPTED PRIVATE KEY section and uses passphrase to decrypt it; otherwise, it looks for the first PRIVATE KEY section and decodes that as a DER-encoded private key.

  Parameters

  • data: string
  • Optionalpassphrase: string = ""

  Returns Promise<PrivateKey>

StaticfromSeedECDSAsecp256k1

• fromSeedECDSAsecp256k1(seed: Uint8Array<ArrayBufferLike>): Promise<PrivateKey>

  Construct a Ed25519 private key from a Uint8Array seed.

  Parameters

  • seed: Uint8Array<ArrayBufferLike>

  Returns Promise<PrivateKey>

StaticfromSeedED25519

• fromSeedED25519(seed: Uint8Array<ArrayBufferLike>): Promise<PrivateKey>

  Construct a Ed25519 private key from a Uint8Array seed.

  Parameters

  • seed: Uint8Array<ArrayBufferLike>

  Returns Promise<PrivateKey>

StaticfromString

• fromString(text: string): PrivateKey

  Parameters

  • text: string

  Returns PrivateKey

  Deprecated

  • Use fromStringECDSA() or fromStringED2551() on a HEX-encoded string and fromStringDer() on a HEX-encoded string with DER prefix instead. Construct a private key from a hex-encoded string. Requires DER header.

StaticfromStringDer

• fromStringDer(text: string): PrivateKey

  Construct a private key from a HEX-encoded string with a der prefix

  Parameters

  • text: string

  Returns PrivateKey

StaticfromStringECDSA

• fromStringECDSA(text: string): PrivateKey

  Construct a ECDSA private key from a hex-encoded string.

  Parameters

  • text: string

  Returns PrivateKey

StaticfromStringED25519

• fromStringED25519(text: string): PrivateKey

  Construct a Ed25519 private key from a hex-encoded string.

  Parameters

  • text: string

  Returns PrivateKey

Staticgenerate

• generate(): PrivateKey

  Depredated - Use generateED25519() instead Generate a random Ed25519 private key.

  Returns PrivateKey

StaticgenerateAsync

• generateAsync(): Promise<PrivateKey>

  Depredated - Use generateED25519Async() instead Generate a random Ed25519 private key.

  Returns Promise<PrivateKey>

StaticgenerateECDSA

• generateECDSA(): PrivateKey

  Generate a random EDSA private key.

  Returns PrivateKey

StaticgenerateECDSAAsync

• generateECDSAAsync(): Promise<PrivateKey>

  Generate a random ECDSA private key.

  Returns Promise<PrivateKey>

StaticgenerateED25519

• generateED25519(): PrivateKey

  Generate a random Ed25519 private key.

  Returns PrivateKey

StaticgenerateED25519Async

• generateED25519Async(): Promise<PrivateKey>

  Generate a random Ed25519 private key.

  Returns Promise<PrivateKey>

StaticgetAlgorithm

• getAlgorithm(privateKey: string): "ed25519" | "ecdsa"

  Parameters

  • privateKey: string

  Returns "ed25519" | "ecdsa"