bn.js

BigNum на чистом JavaScript

Установить

npm install --save bn.js

Использование

 const BN = require ( 'bn.js' ) ;

var a = new BN ( 'dead' , 16 ) ;
var b = new BN ( '101010' , 2 ) ;

var res = a . add ( b ) ;
console . log ( res . toString ( 10 ) ) ;  // 57047

Примечание . Эта библиотека не поддерживает десятичные дроби.

Спонсоры

Моя работа с открытым исходным кодом поддерживается Scout APM и другими спонсорами.

Обозначения

Префиксы

К инструкциям имеется несколько префиксов, влияющих на их работу. Вот их список в порядке появления в имени функции:

• i — выполнить операцию на месте, сохранив результат в хост-объекте (на котором был вызван метод). Может использоваться, чтобы избежать затрат на распределение номеров.
• u — без знака, игнорируйте знак операндов при выполнении операции или всегда возвращайте положительное значение. Второй случай применим к операциям сокращения, таким как mod() . В таких случаях, если результат будет отрицательным - к результату будет прибавлен модуль, чтобы сделать его положительным.

Постфиксы

• n — аргумент функции должен быть простым числом JavaScript. Десятичные дроби не поддерживаются. Переданное число должно быть меньше 0x4000000 (67_108_864). В противном случае выдается ошибка.
• rn — и аргумент, и возвращаемое значение функции представляют собой простые числа JavaScript. Десятичные дроби не поддерживаются.

Примеры

• a.iadd(b) — выполняет сложение a и b , сохраняя результат a
• a.umod(b) — уменьшает a по модулю b , возвращая положительное значение
• a.iushln(13) — сдвиг битов a на 13

Инструкции

Префиксы/постфиксы заключаются в круглые скобки в конце строки. endian — может быть либо le (с прямым порядком байтов), либо be (с прямым порядком байтов).

Утилиты

• a.clone() — номер клона
• a.toString(base, length) — преобразовать в базовую строку и дополнить нулями
• a.toNumber() — преобразовать в номер Javascript (ограничено 53 битами)
• a.toJSON() — преобразовать в шестнадцатеричную строку, совместимую с JSON (псевдоним toString(16) )
• a.toArray(endian, length) — преобразование в байтовый Array и, при необходимости, заполнение нулями до длины, выбрасывается, если уже превышается
• a.toArrayLike(type, endian, length) — преобразовать в экземпляр type , который должен вести себя как Array
• a.toBuffer(endian, length) — конвертировать в Node.js Buffer (если доступен). length в байтах. Для совместимости с браузером и подобными инструментами используйте вместо этого: a.toArrayLike(Buffer, endian, length)
• a.bitLength() — получить количество занятых битов
• a.zeroBits() — возвращает количество младших последовательных нулевых битов (пример: 1010000 имеет 4 нулевых бита)
• a.byteLength() — возвращает количество занятых байтов
• a.isNeg() — true, если число отрицательное
• a.isEven() - нет комментариев
• a.isOdd() - комментариев нет
• a.isZero() - комментариев нет
• a.cmp(b) — сравнивает числа и возвращает -1 (a < b), 0 (a == b) или 1 (a > b) в зависимости от результата сравнения ( ucmp , cmpn )
• a.lt(b) - a меньше b ( n )
• a.lte(b) - a меньше или равно b ( n )
• a.gt(b) - a больше, чем b ( n )
• a.gte(b) - a больше или равно b ( n )
• a.eq(b) — a равно b ( n )
• a.toTwos(width) — преобразование в представление дополнения до двух, где width — это разрядность.
• a.fromTwos(width) — преобразование из представления дополнения до двух, где width — это разрядность
• BN.isBN(object) — возвращает true, если предоставленный object является экземпляром BN.js.
• BN.max(a, b) — возвращает a если a больше b
• BN.min(a, b) — вернуть a если a меньше b

Арифметика

• a.neg() — знак отрицания ( i )
• a.abs() — абсолютное значение ( i )
• a.add(b) — добавление ( i , n , in )
• a.sub(b) - вычитание ( i , n , in )
• a.mul(b) — умножить ( i , n , in )
• a.sqr() — квадрат ( i )
• a.pow(b) — возвести a в степень b
• a.div(b) - разделить ( divn , idivn )
• a.mod(b) — сокращение ( u , n ) (но без umodn )
• a.divmod(b) - частное и модуль, полученные делением
• a.divRound(b) - округленное деление

Битовые операции

• a.or(b) - или ( i , u , iu )
• a.and(b) - and ( i , u , iu , andln ) (ПРИМЕЧАНИЕ: в будущем andln будет заменено на andn )
• a.xor(b) - xor ( i , u , iu )
• a.setn(b, value) — установить указанный бит в value
• a.shln(b) - сдвиг влево ( i , u , iu )
• a.shrn(b) - сдвиг вправо ( i , u , iu )
• a.testn(b) — проверить, установлен ли указанный бит
• a.maskn(b) — очистить биты с индексами выше или равными b ( i )
• a.bincn(b) — добавить 1 << b к числу
• a.notn(w) - not (для ширины, указанной w ) ( i )

Снижение

• a.gcd(b) — НОД
• a.egcd(b) — расширенные результаты НОД ( { a: ..., b: ..., gcd: ... } )
• a.invm(b) — инверсия a по модулю b

Быстрое сокращение

При выполнении большого количества сокращений с использованием одного и того же модуля может быть полезно использовать некоторые приемы: например, умножение Монтгомери или использование специального алгоритма для простых чисел Мерсенна.

Контекст сокращения

Чтобы использовать этот трюк, необходимо создать контекст сокращения:

 var red = BN . red ( num ) ;

где num — это просто экземпляр BN.

Или:

 var red = BN . red ( primeName ) ;

Где primeName — одно из этих простых чисел Мерсенна:

• 'k256'
• 'p224'
• 'p192'
• 'p25519'

Или:

 var red = BN . mont ( num ) ;

Чтобы уменьшить число с помощью трюка Монтгомери. .mont() обычно быстрее, чем .red(num) , но медленнее, чем BN.red(primeName) .

Преобразование чисел

Прежде чем выполнять что-либо в контексте сокращения, в него следует преобразовать числа. Обычно это означает, что следует:

• Преобразование входов в сокращенные
• Работайте с ними в контексте сокращения
• Преобразование выходных данных обратно из контекста сокращения

Вот как можно преобразовать числа в red :

 var redA = a . toRed ( red ) ;

Где red — это контекст сокращения, созданный с использованием инструкций выше.

Вот как преобразовать их обратно:

 var a = redA . fromRed ( ) ;

Красные инструкции

Большинство инструкций из самого начала этого файла readme имеют аналоги в красном контексте:

• a.redAdd(b) , a.redIAdd(b)
• a.redSub(b) , a.redISub(b)
• a.redShl(num)
• a.redMul(b) , a.redIMul(b)
• a.redSqr() , a.redISqr()
• a.redSqrt() — простое число контекста уменьшения квадратного корня по модулю
• a.redInvm() — модульное обратное число
• a.redNeg()
• a.redPow(b) — модульное возведение в степень

Размер номера

Оптимизирован для эллиптических кривых, работающих с 256-битными числами. Ограничений на размер цифр нет.

ЛИЦЕНЗИЯ

Это программное обеспечение распространяется по лицензии MIT.