@bsv/sdk 1.0.0

package/dist/esm/src/primitives/Mersenne.js

@@ -0,0 +1,117 @@
+import BigNumber from './BigNumber.js';
+/**
+ * A representation of a pseudo-Mersenne prime.
+ * A pseudo-Mersenne prime has the general form 2^n - k, where n and k are integers.
+ *
+ * @class Mersenne
+ *
+ * @property name - The identifier for the Mersenne instance.
+ * @property p - BigNumber equivalent to 2^n - k.
+ * @property k - The constant subtracted from 2^n to derive a pseudo-Mersenne prime.
+ * @property n - The exponent which determines the magnitude of the prime.
+ */
+export default class Mersenne {
+    name;
+    p;
+    k;
+    n;
+    tmp;
+    /**
+     * @constructor
+     * @param name - An identifier for the Mersenne instance.
+     * @param p - A string representation of the pseudo-Mersenne prime, expressed in hexadecimal.
+     *
+     * @example
+     * const mersenne = new Mersenne('M31', '7FFFFFFF');
+     */
+    constructor(name, p) {
+        // P = 2 ^ N - K
+        this.name = name;
+        this.p = new BigNumber(p, 16);
+        this.n = this.p.bitLength();
+        this.k = new BigNumber(1).iushln(this.n).isub(this.p);
+        this.tmp = this._tmp();
+    }
+    /**
+     * Creates a temporary BigNumber structure for computations,
+     * ensuring the appropriate number of words are initially allocated.
+     *
+     * @method _tmp
+     * @returns A BigNumber with scaled size depending on prime magnitude.
+     */
+    _tmp() {
+        const tmp = new BigNumber();
+        tmp.words = new Array(Math.ceil(this.n / 13));
+        return tmp;
+    }
+    /**
+     * Reduces an input BigNumber in place, under the assumption that
+     * it is less than the square of the pseudo-Mersenne prime.
+     *
+     * @method ireduce
+     * @param num - The BigNumber to be reduced.
+     * @returns The reduced BigNumber.
+     *
+     * @example
+     * const reduced = mersenne.ireduce(new BigNumber('2345', 16));
+     */
+    ireduce(num) {
+        // Assumes that `num` is less than `P^2`
+        // num = HI * (2 ^ N - K) + HI * K + LO = HI * K + LO (mod P)
+        let r = num;
+        let rlen;
+        do {
+            this.split(r, this.tmp);
+            r = this.imulK(r);
+            r = r.iadd(this.tmp);
+            rlen = r.bitLength();
+        } while (rlen > this.n);
+        const cmp = rlen < this.n ? -1 : r.ucmp(this.p);
+        if (cmp === 0) {
+            r.words[0] = 0;
+            r.length = 1;
+        }
+        else if (cmp > 0) {
+            r.isub(this.p);
+        }
+        else {
+            if (r.strip !== undefined) {
+                // r is a BN v4 instance
+                r.strip();
+            }
+            else {
+                // r is a BN v5 instance
+                r.strip();
+            }
+        }
+        return r;
+    }
+    /**
+     * Shifts bits of the input BigNumber to the right, in place,
+     * to meet the magnitude of the pseudo-Mersenne prime.
+     *
+     * @method split
+     * @param input - The BigNumber to be shifted.
+     * @param out - The BigNumber to hold the shifted result.
+     *
+     * @example
+     * mersenne.split(new BigNumber('2345', 16), new BigNumber());
+     */
+    split(input, out) {
+        input.iushrn(this.n, 0, out);
+    }
+    /**
+     * Performs an in-place multiplication of the parameter by constant k.
+     *
+     * @method imulK
+     * @param num - The BigNumber to multiply with k.
+     * @returns The result of the multiplication, in BigNumber format.
+     *
+     * @example
+     * const multiplied = mersenne.imulK(new BigNumber('2345', 16));
+     */
+    imulK(num) {
+        return num.imul(this.k);
+    }
+}
+//# sourceMappingURL=Mersenne.js.map

package/dist/esm/src/primitives/Mersenne.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Mersenne.js","sourceRoot":"","sources":["../../../../src/primitives/Mersenne.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAA;AAEtC;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,IAAI,CAAQ;IACZ,CAAC,CAAW;IACZ,CAAC,CAAW;IACZ,CAAC,CAAQ;IACQ,GAAG,CAAW;IAE/B;;;;;;;OAOG;IACH,YAAa,IAAY,EAAE,CAAS;QAClC,gBAAgB;QAChB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,CAAC,GAAG,IAAI,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;QAC7B,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,CAAA;QAC3B,IAAI,CAAC,CAAC,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAErD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;OAMG;IACK,IAAI;QACV,MAAM,GAAG,GAAG,IAAI,SAAS,EAAE,CAAA;QAC3B,GAAG,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;QAC7C,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAE,GAAc;QACrB,wCAAwC;QACxC,6DAA6D;QAC7D,IAAI,CAAC,GAAG,GAAG,CAAA;QACX,IAAI,IAAI,CAAA;QAER,GAAG;YACD,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAA;YACvB,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YACjB,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YACpB,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,CAAA;SACrB,QAAQ,IAAI,GAAG,IAAI,CAAC,CAAC,EAAC;QAEvB,MAAM,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC/C,IAAI,GAAG,KAAK,CAAC,EAAE;YACb,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;YACd,CAAC,CAAC,MAAM,GAAG,CAAC,CAAA;SACb;aAAM,IAAI,GAAG,GAAG,CAAC,EAAE;YAClB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SACf;aAAM;YACL,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,EAAE;gBACzB,wBAAwB;gBACxB,CAAC,CAAC,KAAK,EAAE,CAAA;aACV;iBAAM;gBACL,wBAAwB;gBACxB,CAAC,CAAC,KAAK,EAAE,CAAA;aACV;SACF;QAED,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAE,KAAgB,EAAE,GAAc;QACrC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAA;IAC9B,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAE,GAAc;QACnB,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACzB,CAAC;CACF"}

package/dist/esm/src/primitives/MontgomoryMethod.js

@@ -0,0 +1,149 @@
+import ReductionContext from './ReductionContext.js';
+import BigNumber from './BigNumber.js';
+/**
+ * Represents a Montgomery reduction context, which is a mathematical method
+ * for performing modular multiplication without division.
+ *
+ * Montgomery reduction is an algorithm used mainly in cryptography which can
+ * help to speed up calculations in contexts where there are many repeated
+ * computations.
+ *
+ * This class extends the `ReductionContext` class.
+ *
+ * @class MontgomoryMethod
+ * @extends {ReductionContext}
+ *
+ * @property shift - The number of bits in the modulus.
+ * @property r - The 2^shift, shifted left by the bit length of modulus `m`.
+ * @property r2 - The square of `r` modulo `m`.
+ * @property rinv - The modular multiplicative inverse of `r` mod `m`.
+ * @property minv - The modular multiplicative inverse of `m` mod `r`.
+ */
+export default class MontgomoryMethod extends ReductionContext {
+    shift;
+    r;
+    r2;
+    rinv;
+    minv;
+    /**
+     * @constructor
+     * @param m - The modulus to be used for the Montgomery method reductions.
+     */
+    constructor(m) {
+        super(m);
+        this.shift = this.m.bitLength();
+        if (this.shift % 26 !== 0) {
+            this.shift += 26 - (this.shift % 26);
+        }
+        this.r = new BigNumber(1).iushln(this.shift);
+        this.r2 = this.imod(this.r.sqr());
+        this.rinv = this.r._invmp(this.m);
+        this.minv = this.rinv.mul(this.r).isubn(1).div(this.m);
+        this.minv = this.minv.umod(this.r);
+        this.minv = this.r.sub(this.minv);
+    }
+    /**
+     * Converts a number into the Montgomery domain.
+     *
+     * @method convertTo
+     * @param num - The number to be converted into the Montgomery domain.
+     * @returns The result of the conversion into the Montgomery domain.
+     *
+     * @example
+     * const montMethod = new MontgomoryMethod(m);
+     * const convertedNum = montMethod.convertTo(num);
+     */
+    convertTo(num) {
+        return this.imod(num.ushln(this.shift));
+    }
+    /**
+     * Converts a number from the Montgomery domain back to the original domain.
+     *
+     * @method convertFrom
+     * @param num - The number to be converted from the Montgomery domain.
+     * @returns The result of the conversion from the Montgomery domain.
+     *
+     * @example
+     * const montMethod = new MontgomoryMethod(m);
+     * const convertedNum = montMethod.convertFrom(num);
+     */
+    convertFrom(num) {
+        const r = this.imod(num.mul(this.rinv));
+        r.red = null;
+        return r;
+    }
+    /**
+     * Performs an in-place multiplication of two numbers in the Montgomery domain.
+     *
+     * @method imul
+     * @param a - The first number to multiply.
+     * @param b - The second number to multiply.
+     * @returns The result of the in-place multiplication.
+     *
+     * @example
+     * const montMethod = new MontgomoryMethod(m);
+     * const product = montMethod.imul(a, b);
+     */
+    imul(a, b) {
+        if (a.isZero() || b.isZero()) {
+            a.words[0] = 0;
+            a.length = 1;
+            return a;
+        }
+        const t = a.imul(b);
+        const c = t.maskn(this.shift).mul(this.minv).imaskn(this.shift).mul(this.m);
+        const u = t.isub(c).iushrn(this.shift);
+        let res = u;
+        if (u.cmp(this.m) >= 0) {
+            res = u.isub(this.m);
+        }
+        else if (u.cmpn(0) < 0) {
+            res = u.iadd(this.m);
+        }
+        return res.forceRed(this);
+    }
+    /**
+     * Performs the multiplication of two numbers in the Montgomery domain.
+     *
+     * @method mul
+     * @param a - The first number to multiply.
+     * @param b - The second number to multiply.
+     * @returns The result of the multiplication.
+     *
+     * @example
+     * const montMethod = new MontgomoryMethod(m);
+     * const product = montMethod.mul(a, b);
+     */
+    mul(a, b) {
+        if (a.isZero() || b.isZero())
+            return new BigNumber(0).forceRed(this);
+        const t = a.mul(b);
+        const c = t.maskn(this.shift).mul(this.minv).imaskn(this.shift).mul(this.m);
+        const u = t.isub(c).iushrn(this.shift);
+        let res = u;
+        if (u.cmp(this.m) >= 0) {
+            res = u.isub(this.m);
+        }
+        else if (u.cmpn(0) < 0) {
+            res = u.iadd(this.m);
+        }
+        return res.forceRed(this);
+    }
+    /**
+     * Calculates the modular multiplicative inverse of a number in the Montgomery domain.
+     *
+     * @method invm
+     * @param a - The number to compute the modular multiplicative inverse of.
+     * @returns The modular multiplicative inverse of 'a'.
+     *
+     * @example
+     * const montMethod = new MontgomoryMethod(m);
+     * const inverse = montMethod.invm(a);
+     */
+    invm(a) {
+        // (AR)^-1 * R^2 = (A^-1 * R^-1) * R^2 = A^-1 * R
+        const res = this.imod(a._invmp(this.m).mul(this.r2));
+        return res.forceRed(this);
+    }
+}
+//# sourceMappingURL=MontgomoryMethod.js.map

package/dist/esm/src/primitives/MontgomoryMethod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MontgomoryMethod.js","sourceRoot":"","sources":["../../../../src/primitives/MontgomoryMethod.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,uBAAuB,CAAA;AACpD,OAAO,SAAS,MAAM,gBAAgB,CAAA;AAEtC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,gBAAgB;IAC5D,KAAK,CAAQ;IACb,CAAC,CAAW;IACZ,EAAE,CAAW;IACb,IAAI,CAAW;IACf,IAAI,CAAW;IAEf;;;OAGG;IACH,YAAa,CAAqB;QAChC,KAAK,CAAC,CAAC,CAAC,CAAA;QAER,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,CAAA;QAC/B,IAAI,IAAI,CAAC,KAAK,GAAG,EAAE,KAAK,CAAC,EAAE;YACzB,IAAI,CAAC,KAAK,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,CAAA;SACrC;QAED,IAAI,CAAC,CAAC,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC5C,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAEjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACtD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAClC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACnC,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAE,GAAc;QACvB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;IACzC,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CAAE,GAAc;QACzB,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACvC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAA;QACZ,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAE,CAAY,EAAE,CAAY;QAC9B,IAAI,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YAC5B,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;YACd,CAAC,CAAC,MAAM,GAAG,CAAC,CAAA;YACZ,OAAO,CAAC,CAAA;SACT;QAED,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACnB,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC3E,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACtC,IAAI,GAAG,GAAG,CAAC,CAAA;QAEX,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE;YACtB,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SACrB;aAAM,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE;YACxB,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SACrB;QAED,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;IAED;;;;;;;;;;;OAWG;IACH,GAAG,CAAE,CAAY,EAAE,CAAY;QAC7B,IAAI,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE;YAAE,OAAO,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QAEpE,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;QAClB,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC3E,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACtC,IAAI,GAAG,GAAG,CAAC,CAAA;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE;YACtB,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SACrB;aAAM,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE;YACxB,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SACrB;QAED,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAE,CAAY;QAChB,iDAAiD;QACjD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;QACpD,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;CACF"}