229 lines
7.7 KiB
JavaScript
229 lines
7.7 KiB
JavaScript
"use strict";
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
exports.toQuantity = exports.toBeArray = exports.toBeHex = exports.toNumber = exports.getNumber = exports.toBigInt = exports.getUint = exports.getBigInt = exports.mask = exports.toTwos = exports.fromTwos = void 0;
|
|
/**
|
|
* Some mathematic operations.
|
|
*
|
|
* @_subsection: api/utils:Math Helpers [about-maths]
|
|
*/
|
|
const data_js_1 = require("./data.js");
|
|
const errors_js_1 = require("./errors.js");
|
|
const BN_0 = BigInt(0);
|
|
const BN_1 = BigInt(1);
|
|
//const BN_Max256 = (BN_1 << BigInt(256)) - BN_1;
|
|
// IEEE 754 support 53-bits of mantissa
|
|
const maxValue = 0x1fffffffffffff;
|
|
/**
|
|
* Convert %%value%% from a twos-compliment representation of %%width%%
|
|
* bits to its value.
|
|
*
|
|
* If the highest bit is ``1``, the result will be negative.
|
|
*/
|
|
function fromTwos(_value, _width) {
|
|
const value = getUint(_value, "value");
|
|
const width = BigInt(getNumber(_width, "width"));
|
|
(0, errors_js_1.assert)((value >> width) === BN_0, "overflow", "NUMERIC_FAULT", {
|
|
operation: "fromTwos", fault: "overflow", value: _value
|
|
});
|
|
// Top bit set; treat as a negative value
|
|
if (value >> (width - BN_1)) {
|
|
const mask = (BN_1 << width) - BN_1;
|
|
return -(((~value) & mask) + BN_1);
|
|
}
|
|
return value;
|
|
}
|
|
exports.fromTwos = fromTwos;
|
|
/**
|
|
* Convert %%value%% to a twos-compliment representation of
|
|
* %%width%% bits.
|
|
*
|
|
* The result will always be positive.
|
|
*/
|
|
function toTwos(_value, _width) {
|
|
let value = getBigInt(_value, "value");
|
|
const width = BigInt(getNumber(_width, "width"));
|
|
const limit = (BN_1 << (width - BN_1));
|
|
if (value < BN_0) {
|
|
value = -value;
|
|
(0, errors_js_1.assert)(value <= limit, "too low", "NUMERIC_FAULT", {
|
|
operation: "toTwos", fault: "overflow", value: _value
|
|
});
|
|
const mask = (BN_1 << width) - BN_1;
|
|
return ((~value) & mask) + BN_1;
|
|
}
|
|
else {
|
|
(0, errors_js_1.assert)(value < limit, "too high", "NUMERIC_FAULT", {
|
|
operation: "toTwos", fault: "overflow", value: _value
|
|
});
|
|
}
|
|
return value;
|
|
}
|
|
exports.toTwos = toTwos;
|
|
/**
|
|
* Mask %%value%% with a bitmask of %%bits%% ones.
|
|
*/
|
|
function mask(_value, _bits) {
|
|
const value = getUint(_value, "value");
|
|
const bits = BigInt(getNumber(_bits, "bits"));
|
|
return value & ((BN_1 << bits) - BN_1);
|
|
}
|
|
exports.mask = mask;
|
|
/**
|
|
* Gets a BigInt from %%value%%. If it is an invalid value for
|
|
* a BigInt, then an ArgumentError will be thrown for %%name%%.
|
|
*/
|
|
function getBigInt(value, name) {
|
|
switch (typeof (value)) {
|
|
case "bigint": return value;
|
|
case "number":
|
|
(0, errors_js_1.assertArgument)(Number.isInteger(value), "underflow", name || "value", value);
|
|
(0, errors_js_1.assertArgument)(value >= -maxValue && value <= maxValue, "overflow", name || "value", value);
|
|
return BigInt(value);
|
|
case "string":
|
|
try {
|
|
if (value === "") {
|
|
throw new Error("empty string");
|
|
}
|
|
if (value[0] === "-" && value[1] !== "-") {
|
|
return -BigInt(value.substring(1));
|
|
}
|
|
return BigInt(value);
|
|
}
|
|
catch (e) {
|
|
(0, errors_js_1.assertArgument)(false, `invalid BigNumberish string: ${e.message}`, name || "value", value);
|
|
}
|
|
}
|
|
(0, errors_js_1.assertArgument)(false, "invalid BigNumberish value", name || "value", value);
|
|
}
|
|
exports.getBigInt = getBigInt;
|
|
/**
|
|
* Returns %%value%% as a bigint, validating it is valid as a bigint
|
|
* value and that it is positive.
|
|
*/
|
|
function getUint(value, name) {
|
|
const result = getBigInt(value, name);
|
|
(0, errors_js_1.assert)(result >= BN_0, "unsigned value cannot be negative", "NUMERIC_FAULT", {
|
|
fault: "overflow", operation: "getUint", value
|
|
});
|
|
return result;
|
|
}
|
|
exports.getUint = getUint;
|
|
const Nibbles = "0123456789abcdef";
|
|
/*
|
|
* Converts %%value%% to a BigInt. If %%value%% is a Uint8Array, it
|
|
* is treated as Big Endian data.
|
|
*/
|
|
function toBigInt(value) {
|
|
if (value instanceof Uint8Array) {
|
|
let result = "0x0";
|
|
for (const v of value) {
|
|
result += Nibbles[v >> 4];
|
|
result += Nibbles[v & 0x0f];
|
|
}
|
|
return BigInt(result);
|
|
}
|
|
return getBigInt(value);
|
|
}
|
|
exports.toBigInt = toBigInt;
|
|
/**
|
|
* Gets a //number// from %%value%%. If it is an invalid value for
|
|
* a //number//, then an ArgumentError will be thrown for %%name%%.
|
|
*/
|
|
function getNumber(value, name) {
|
|
switch (typeof (value)) {
|
|
case "bigint":
|
|
(0, errors_js_1.assertArgument)(value >= -maxValue && value <= maxValue, "overflow", name || "value", value);
|
|
return Number(value);
|
|
case "number":
|
|
(0, errors_js_1.assertArgument)(Number.isInteger(value), "underflow", name || "value", value);
|
|
(0, errors_js_1.assertArgument)(value >= -maxValue && value <= maxValue, "overflow", name || "value", value);
|
|
return value;
|
|
case "string":
|
|
try {
|
|
if (value === "") {
|
|
throw new Error("empty string");
|
|
}
|
|
return getNumber(BigInt(value), name);
|
|
}
|
|
catch (e) {
|
|
(0, errors_js_1.assertArgument)(false, `invalid numeric string: ${e.message}`, name || "value", value);
|
|
}
|
|
}
|
|
(0, errors_js_1.assertArgument)(false, "invalid numeric value", name || "value", value);
|
|
}
|
|
exports.getNumber = getNumber;
|
|
/**
|
|
* Converts %%value%% to a number. If %%value%% is a Uint8Array, it
|
|
* is treated as Big Endian data. Throws if the value is not safe.
|
|
*/
|
|
function toNumber(value) {
|
|
return getNumber(toBigInt(value));
|
|
}
|
|
exports.toNumber = toNumber;
|
|
/**
|
|
* Converts %%value%% to a Big Endian hexstring, optionally padded to
|
|
* %%width%% bytes.
|
|
*/
|
|
function toBeHex(_value, _width) {
|
|
const value = getUint(_value, "value");
|
|
let result = value.toString(16);
|
|
if (_width == null) {
|
|
// Ensure the value is of even length
|
|
if (result.length % 2) {
|
|
result = "0" + result;
|
|
}
|
|
}
|
|
else {
|
|
const width = getNumber(_width, "width");
|
|
(0, errors_js_1.assert)(width * 2 >= result.length, `value exceeds width (${width} bits)`, "NUMERIC_FAULT", {
|
|
operation: "toBeHex",
|
|
fault: "overflow",
|
|
value: _value
|
|
});
|
|
// Pad the value to the required width
|
|
while (result.length < (width * 2)) {
|
|
result = "0" + result;
|
|
}
|
|
}
|
|
return "0x" + result;
|
|
}
|
|
exports.toBeHex = toBeHex;
|
|
/**
|
|
* Converts %%value%% to a Big Endian Uint8Array.
|
|
*/
|
|
function toBeArray(_value) {
|
|
const value = getUint(_value, "value");
|
|
if (value === BN_0) {
|
|
return new Uint8Array([]);
|
|
}
|
|
let hex = value.toString(16);
|
|
if (hex.length % 2) {
|
|
hex = "0" + hex;
|
|
}
|
|
const result = new Uint8Array(hex.length / 2);
|
|
for (let i = 0; i < result.length; i++) {
|
|
const offset = i * 2;
|
|
result[i] = parseInt(hex.substring(offset, offset + 2), 16);
|
|
}
|
|
return result;
|
|
}
|
|
exports.toBeArray = toBeArray;
|
|
/**
|
|
* Returns a [[HexString]] for %%value%% safe to use as a //Quantity//.
|
|
*
|
|
* A //Quantity// does not have and leading 0 values unless the value is
|
|
* the literal value `0x0`. This is most commonly used for JSSON-RPC
|
|
* numeric values.
|
|
*/
|
|
function toQuantity(value) {
|
|
let result = (0, data_js_1.hexlify)((0, data_js_1.isBytesLike)(value) ? value : toBeArray(value)).substring(2);
|
|
while (result.startsWith("0")) {
|
|
result = result.substring(1);
|
|
}
|
|
if (result === "") {
|
|
result = "0";
|
|
}
|
|
return "0x" + result;
|
|
}
|
|
exports.toQuantity = toQuantity;
|
|
//# sourceMappingURL=maths.js.map
|