Class PrivateKey

constructor

• new PrivateKey(key: Buffer): PrivateKey

  Parameters

  • key: Buffer

  Returns PrivateKey

secret

createPublic

• createPublic(prefix?: string): PublicKey

  Derive the public key for this private key.

  Parameters

  • Optionalprefix: string

  Returns PublicKey

get_shared_secret

• get_shared_secret(public_key: PublicKey): Buffer

  Get shared secret for memo cryptography

  Parameters

  • public_key: PublicKey

  Returns Buffer

inspect

• inspect(): string

  Used by utils.inspect and console.log in node.js. Does not show the full key to get the full encoded key you need to explicitly call toString.

  Returns string

multiply

• multiply(pub: any): Buffer

  Parameters

  • pub: any

  Returns Buffer

sign

• sign(message: Buffer): Signature

  Sign message.

  Parameters

  • message: Buffer

    32-byte message.

  Returns Signature

toString

• toString(): string

  Return a WIF-encoded representation of the key.

  Returns string

Staticfrom

• from(value: string | Buffer<ArrayBufferLike>): PrivateKey

  Convenience to create a new instance from WIF string or buffer.

  Parameters

  • value: string | Buffer<ArrayBufferLike>

  Returns PrivateKey

StaticfromLogin

• fromLogin(username: string, password: string, role?: KeyRole): PrivateKey

  Create key from username and password.

  Parameters

  • username: string
  • password: string
  • role: KeyRole = 'active'

  Returns PrivateKey

StaticfromSeed

• fromSeed(seed: string): PrivateKey

  Create a new instance from a seed.

  Parameters

  • seed: string

  Returns PrivateKey

StaticfromString

• fromString(wif: string): PrivateKey

  Create a new instance from a WIF-encoded key.

  Parameters

  • wif: string

  Returns PrivateKey