Class PublicKey

hasher

serializer

signer

version

versioner

getAddress

• getAddress(): Address

• Get an address from the public key.

  Returns Address

  A new address object.

toBytes

• toBytes(): Uint8Array

• Public key in bytes.

  Returns Uint8Array

  The versioned public key bytes.

toString

• toString(): string

• Serializes the public key to a string.

  Returns string

  The serialized public key string.

  Remarks

  A public key is serialized as follows:

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

verify

• verify(data, signature): Promise<boolean>

• Checks the message signature with the public key.

  Parameters

  • data: string | Uint8Array

    The data signed by the signature.
  • signature: Signature

    The signature to verify.

  Returns Promise<boolean>

  A boolean indicating whether the signature is valid.

  Remarks

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

Static fromBytes

• fromBytes(bytes): PublicKey

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

  Parameters

  • bytes: Uint8Array

    The public key in byte format.

  Returns PublicKey

  A new public key instance.

Static fromPrivateKey

• fromPrivateKey(privateKey): Promise<PublicKey>

• Initializes a new public key object from a private key.

  Parameters

  • privateKey: PrivateKey

    The private key to derive the public key from.

  Returns Promise<PublicKey>

  A new public key instance.

Static fromString

• fromString(str): PublicKey

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

  Parameters

  • str: string

    The serialized public key string.

  Returns PublicKey

  A new public key instance.

  Throws

  If the public key prefix is invalid.