Interface Schnorr

ReadonlyPUBLIC_KEY_SIZE

ReadonlySIGNATURE_SIZE

publicKey

• publicKey(privateKey: Uint8Array): Uint8Array<ArrayBuffer>

  x-only (32-byte) public key of a secp256k1 private key.

  Parameters

  • privateKey: Uint8Array

  Returns Uint8Array<ArrayBuffer>

  Throws

  InvalidParameter on a non-Uint8Array; InvalidSize on a wrong length; InvalidData when the key is not a valid scalar.

sign

• sign(
      privateKey: Uint8Array,
      message: Uint8Array,
      options?: SchnorrSignOptions,
  ): Uint8Array<ArrayBuffer>

  BIP-340 signature. Aux-rand comes from options.auxRand, else 32 bytes drawn from options.rng (the reference's schnorr_sign_using, random_data(32)); a generator's own error propagates unwrapped.

  Parameters

  • privateKey: Uint8Array
  • message: Uint8Array
  • Optionaloptions: SchnorrSignOptions

  Returns Uint8Array<ArrayBuffer>

  Throws

  InvalidParameter on a non-Uint8Array or a non-object options; InvalidSize on a wrong length; InvalidData when the key is not a valid scalar.

verify

• verify(
      publicKey: Uint8Array,
      signature: Uint8Array,
      message: Uint8Array,
  ): boolean

  false on a signature that does not verify (BIP-340 vectors 6–13).

  Parameters

  • publicKey: Uint8Array
  • signature: Uint8Array
  • message: Uint8Array

  Returns boolean

  Throws

  InvalidParameter on a non-Uint8Array; InvalidSize on a wrong-length key or signature; InvalidData when the key is not the x of a point on the curve (BIP-340 vectors 5 and 14), the reference's .expected XOnlyPublicKey::from_byte_array.