Class PrivateKey

hasher

serializer

signer

version

versioner

getPublicKey

• getPublicKey(): Promise<PublicKey>

• Returns the public key matching to the current private key.

  Returns Promise<PublicKey>

  A new public key instance.

sign

• sign(message): Promise<Signature>

• Signs the message with the private key.

  Parameters

  • message: Uint8Array

    The byte array to sign.

  Returns Promise<Signature>

  The signature byte array.

  Remarks

  This function signs a byte-encoded message. The message is first hashed and then signed. Do not pass a digest to this function as it will be hashed twice.

toBytes

• toBytes(): Uint8Array

• Private key in bytes.

  Returns Uint8Array

  The versioned private key bytes.

toString

• toString(): string

• Serializes the private key to a string.

  Returns string

  The serialized private key string.

  Remarks

  A private key is serialized as follows:

  • The version is serialized as a varint and prepended to the private key bytes.
  • The result is then sent to the serializer.

Static fromBytes

• fromBytes(bytes): PrivateKey

• Initializes a new private key object from a byte array.

  Parameters

  • bytes: Uint8Array

    The private key in byte format.

  Returns PrivateKey

  A new private key instance.

Static fromEnv

• fromEnv(key?): PrivateKey

• Initializes a new private key object from the environment variables.

  Parameters

  • key: string = 'PRIVATE_KEY'

    The environment variable name containing the private key.

  Returns PrivateKey

  A new private key instance.

  Remarks

  The PRIVATE_KEY or the provided key is required in the environment variables.

Static fromString

• fromString(str): PrivateKey

• Initializes a new private key object from a serialized string.

  Parameters

  • str: string

    The serialized private key string.

  Returns PrivateKey

  A new private key instance.

  Throws

  If the private key prefix is invalid.

Static generate

• generate(version?): PrivateKey

• Initializes a random private key.

  Parameters

  • Optional version: Version

    The version of the private key. If not defined, the last version will be used.

  Returns PrivateKey

  A new private key instance.