Class PrivateKeyNamespace

_key

chainCode

• get chainCode(): null | Uint8Array

• 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

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

_toProtobufKey

• _toProtobufKey(): IKey

• Returns IKey

derive

• derive(index): 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.

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): Promise<PrivateKey>

• Parameters

  • index: number

  Returns Promise<PrivateKey>

  Throws

  If this key does not support derivation.

sign

• sign(bytes): Uint8Array

• Sign a message with this private key.

  Parameters

  • bytes: Uint8Array

  Returns Uint8Array

  • The signature bytes without the message

signTransaction

• signTransaction(transaction): Uint8Array

• Parameters

  • transaction: Transaction

  Returns Uint8Array

toAccountId

• toAccountId(shard, realm): AccountId

• Parameters

  • shard: number | Long

  • realm: number | Long

  Returns AccountId

toBytes

• toBytes(): Uint8Array

• Returns Uint8Array

toBytesDer

• toBytesDer(): Uint8Array

• Returns Uint8Array

toBytesRaw

• toBytesRaw(): Uint8Array

• Returns Uint8Array

toKeystore

• toKeystore(passphrase?): Promise<Uint8Array>

• 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

  • Optional passphrase: string = ""

  Returns Promise<Uint8Array>

toString

• toString(): string

• Returns string

toStringDer

• toStringDer(): string

• Returns string

toStringRaw

• toStringRaw(): string

• Returns string

Static fromBytes

• fromBytes(data): PrivateKey

• Construct a private key from bytes. Requires DER header.

  Parameters

  • data: Uint8Array

  Returns PrivateKey

Static fromBytesECDSA

• fromBytesECDSA(data): PrivateKey

• Construct a ECDSA private key from bytes.

  Parameters

  • data: Uint8Array

  Returns PrivateKey

Static fromBytesED25519

• fromBytesED25519(data): PrivateKey

• Construct a ED25519 private key from bytes.

  Parameters

  • data: Uint8Array

  Returns PrivateKey

Static fromKeystore

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

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

  This key will not support child key derivation.

  Parameters

  • data: Uint8Array

  • Optional passphrase: string = ""

  Returns Promise<PrivateKey>

  Throws

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

Static fromMnemonic

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

• Parameters

  • mnemonic: string | default | Mnemonic

  • Optional passphrase: 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).

Static fromPem

• fromPem(data, passphrase?): 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

  • Optional passphrase: string = ""

  Returns Promise<PrivateKey>

Static fromSeedECDSAsecp256k1

• fromSeedECDSAsecp256k1(seed): Promise<PrivateKey>

• Construct a Ed25519 private key from a Uint8Array seed.

  Parameters

  • seed: Uint8Array

  Returns Promise<PrivateKey>

Static fromSeedED25519

• fromSeedED25519(seed): Promise<PrivateKey>

• Construct a Ed25519 private key from a Uint8Array seed.

  Parameters

  • seed: Uint8Array

  Returns Promise<PrivateKey>

Static fromString

• fromString(text): PrivateKey

• Construct a private key from a hex-encoded string. Requires DER header.

  Parameters

  • text: string

  Returns PrivateKey

Static fromStringECDSA

• fromStringECDSA(text): PrivateKey

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

  Parameters

  • text: string

  Returns PrivateKey

Static fromStringED25519

• fromStringED25519(text): PrivateKey

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

  Parameters

  • text: string

  Returns PrivateKey

Static generate

• generate(): PrivateKey

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

  Returns PrivateKey

Static generateAsync

• generateAsync(): Promise<PrivateKey>

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

  Returns Promise<PrivateKey>

Static generateECDSA

• generateECDSA(): PrivateKey

• Generate a random EDSA private key.

  Returns PrivateKey

Static generateECDSAAsync

• generateECDSAAsync(): Promise<PrivateKey>

• Generate a random ECDSA private key.

  Returns Promise<PrivateKey>

Static generateED25519

• generateED25519(): PrivateKey

• Generate a random Ed25519 private key.

  Returns PrivateKey

Static generateED25519Async

• generateED25519Async(): Promise<PrivateKey>

• Generate a random Ed25519 private key.

  Returns Promise<PrivateKey>