bn.js 5.1.2 → 5.2.1

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright Fedor Indutny, 2015.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -21,11 +21,17 @@ console.log(res.toString(10));  // 57047
 
 **Note**: decimals are not supported in this library.
 
+## Sponsors
+
+[![Scout APM](./sponsors/scout-apm.png)](https://scoutapm.com/)
+My Open Source work is supported by [Scout APM](https://scoutapm.com/) and
+[other sponsors](https://github.com/sponsors/indutny).
+
 ## Notation
 
 ### Prefixes
 
-There are several prefixes to instructions that affect the way the work. Here
+There are several prefixes to instructions that affect the way they work. Here
 is the list of them in the order of appearance in the function name:
 
 * `i` - perform operation in-place, storing the result in the host object (on
@@ -50,7 +56,7 @@ is the list of them in the order of appearance in the function name:
 
 ## Instructions
 
-Prefixes/postfixes are put in parens at the of the line. `endian` - could be
+Prefixes/postfixes are put in parens at the end of the line. `endian` - could be
 either `le` (little-endian) or `be` (big-endian).
 
 ### Utilities
@@ -98,6 +104,7 @@ either `le` (little-endian) or `be` (big-endian).
 * `a.pow(b)` - raise `a` to the power of `b`
 * `a.div(b)` - divide (`divn`, `idivn`)
 * `a.mod(b)` - reduct (`u`, `n`) (but no `umodn`)
+* `a.divmod(b)` - quotient and modulus obtained by dividing
 * `a.divRound(b)` - rounded division
 
 ### Bit operations
@@ -106,7 +113,7 @@ either `le` (little-endian) or `be` (big-endian).
 * `a.and(b)` - and (`i`, `u`, `iu`, `andln`) (NOTE: `andln` is going to be replaced
   with `andn` in future)
 * `a.xor(b)` - xor (`i`, `u`, `iu`)
-* `a.setn(b)` - set specified bit to `1`
+* `a.setn(b, value)` - set specified bit to `value`
 * `a.shln(b)` - shift left (`i`, `u`, `iu`)
 * `a.shrn(b)` - shift right (`i`, `u`, `iu`)
 * `a.testn(b)` - test if specified bit is set
@@ -128,7 +135,7 @@ for [Mersenne Prime][1].
 
 ### Reduction context
 
-To enable this tricks one should create a reduction context:
+To enable this trick one should create a reduction context:
 
 ```js
 var red = BN.red(num);
@@ -203,26 +210,5 @@ There is no limitation on the size of the numbers.
 
 This software is licensed under the MIT License.
 
-Copyright Fedor Indutny, 2015.
-
-Permission is hereby granted, free of charge, to any person obtaining a
-copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to permit
-persons to whom the Software is furnished to do so, subject to the
-following conditions:
-
-The above copyright notice and this permission notice shall be included
-in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
-NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
-OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
-USE OR OTHER DEALINGS IN THE SOFTWARE.
-
 [0]: https://en.wikipedia.org/wiki/Montgomery_modular_multiplication
 [1]: https://en.wikipedia.org/wiki/Mersenne_prime

package/lib/bn.js

@@ -50,7 +50,11 @@
 
   var Buffer;
   try {
-    Buffer = require('buffer').Buffer;
+    if (typeof window !== 'undefined' && typeof window.Buffer !== 'undefined') {
+      Buffer = window.Buffer;
+    } else {
+      Buffer = require('buffer').Buffer;
+    }
   } catch (e) {
   }
 
@@ -91,23 +95,19 @@
     var start = 0;
     if (number[0] === '-') {
       start++;
-    }
-
-    if (base === 16) {
-      this._parseHex(number, start);
-    } else {
-      this._parseBase(number, base, start);
-    }
-
-    if (number[0] === '-') {
       this.negative = 1;
     }
 
-    this._strip();
-
-    if (endian !== 'le') return;
-
-    this._initArray(this.toArray(), base, endian);
+    if (start < number.length) {
+      if (base === 16) {
+        this._parseHex(number, start, endian);
+      } else {
+        this._parseBase(number, base, start);
+        if (endian === 'le') {
+          this._initArray(this.toArray(), base, endian);
+        }
+      }
+    }
   };
 
   BN.prototype._initNumber = function _initNumber (number, base, endian) {
@@ -183,39 +183,31 @@
     return this._strip();
   };
 
-  function parseHex (str, start, end) {
-    var r = 0;
-    var len = Math.min(str.length, end);
-    var z = 0;
-    for (var i = start; i < len; i++) {
-      var c = str.charCodeAt(i) - 48;
-
-      r <<= 4;
-
-      var b;
-
-      // 'a' - 'f'
-      if (c >= 49 && c <= 54) {
-        b = c - 49 + 0xa;
-
-      // 'A' - 'F'
-      } else if (c >= 17 && c <= 22) {
-        b = c - 17 + 0xa;
-
-      // '0' - '9'
-      } else {
-        b = c;
-      }
-
-      r |= b;
-      z |= b;
+  function parseHex4Bits (string, index) {
+    var c = string.charCodeAt(index);
+    // '0' - '9'
+    if (c >= 48 && c <= 57) {
+      return c - 48;
+    // 'A' - 'F'
+    } else if (c >= 65 && c <= 70) {
+      return c - 55;
+    // 'a' - 'f'
+    } else if (c >= 97 && c <= 102) {
+      return c - 87;
+    } else {
+      assert(false, 'Invalid character in ' + string);
     }
+  }
 
-    assert(!(z & 0xf0), 'Invalid character in ' + str);
+  function parseHexByte (string, lowerBound, index) {
+    var r = parseHex4Bits(string, index);
+    if (index - 1 >= lowerBound) {
+      r |= parseHex4Bits(string, index - 1) << 4;
+    }
     return r;
   }
 
-  BN.prototype._parseHex = function _parseHex (number, start) {
+  BN.prototype._parseHex = function _parseHex (number, start, endian) {
     // Create possibly bigger array to ensure that it fits the number
     this.length = Math.ceil((number.length - start) / 6);
     this.words = new Array(this.length);
@@ -223,25 +215,38 @@
       this.words[i] = 0;
     }
 
-    var j, w;
-    // Scan 24-bit chunks and add them to the number
+    // 24-bits chunks
     var off = 0;
-    for (i = number.length - 6, j = 0; i >= start; i -= 6) {
-      w = parseHex(number, i, i + 6);
-      this.words[j] |= (w << off) & 0x3ffffff;
-      // NOTE: `0x3fffff` is intentional here, 26bits max shift + 24bit hex limb
-      this.words[j + 1] |= w >>> (26 - off) & 0x3fffff;
-      off += 24;
-      if (off >= 26) {
-        off -= 26;
-        j++;
-      }
-    }
-    if (i + 6 !== start) {
-      w = parseHex(number, start, i + 6);
-      this.words[j] |= (w << off) & 0x3ffffff;
-      this.words[j + 1] |= w >>> (26 - off) & 0x3fffff;
+    var j = 0;
+
+    var w;
+    if (endian === 'be') {
+      for (i = number.length - 1; i >= start; i -= 2) {
+        w = parseHexByte(number, start, i) << off;
+        this.words[j] |= w & 0x3ffffff;
+        if (off >= 18) {
+          off -= 18;
+          j += 1;
+          this.words[j] |= w >>> 26;
+        } else {
+          off += 8;
+        }
+      }
+    } else {
+      var parseLength = number.length - start;
+      for (i = parseLength % 2 === 0 ? start + 1 : start; i < number.length; i += 2) {
+        w = parseHexByte(number, start, i) << off;
+        this.words[j] |= w & 0x3ffffff;
+        if (off >= 18) {
+          off -= 18;
+          j += 1;
+          this.words[j] |= w >>> 26;
+        } else {
+          off += 8;
+        }
+      }
     }
+
     this._strip();
   };
 
@@ -315,6 +320,8 @@
         this._iaddn(word);
       }
     }
+
+    this._strip();
   };
 
   BN.prototype.copy = function copy (dest) {
@@ -370,7 +377,11 @@
   // Check Symbol.for because not everywhere where Symbol defined
   // See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol#Browser_compatibility
   if (typeof Symbol !== 'undefined' && typeof Symbol.for === 'function') {
-    BN.prototype[Symbol.for('nodejs.util.inspect.custom')] = inspect;
+    try {
+      BN.prototype[Symbol.for('nodejs.util.inspect.custom')] = inspect;
+    } catch (e) {
+      BN.prototype.inspect = inspect;
+    }
   } else {
     BN.prototype.inspect = inspect;
   }
@@ -469,16 +480,16 @@
         var w = this.words[i];
         var word = (((w << off) | carry) & 0xffffff).toString(16);
         carry = (w >>> (24 - off)) & 0xffffff;
-        if (carry !== 0 || i !== this.length - 1) {
-          out = zeros[6 - word.length] + word + out;
-        } else {
-          out = word + out;
-        }
         off += 2;
         if (off >= 26) {
           off -= 26;
           i--;
         }
+        if (carry !== 0 || i !== this.length - 1) {
+          out = zeros[6 - word.length] + word + out;
+        } else {
+          out = word + out;
+        }
       }
       if (carry !== 0) {
         out = carry.toString(16) + out;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bn.js",
-  "version": "5.1.2",
+  "version": "5.2.1",
   "description": "Big number implementation in pure javascript",
   "keywords": [
     "BN",
@@ -32,11 +32,8 @@
     "unit": "mocha --reporter=spec test/*-test.js"
   },
   "devDependencies": {
-    "babel-eslint": "^10.0.3",
-    "mocha": "^7.0.1",
-    "standardx": "^5.0.0"
-  },
-  "standardx": {
-    "parser": "babel-eslint"
+    "eslint-plugin-es5": "^1.5.0",
+    "mocha": "^8.3.0",
+    "standardx": "^7.0.0"
   }
 }

package/CHANGELOG.md

@@ -1,40 +0,0 @@
-5.1.2 / 2020-05-20
-------------------
-
-- Fix BN v5/v4 interoperability issue (#249)
-
-5.1.1 / 2019-12-24
-------------------
-
-- Temporary workaround for BN#_move (#236)
-- Add eslintrc instead config in package.json (#237)
-
-5.1.0 / 2019-12-23
-------------------
-
-- Benchmark for BigInt (#226)
-- Add documentation for max/min (#232)
-- Update BN#inspect for Symbols (#225)
-- Improve performance of toArrayLike (#222)
-- temporary disable jumboMulTo in BN#mulTo (#221)
-- optimize toBitArray function (#212)
-- fix iaddn sign issue (#216)
-
-5.0.0 / 2019-07-04
-------------------
-
-- travis: update node versions (#205)
-- Refactor buffer constructor (#200)
-- lib: fix for negative numbers: imuln, modrn, idivn (#185)
-- bn: fix Red#imod (#178)
-- check unexpected high bits for invalid characters (#173)
-- document support very large integers (#158)
-- only define toBuffer if Buffer is defined (#172)
-- lib: better validation of string input (#151)
-- tests: reject decimal input in constructor (#91)
-- bn: make .strip() an internal method (#105)
-- lib: deprecate `.modn()` introduce `.modrn()`  (#112 #129 #130)
-- bn: don't accept invalid characters (#141)
-- package: use `files` insteadof `.npmignore`  (#152)
-- bn: improve allocation speed for buffers (#167)
-- toJSON to default to interoperable hex (length % 2) (#164)