@noble/curves 0.5.0 → 0.5.1

package/README.md

@@ -7,8 +7,8 @@ Minimal, auditable JS implementation of elliptic curve cryptography.
 - [hash to curve](https://datatracker.ietf.org/doc/draft-irtf-cfrg-hash-to-curve/)
   for encoding or hashing an arbitrary string to a point on an elliptic curve
 - Auditable, [fast](#speed)
-- 🔻 Tree-shaking-friendly: there is no entry point, which ensures small size of your app
 - 🔍 Unique tests ensure correctness. Wycheproof vectors included
+- 🔻 Tree-shaking-friendly: there is no entry point, which ensures small size of your app
 
 There are two parts of the package:
 
@@ -84,11 +84,12 @@ To define a custom curve, check out API below.
 ## API
 
 - [Overview](#overview)
-- [abstract/edwards: Twisted Edwards curve](#abstract/edwards-twisted-edwards-curve)
-- [abstract/montgomery: Montgomery curve](#abstract/montgomery-montgomery-curve)
-- [abstract/weierstrass: Short Weierstrass curve](#abstract/weierstrass-short-weierstrass-curve)
-- [abstract/modular](#abstract/modular)
-- [abstract/utils](#abstract/utils)
+- [abstract/edwards: Twisted Edwards curve](#abstractedwards-twisted-edwards-curve)
+- [abstract/montgomery: Montgomery curve](#abstractmontgomery-montgomery-curve)
+- [abstract/weierstrass: Short Weierstrass curve](#abstractweierstrass-short-weierstrass-curve)
+- [abstract/hash-to-curve: Hashing strings to curve points](#abstracthash-to-curve-hashing-strings-to-curve-points)
+- [abstract/modular](#abstractmodular)
+- [abstract/utils](#abstractutils)
 
 ### Overview
 
@@ -324,20 +325,70 @@ export type CurveFn = {
 };
 ```
 
+### abstract/hash-to-curve: Hashing strings to curve points
+
+The module allows to hash arbitrary strings to elliptic curve points.
+
+- `expand_message_xmd` [(spec)](https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-hash-to-curve-11#section-5.4.1) produces a uniformly random byte string using a cryptographic hash function H that outputs b bits..
+
+    ```ts
+    function expand_message_xmd(
+      msg: Uint8Array, DST: Uint8Array, lenInBytes: number, H: CHash
+    ): Uint8Array;
+    function expand_message_xof(
+      msg: Uint8Array, DST: Uint8Array, lenInBytes: number, k: number, H: CHash
+    ): Uint8Array;
+    ```
+
+- `hash_to_field(msg, count, options)` [(spec)](https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-hash-to-curve-11#section-5.3)
+hashes arbitrary-length byte strings to a list of one or more elements of a finite field F.
+    * `msg` a byte string containing the message to hash
+    * `count` the number of elements of F to output
+    * `options` `{DST: string, p: bigint, m: number, k: number, expand: 'xmd' | 'xof', hash: H}`
+    * Returns `[u_0, ..., u_(count - 1)]`, a list of field elements.
+
+    ```ts
+    function hash_to_field(msg: Uint8Array, count: number, options: htfOpts): bigint[][];
+    type htfOpts = {
+      // DST: a domain separation tag
+      // defined in section 2.2.5
+      DST: string;
+      // p: the characteristic of F
+      //    where F is a finite field of characteristic p and order q = p^m
+      p: bigint;
+      // m: the extension degree of F, m >= 1
+      //     where F is a finite field of characteristic p and order q = p^m
+      m: number;
+      // k: the target security level for the suite in bits
+      // defined in section 5.1
+      k: number;
+      // option to use a message that has already been processed by
+      // expand_message_xmd
+      expand?: 'xmd' | 'xof';
+      // Hash functions for: expand_message_xmd is appropriate for use with a
+      // wide range of hash functions, including SHA-2, SHA-3, BLAKE2, and others.
+      // BBS+ uses blake2: https://github.com/hyperledger/aries-framework-go/issues/2247
+      // TODO: verify that hash is shake if expand==='xof' via types
+      hash: CHash;
+    };
+    ```
+
 ### abstract/modular
 
 Modular arithmetics utilities.
 
 ```typescript
-import { mod, invert, div, invertBatch, sqrt, Fp } from '@noble/curves/abstract/modular';
+import { Fp, mod, invert, div, invertBatch, sqrt } from '@noble/curves/abstract/modular';
+const fp = Fp(2n ** 255n - 19n); // Finite field over 2^255-19
+fp.mul(591n, 932n);
+fp.pow(481n, 11024858120n);
+
+// Generic non-FP utils are also available
 mod(21n, 10n); // 21 mod 10 == 1n; fixed version of 21 % 10
 invert(17n, 10n); // invert(17) mod 10; modular multiplicative inverse
 div(5n, 17n, 10n); // 5/17 mod 10 == 5 * invert(17) mod 10; division
 invertBatch([1n, 2n, 4n], 21n); // => [1n, 11n, 16n] in one inversion
 sqrt(21n, 73n); // √21 mod 73; square root
-const fp = Fp(2n ** 255n - 19n); // Finite field over 2^255-19
-fp.mul(591n, 932n);
-fp.pow(481n, 11024858120n);
 ```
 
 ### abstract/utils

package/lib/abstract/hash-to-curve.d.ts

@@ -6,12 +6,21 @@ export declare type htfOpts = {
     p: bigint;
     m: number;
     k: number;
-    expand: boolean;
+    expand?: 'xmd' | 'xof';
     hash: CHash;
 };
 export declare function validateHTFOpts(opts: htfOpts): void;
 export declare function stringToBytes(str: string): Uint8Array;
 export declare function expand_message_xmd(msg: Uint8Array, DST: Uint8Array, lenInBytes: number, H: CHash): Uint8Array;
+export declare function expand_message_xof(msg: Uint8Array, DST: Uint8Array, lenInBytes: number, k: number, H: CHash): Uint8Array;
+/**
+ * Hashes arbitrary-length byte strings to a list of one or more elements of a finite field F
+ * https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-hash-to-curve-11#section-5.3
+ * @param msg a byte string containing the message to hash
+ * @param count the number of elements of F to output
+ * @param options `{DST: string, p: bigint, m: number, k: number, expand: 'xmd' | 'xof', hash: H}`
+ * @returns [u_0, ..., u_(count - 1)], a list of field elements.
+ */
 export declare function hash_to_field(msg: Uint8Array, count: number, options: htfOpts): bigint[][];
 export declare function isogenyMap<T, F extends mod.Field<T>>(field: F, map: [T[], T[], T[], T[]]): (x: T, y: T) => {
     x: T;

package/lib/abstract/hash-to-curve.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isogenyMap = exports.hash_to_field = exports.expand_message_xmd = exports.stringToBytes = exports.validateHTFOpts = void 0;
+exports.isogenyMap = exports.hash_to_field = exports.expand_message_xof = exports.expand_message_xmd = exports.stringToBytes = exports.validateHTFOpts = void 0;
 /*! noble-curves - MIT License (c) 2022 Paul Miller (paulmillr.com) */
 const utils_js_1 = require("./utils.js");
 const mod = require("./modular.js");
@@ -13,7 +13,7 @@ function validateHTFOpts(opts) {
         throw new Error('Invalid htf/m');
     if (typeof opts.k !== 'number')
         throw new Error('Invalid htf/k');
-    if (typeof opts.expand !== 'boolean')
+    if (opts.expand !== 'xmd' && opts.expand !== 'xof' && opts.expand !== undefined)
         throw new Error('Invalid htf/expand');
     if (typeof opts.hash !== 'function' || !Number.isSafeInteger(opts.hash.outputLen))
         throw new Error('Invalid htf/hash function');
@@ -81,13 +81,32 @@ function expand_message_xmd(msg, DST, lenInBytes, H) {
     return pseudo_random_bytes.slice(0, lenInBytes);
 }
 exports.expand_message_xmd = expand_message_xmd;
-// hashes arbitrary-length byte strings to a list of one or more elements of a finite field F
-// https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-hash-to-curve-11#section-5.3
-// Inputs:
-// msg - a byte string containing the message to hash.
-// count - the number of elements of F to output.
-// Outputs:
-// [u_0, ..., u_(count - 1)], a list of field elements.
+function expand_message_xof(msg, DST, lenInBytes, k, H) {
+    // https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-hash-to-curve-16#section-5.3.3
+    // DST = H('H2C-OVERSIZE-DST-' || a_very_long_DST, Math.ceil((lenInBytes * k) / 8));
+    if (DST.length > 255) {
+        const dkLen = Math.ceil((2 * k) / 8);
+        DST = H.create({ dkLen }).update(stringToBytes('H2C-OVERSIZE-DST-')).update(DST).digest();
+    }
+    if (lenInBytes > 65535 || DST.length > 255)
+        throw new Error('expand_message_xof: invalid lenInBytes');
+    return (H.create({ dkLen: lenInBytes })
+        .update(msg)
+        .update(i2osp(lenInBytes, 2))
+        // 2. DST_prime = DST || I2OSP(len(DST), 1)
+        .update(DST)
+        .update(i2osp(DST.length, 1))
+        .digest());
+}
+exports.expand_message_xof = expand_message_xof;
+/**
+ * Hashes arbitrary-length byte strings to a list of one or more elements of a finite field F
+ * https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-hash-to-curve-11#section-5.3
+ * @param msg a byte string containing the message to hash
+ * @param count the number of elements of F to output
+ * @param options `{DST: string, p: bigint, m: number, k: number, expand: 'xmd' | 'xof', hash: H}`
+ * @returns [u_0, ..., u_(count - 1)], a list of field elements.
+ */
 function hash_to_field(msg, count, options) {
     // if options is provided but incomplete, fill any missing fields with the
     // value in hftDefaults (ie hash to G2).
@@ -96,9 +115,12 @@ function hash_to_field(msg, count, options) {
     const len_in_bytes = count * options.m * L;
     const DST = stringToBytes(options.DST);
     let pseudo_random_bytes = msg;
-    if (options.expand) {
+    if (options.expand === 'xmd') {
         pseudo_random_bytes = expand_message_xmd(msg, DST, len_in_bytes, options.hash);
     }
+    else if (options.expand === 'xof') {
+        pseudo_random_bytes = expand_message_xof(msg, DST, len_in_bytes, options.k, options.hash);
+    }
     const u = new Array(count);
     for (let i = 0; i < count; i++) {
         const e = new Array(options.m);

package/lib/abstract/modular.d.ts

@@ -8,18 +8,8 @@ export declare function mod(a: bigint, b: bigint): bigint;
 export declare function pow(num: bigint, power: bigint, modulo: bigint): bigint;
 export declare function pow2(x: bigint, power: bigint, modulo: bigint): bigint;
 export declare function invert(number: bigint, modulo: bigint): bigint;
-/**
- * Calculates Legendre symbol (a | p), which denotes the value of a^((p-1)/2) (mod p).
- * * (a | p) ≡ 1    if a is a square (mod p)
- * * (a | p) ≡ -1   if a is not a square (mod p)
- * * (a | p) ≡ 0    if a ≡ 0 (mod p)
- */
-export declare function legendre(num: bigint, fieldPrime: bigint): bigint;
-/**
- * Calculates square root of a number in a finite field.
- * √a mod P
- */
-export declare function sqrt(number: bigint, modulo: bigint): bigint;
+export declare function tonelliShanks(P: bigint): <T>(Fp: Field<T>, n: T) => T;
+export declare function FpSqrt(P: bigint): <T>(Fp: Field<T>, n: T) => T;
 export declare const isNegativeLE: (num: bigint, modulo: bigint) => boolean;
 export interface Field<T> {
     ORDER: bigint;
@@ -57,8 +47,9 @@ export declare function validateField<T>(field: Field<T>): void;
 export declare function FpPow<T>(f: Field<T>, num: T, power: bigint): T;
 export declare function FpInvertBatch<T>(f: Field<T>, nums: T[]): T[];
 export declare function FpDiv<T>(f: Field<T>, lhs: T, rhs: T | bigint): T;
-export declare function Fp(ORDER: bigint, bitLen?: number, isLE?: boolean, redef?: Partial<Field<bigint>>): Readonly<Field<bigint>>;
-export declare function FpSqrt<T>(Fp: Field<T>): {
-    sqrt: (x: T) => T;
-    isSquare: (x: T) => boolean;
-};
+export declare function FpIsSquare<T>(f: Field<T>): (x: T) => boolean;
+declare type FpField = Field<bigint> & Required<Pick<Field<bigint>, 'isOdd'>>;
+export declare function Fp(ORDER: bigint, bitLen?: number, isLE?: boolean, redef?: Partial<Field<bigint>>): Readonly<FpField>;
+export declare function FpSqrtOdd<T>(Fp: Field<T>, elm: T): T;
+export declare function FpSqrtEven<T>(Fp: Field<T>, elm: T): T;
+export {};

package/lib/abstract/modular.js

@@ -1,13 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FpSqrt = exports.Fp = exports.FpDiv = exports.FpInvertBatch = exports.FpPow = exports.validateField = exports.isNegativeLE = exports.sqrt = exports.legendre = exports.invert = exports.pow2 = exports.pow = exports.mod = void 0;
+exports.FpSqrtEven = exports.FpSqrtOdd = exports.Fp = exports.FpIsSquare = exports.FpDiv = exports.FpInvertBatch = exports.FpPow = exports.validateField = exports.isNegativeLE = exports.FpSqrt = exports.tonelliShanks = exports.invert = exports.pow2 = exports.pow = exports.mod = void 0;
 /*! noble-curves - MIT License (c) 2022 Paul Miller (paulmillr.com) */
+// TODO: remove circular imports
 const utils = require("./utils.js");
 // Utilities for modular arithmetics and finite fields
 // prettier-ignore
 const _0n = BigInt(0), _1n = BigInt(1), _2n = BigInt(2), _3n = BigInt(3);
 // prettier-ignore
-const _4n = BigInt(4), _5n = BigInt(5), _7n = BigInt(7), _8n = BigInt(8);
+const _4n = BigInt(4), _5n = BigInt(5), _8n = BigInt(8);
 // prettier-ignore
 const _9n = BigInt(9), _16n = BigInt(16);
 // Calculates a modulo b
@@ -73,26 +74,67 @@ function invert(number, modulo) {
     return mod(x, modulo);
 }
 exports.invert = invert;
-/**
- * Calculates Legendre symbol (a | p), which denotes the value of a^((p-1)/2) (mod p).
- * * (a | p) ≡ 1    if a is a square (mod p)
- * * (a | p) ≡ -1   if a is not a square (mod p)
- * * (a | p) ≡ 0    if a ≡ 0 (mod p)
- */
-function legendre(num, fieldPrime) {
-    return pow(num, (fieldPrime - _1n) / _2n, fieldPrime);
+// Tonelli-Shanks algorithm
+// https://eprint.iacr.org/2012/685.pdf (page 12)
+function tonelliShanks(P) {
+    // Legendre constant: used to calculate Legendre symbol (a | p),
+    // which denotes the value of a^((p-1)/2) (mod p).
+    // (a | p) ≡ 1    if a is a square (mod p)
+    // (a | p) ≡ -1   if a is not a square (mod p)
+    // (a | p) ≡ 0    if a ≡ 0 (mod p)
+    const legendreC = (P - _1n) / _2n;
+    let Q, S, Z;
+    // Step 1: By factoring out powers of 2 from p - 1,
+    // find q and s such that p - 1 = q2s with q odd
+    for (Q = P - _1n, S = 0; Q % _2n === _0n; Q /= _2n, S++)
+        ;
+    // Step 2: Select a non-square z such that (z | p) ≡ -1 and set c ≡ zq
+    for (Z = _2n; Z < P && pow(Z, legendreC, P) !== P - _1n; Z++)
+        ;
+    // Fast-path
+    if (S === 1) {
+        const p1div4 = (P + _1n) / _4n;
+        return function tonelliFast(Fp, n) {
+            const root = Fp.pow(n, p1div4);
+            if (!Fp.equals(Fp.square(root), n))
+                throw new Error('Cannot find square root');
+            return root;
+        };
+    }
+    // Slow-path
+    const Q1div2 = (Q + _1n) / _2n;
+    return function tonelliSlow(Fp, n) {
+        // Step 0: Check that n is indeed a square: (n | p) must be ≡ 1
+        if (Fp.pow(n, legendreC) !== Fp.ONE)
+            throw new Error('Cannot find square root');
+        let s = S;
+        let c = pow(Z, Q, P);
+        let r = Fp.pow(n, Q1div2);
+        let t = Fp.pow(n, Q);
+        let t2 = Fp.ZERO;
+        while (!Fp.equals(Fp.sub(t, Fp.ONE), Fp.ZERO)) {
+            t2 = Fp.square(t);
+            let i;
+            for (i = 1; i < s; i++) {
+                // stop if t2-1 == 0
+                if (Fp.equals(Fp.sub(t2, Fp.ONE), Fp.ZERO))
+                    break;
+                // t2 *= t2
+                t2 = Fp.square(t2);
+            }
+            let b = pow(c, BigInt(1 << (s - i - 1)), P);
+            r = Fp.mul(r, b);
+            c = mod(b * b, P);
+            t = Fp.mul(t, c);
+            s = i;
+        }
+        return r;
+    };
 }
-exports.legendre = legendre;
-/**
- * Calculates square root of a number in a finite field.
- * √a mod P
- */
-// TODO: rewrite as generic Fp function && remove bls versions
-function sqrt(number, modulo) {
-    // prettier-ignore
-    const n = number;
-    const P = modulo;
-    const p1div4 = (P + _1n) / _4n;
+exports.tonelliShanks = tonelliShanks;
+function FpSqrt(P) {
+    // NOTE: different algorithms can give different roots, it is up to user to decide which one they want.
+    // For example there is FpSqrtOdd/FpSqrtEven to choice root based on oddness (used for hash-to-curve).
     // P ≡ 3 (mod 4)
     // √n = n^((P+1)/4)
     if (P % _4n === _3n) {
@@ -100,52 +142,55 @@ function sqrt(number, modulo) {
         // const ORDER =
         //   0x1a0111ea397fe69a4b1ba7b6434bacd764774b84f38512bf6730d2a0f6b0f6241eabfffeb153ffffb9feffffffffaaabn;
         // const NUM = 72057594037927816n;
-        // TODO: fix sqrtMod in secp256k1
-        const root = pow(n, p1div4, P);
-        if (mod(root * root, modulo) !== number)
-            throw new Error('Cannot find square root');
-        return root;
+        const p1div4 = (P + _1n) / _4n;
+        return function sqrt3mod4(Fp, n) {
+            const root = Fp.pow(n, p1div4);
+            // Throw if root**2 != n
+            if (!Fp.equals(Fp.square(root), n))
+                throw new Error('Cannot find square root');
+            return root;
+        };
     }
-    // P ≡ 5 (mod 8)
+    // Atkin algorithm for q ≡ 5 (mod 8), https://eprint.iacr.org/2012/685.pdf (page 10)
     if (P % _8n === _5n) {
-        const n2 = mod(n * _2n, P);
-        const v = pow(n2, (P - _5n) / _8n, P);
-        const nv = mod(n * v, P);
-        const i = mod(_2n * nv * v, P);
-        const r = mod(nv * (i - _1n), P);
-        return r;
+        const c1 = (P - _5n) / _8n;
+        return function sqrt5mod8(Fp, n) {
+            const n2 = Fp.mul(n, _2n);
+            const v = Fp.pow(n2, c1);
+            const nv = Fp.mul(n, v);
+            const i = Fp.mul(Fp.mul(nv, _2n), v);
+            const root = Fp.mul(nv, Fp.sub(i, Fp.ONE));
+            if (!Fp.equals(Fp.square(root), n))
+                throw new Error('Cannot find square root');
+            return root;
+        };
     }
-    // Other cases: Tonelli-Shanks algorithm
-    if (legendre(n, P) !== _1n)
-        throw new Error('Cannot find square root');
-    let q, s, z;
-    for (q = P - _1n, s = 0; q % _2n === _0n; q /= _2n, s++)
-        ;
-    if (s === 1)
-        return pow(n, p1div4, P);
-    for (z = _2n; z < P && legendre(z, P) !== P - _1n; z++)
-        ;
-    let c = pow(z, q, P);
-    let r = pow(n, (q + _1n) / _2n, P);
-    let t = pow(n, q, P);
-    let t2 = _0n;
-    while (mod(t - _1n, P) !== _0n) {
-        t2 = mod(t * t, P);
-        let i;
-        for (i = 1; i < s; i++) {
-            if (mod(t2 - _1n, P) === _0n)
-                break;
-            t2 = mod(t2 * t2, P);
-        }
-        let b = pow(c, BigInt(1 << (s - i - 1)), P);
-        r = mod(r * b, P);
-        c = mod(b * b, P);
-        t = mod(t * c, P);
-        s = i;
+    // P ≡ 9 (mod 16)
+    if (P % _16n === _9n) {
+        // NOTE: tonelli is too slow for bls-Fp2 calculations even on start
+        // Means we cannot use sqrt for constants at all!
+        //
+        // const c1 = Fp.sqrt(Fp.negate(Fp.ONE)); //  1. c1 = sqrt(-1) in F, i.e., (c1^2) == -1 in F
+        // const c2 = Fp.sqrt(c1);                //  2. c2 = sqrt(c1) in F, i.e., (c2^2) == c1 in F
+        // const c3 = Fp.sqrt(Fp.negate(c1));     //  3. c3 = sqrt(-c1) in F, i.e., (c3^2) == -c1 in F
+        // const c4 = (P + _7n) / _16n;           //  4. c4 = (q + 7) / 16        # Integer arithmetic
+        // sqrt = (x) => {
+        //   let tv1 = Fp.pow(x, c4);             //  1. tv1 = x^c4
+        //   let tv2 = Fp.mul(c1, tv1);           //  2. tv2 = c1 * tv1
+        //   const tv3 = Fp.mul(c2, tv1);         //  3. tv3 = c2 * tv1
+        //   let tv4 = Fp.mul(c3, tv1);           //  4. tv4 = c3 * tv1
+        //   const e1 = Fp.equals(Fp.square(tv2), x); //  5.  e1 = (tv2^2) == x
+        //   const e2 = Fp.equals(Fp.square(tv3), x); //  6.  e2 = (tv3^2) == x
+        //   tv1 = Fp.cmov(tv1, tv2, e1); //  7. tv1 = CMOV(tv1, tv2, e1)  # Select tv2 if (tv2^2) == x
+        //   tv2 = Fp.cmov(tv4, tv3, e2); //  8. tv2 = CMOV(tv4, tv3, e2)  # Select tv3 if (tv3^2) == x
+        //   const e3 = Fp.equals(Fp.square(tv2), x); //  9.  e3 = (tv2^2) == x
+        //   return Fp.cmov(tv1, tv2, e3); //  10.  z = CMOV(tv1, tv2, e3)  # Select the sqrt from tv1 and tv2
+        // }
     }
-    return r;
+    // Other cases: Tonelli-Shanks algorithm
+    return tonelliShanks(P);
 }
-exports.sqrt = sqrt;
+exports.FpSqrt = FpSqrt;
 // Little-endian check for first LE bit (last BE bit);
 const isNegativeLE = (num, modulo) => (mod(num, modulo) & _1n) === _1n;
 exports.isNegativeLE = isNegativeLE;
@@ -216,17 +261,22 @@ function FpDiv(f, lhs, rhs) {
     return f.mul(lhs, typeof rhs === 'bigint' ? invert(rhs, f.ORDER) : f.invert(rhs));
 }
 exports.FpDiv = FpDiv;
-// NOTE: very fragile, always bench. Major performance points:
-// - NonNormalized ops
-// - Object.freeze
-// - same shape of object (don't add/remove keys)
+// This function returns True whenever the value x is a square in the field F.
+function FpIsSquare(f) {
+    const legendreConst = (f.ORDER - _1n) / _2n; // Integer arithmetic
+    return (x) => {
+        const p = f.pow(x, legendreConst);
+        return f.equals(p, f.ZERO) || f.equals(p, f.ONE);
+    };
+}
+exports.FpIsSquare = FpIsSquare;
 function Fp(ORDER, bitLen, isLE = false, redef = {}) {
     if (ORDER <= _0n)
         throw new Error(`Expected Fp ORDER > 0, got ${ORDER}`);
     const { nBitLength: BITS, nByteLength: BYTES } = utils.nLength(ORDER, bitLen);
     if (BYTES > 2048)
         throw new Error('Field lengths over 2048 bytes are not supported');
-    const sqrtP = (num) => sqrt(num, ORDER);
+    const sqrtP = FpSqrt(ORDER);
     const f = Object.freeze({
         ORDER,
         BITS,
@@ -256,7 +306,7 @@ function Fp(ORDER, bitLen, isLE = false, redef = {}) {
         subN: (lhs, rhs) => lhs - rhs,
         mulN: (lhs, rhs) => lhs * rhs,
         invert: (num) => invert(num, ORDER),
-        sqrt: redef.sqrt || sqrtP,
+        sqrt: redef.sqrt || ((n) => sqrtP(f, n)),
         invertBatch: (lst) => FpInvertBatch(f, lst),
         // TODO: do we really need constant cmov?
         // We don't have const-time bigints anyway, so probably will be not very useful
@@ -271,88 +321,17 @@ function Fp(ORDER, bitLen, isLE = false, redef = {}) {
     return Object.freeze(f);
 }
 exports.Fp = Fp;
-// TODO: re-use in bls/generic sqrt for field/etc?
-// Something like sqrtUnsafe which always returns value, but sqrt throws exception if non-square
-// From draft-irtf-cfrg-hash-to-curve-16
-function FpSqrt(Fp) {
-    // NOTE: it requires another sqrt for constant precomputes, but no need for roots of unity,
-    // probably we can simply bls code using it
-    const q = Fp.ORDER;
-    const squareConst = (q - _1n) / _2n;
-    // is_square(x) := { True,  if x^((q - 1) / 2) is 0 or 1 in F;
-    //                 { False, otherwise.
-    let isSquare = (x) => {
-        const p = Fp.pow(x, squareConst);
-        return Fp.equals(p, Fp.ZERO) || Fp.equals(p, Fp.ONE);
-    };
-    // Constant-time Tonelli-Shanks algorithm
-    let l = _0n;
-    for (let o = q - _1n; o % _2n === _0n; o /= _2n)
-        l += _1n;
-    const c1 = l; // 1. c1, the largest integer such that 2^c1 divides q - 1.
-    const c2 = (q - _1n) / _2n ** c1; // 2. c2 = (q - 1) / (2^c1)        # Integer arithmetic
-    const c3 = (c2 - _1n) / _2n; // 3. c3 = (c2 - 1) / 2            # Integer arithmetic
-    //  4. c4, a non-square value in F
-    //  5. c5 = c4^c2 in F
-    let c4 = Fp.ONE;
-    while (isSquare(c4))
-        c4 = Fp.add(c4, Fp.ONE);
-    const c5 = Fp.pow(c4, c2);
-    let sqrt = (x) => {
-        let z = Fp.pow(x, c3); // 1.  z = x^c3
-        let t = Fp.square(z); // 2.  t = z * z
-        t = Fp.mul(t, x); // 3.  t = t * x
-        z = Fp.mul(z, x); // 4.  z = z * x
-        let b = t; // 5.  b = t
-        let c = c5; // 6.  c = c5
-        // 7.  for i in (c1, c1 - 1, ..., 2):
-        for (let i = c1; i > 1; i--) {
-            // 8.    for j in (1, 2, ..., i - 2):
-            // 9.      b = b * b
-            for (let j = _1n; j < i - _1n; i++)
-                b = Fp.square(b);
-            const e = Fp.equals(b, Fp.ONE); // 10.   e = b == 1
-            const zt = Fp.mul(z, c); // 11.   zt = z * c
-            z = Fp.cmov(zt, z, e); // 12.   z = CMOV(zt, z, e)
-            c = Fp.square(c); // 13.   c = c * c
-            let tt = Fp.mul(t, c); // 14.   tt = t * c
-            t = Fp.cmov(tt, t, e); // 15.   t = CMOV(tt, t, e)
-            b = t; // 16.   b = t
-        }
-        return z; // 17. return z
-    };
-    if (q % _4n === _3n) {
-        const c1 = (q + _1n) / _4n; // 1. c1 = (q + 1) / 4     # Integer arithmetic
-        sqrt = (x) => Fp.pow(x, c1);
-    }
-    else if (q % _8n === _5n) {
-        const c1 = Fp.sqrt(Fp.negate(Fp.ONE)); //  1. c1 = sqrt(-1) in F, i.e., (c1^2) == -1 in F
-        const c2 = (q + _3n) / _8n; //  2. c2 = (q + 3) / 8     # Integer arithmetic
-        sqrt = (x) => {
-            let tv1 = Fp.pow(x, c2); //  1. tv1 = x^c2
-            let tv2 = Fp.mul(tv1, c1); //  2. tv2 = tv1 * c1
-            let e = Fp.equals(Fp.square(tv1), x); //  3.   e = (tv1^2) == x
-            return Fp.cmov(tv2, tv1, e); //  4.   z = CMOV(tv2, tv1, e)
-        };
-    }
-    else if (Fp.ORDER % _16n === _9n) {
-        const c1 = Fp.sqrt(Fp.negate(Fp.ONE)); //  1. c1 = sqrt(-1) in F, i.e., (c1^2) == -1 in F
-        const c2 = Fp.sqrt(c1); //  2. c2 = sqrt(c1) in F, i.e., (c2^2) == c1 in F
-        const c3 = Fp.sqrt(Fp.negate(c1)); //  3. c3 = sqrt(-c1) in F, i.e., (c3^2) == -c1 in F
-        const c4 = (Fp.ORDER + _7n) / _16n; //  4. c4 = (q + 7) / 16         # Integer arithmetic
-        sqrt = (x) => {
-            let tv1 = Fp.pow(x, c4); //  1. tv1 = x^c4
-            let tv2 = Fp.mul(c1, tv1); //  2. tv2 = c1 * tv1
-            const tv3 = Fp.mul(c2, tv1); //  3. tv3 = c2 * tv1
-            let tv4 = Fp.mul(c3, tv1); //  4. tv4 = c3 * tv1
-            const e1 = Fp.equals(Fp.square(tv2), x); //  5.  e1 = (tv2^2) == x
-            const e2 = Fp.equals(Fp.square(tv3), x); //  6.  e2 = (tv3^2) == x
-            tv1 = Fp.cmov(tv1, tv2, e1); //  7. tv1 = CMOV(tv1, tv2, e1)  # Select tv2 if (tv2^2) == x
-            tv2 = Fp.cmov(tv4, tv3, e2); //  8. tv2 = CMOV(tv4, tv3, e2)  # Select tv3 if (tv3^2) == x
-            const e3 = Fp.equals(Fp.square(tv2), x); //  9.  e3 = (tv2^2) == x
-            return Fp.cmov(tv1, tv2, e3); //  10.  z = CMOV(tv1, tv2, e3)  # Select the sqrt from tv1 and tv2
-        };
-    }
-    return { sqrt, isSquare };
+function FpSqrtOdd(Fp, elm) {
+    if (!Fp.isOdd)
+        throw new Error(`Field doesn't have isOdd`);
+    const root = Fp.sqrt(elm);
+    return Fp.isOdd(root) ? root : Fp.negate(root);
 }
-exports.FpSqrt = FpSqrt;
+exports.FpSqrtOdd = FpSqrtOdd;
+function FpSqrtEven(Fp, elm) {
+    if (!Fp.isOdd)
+        throw new Error(`Field doesn't have isOdd`);
+    const root = Fp.sqrt(elm);
+    return Fp.isOdd(root) ? Fp.negate(root) : root;
+}
+exports.FpSqrtEven = FpSqrtEven;

package/lib/abstract/utils.d.ts

@@ -6,7 +6,9 @@ export declare type CHash = {
     (message: Uint8Array | string): Uint8Array;
     blockLen: number;
     outputLen: number;
-    create(): any;
+    create(opts?: {
+        dkLen?: number;
+    }): any;
 };
 export declare type BasicCurve<T> = {
     Fp: mod.Field<T>;

package/lib/bls12-381.d.ts

@@ -1,6 +1,6 @@
 import { CurveFn } from './abstract/bls.js';
 import * as mod from './abstract/modular.js';
-declare const Fp: Readonly<mod.Field<bigint>>;
+declare const Fp: Readonly<mod.Field<bigint> & Required<Pick<mod.Field<bigint>, "isOdd">>>;
 declare type Fp = bigint;
 declare type BigintTuple = [bigint, bigint];
 declare type Fp2 = {

package/lib/bls12-381.js

@@ -818,7 +818,7 @@ const htfDefaults = {
     k: 128,
     // option to use a message that has already been processed by
     // expand_message_xmd
-    expand: true,
+    expand: 'xmd',
     // Hash functions for: expand_message_xmd is appropriate for use with a
     // wide range of hash functions, including SHA-2, SHA-3, BLAKE2, and others.
     // BBS+ uses blake2: https://github.com/hyperledger/aries-framework-go/issues/2247