Class Secp256k1

constructor

• new Secp256k1(): Secp256k1

• Returns Secp256k1

Static ReadonlySIGNATURE_LENGTH

StaticcompressPublicKey

• compressPublicKey(publicKey): Uint8Array

• Compresses an uncompressed public key.

  Parameters

  • publicKey: Uint8Array

    The uncompressed public key to be compressed.

  Returns Uint8Array

  • The compressed public key.

  See

  Secp256k1.inflatePublicKey

StaticderivePublicKey

• derivePublicKey(privateKey, isCompressed?): Uint8Array

• Derives the public key from a given private key.

  Parameters

  • privateKey: Uint8Array

    The private key in Uint8Array format. Must be a valid 32-byte secp256k1 private key.
  • OptionalisCompressed: boolean = true

    Indicates whether the derived public key should be in compressed format.

  Returns Uint8Array

  The derived public key in Uint8Array format.

  Throws

  Throws an error if the provided private key is not valid.

  Remarks

  Security auditable method, depends on

  • nc_secp256k1.getPublicKey.

StaticgeneratePrivateKey

• generatePrivateKey(): Promise<Uint8Array>

• Generates a new Secp256k1 private key using a secure random number generator.

  Returns Promise<Uint8Array>

  A promise that resolves to a Uint8Array representing the generated private key. This encoded private key is suitable for cryptographic operations.

  Throws

  Throws an error if private key generation fails if a secure random number generator is not provided by the hosting operating system.

  Remarks

  Security auditable method, depends on

  • nc_secp256k1.utils.randomPrivateKey.

StaticinflatePublicKey

• inflatePublicKey(publicKey): Uint8Array

• Inflate a compressed public key to its uncompressed form.

  Parameters

  • publicKey: Uint8Array

    The compressed public key to be inflated.

  Returns Uint8Array

  • The uncompressed public key.

  Remarks

  Security auditable method, depends on

  • nc_secp256k1.ProjectivePoint.fromAffine;
  • nc_secp256k1.ProjectivePoint.fromHex;
  • nc_secp256k1.ProjectivePoint.toAffine.

  See

  Secp256K1.compressPublicKey

StaticisValidMessageHash

• isValidMessageHash(hash): boolean

• Checks whether the provided hash is a valid message hash.

  Parameters

  • hash: Uint8Array

    The hash to be validated.

  Returns boolean

  true if the hash is 32 bytes long, otherwise false.

StaticisValidPrivateKey

• isValidPrivateKey(privateKey): boolean

• Checks if the provided private key is valid.

  Parameters

  • privateKey: Uint8Array

    The private key to validate.

  Returns boolean

  true if the private key is valid, false otherwise.

  Remarks

  Security auditable method, depends on

  • nc_secp256k1.utils.isValidPrivateKey.

StaticrandomBytes

• randomBytes(bytesLength?): Uint8Array

• Generates a random sequence of bytes. If an error occurs during generation using nc_secp256k1, {@link global.crypto is used as fall back togenerate the random sequence.

  Parameters

  • OptionalbytesLength: number = 32

    Optional. The number of random bytes to generate, 32 by default.

  Returns Uint8Array

  • A Uint8Array containing the random bytes.

  Remarks

  Security auditable method, depends on

  • global.crypto.getRandomValues;
  • nh_randomBytes.

Staticrecover

• recover(messageHash, sig): Uint8Array

• Recovers the public key associated with the message hash from the given signature.

  Parameters

  • messageHash: Uint8Array

    The 32-byte message hash to be verified.
  • sig: Uint8Array

    The 65-byte signature used for recovery, consisting of the compact signature and recovery byte.

  Returns Uint8Array

  The recovered public key in its raw bytes form.

  Throws

  If the provided message hash is invalid.

  Throws

  If the provided signature is not 65 bytes or contains an invalid recovery value.

  Remarks

  Security auditable method, depends on

  • nc_secp256k1.Signature.

  See

  Secp256k1.isValidMessageHash

Staticsign

• sign(messageHash, privateKey): Uint8Array

• Signs a given message hash using the provided private key.

  Parameters

  • messageHash: Uint8Array

    A 32-byte message hash that needs to be signed.
  • privateKey: Uint8Array

    A 32-byte private key used for signing the message hash.

  Returns Uint8Array

  The signature of the message hash consisting of the r, s, and recovery values.

  Throws

  InvalidSecp256k1MessageHash if the message hash is not a valid 32-byte hash.

  Throws

  InvalidSecp256k1PrivateKey if the private key is not a valid 32-byte private key.

  Remarks

  Security auditable method, depends on

  • nc_secp256k1.sign.

  See

  • Secp256k1.isValidMessageHash
  • Secp256k1.isValidPrivateKey