tornado-packages/ethers.js
1
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added safe operations to FixedNumber.

Browse Source
This commit is contained in:
Richard Moore 2022-11-30 13:46:26 -05:00
parent f5281a0342
commit 7c0b5020f6
5 changed files with 507 additions and 368 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src.ts/ethers.ts
View File

@ -87,7 +87,7 @@ export {
makeError, makeError,
isCallException, isError, isCallException, isError,
FetchRequest, FetchResponse, FetchCancelSignal, FetchRequest, FetchResponse, FetchCancelSignal,
FixedFormat, FixedNumber, formatFixed, parseFixed, FixedNumber,
getBigInt, getNumber, toArray, toBigInt, toHex, toNumber, toQuantity, getBigInt, getNumber, toArray, toBigInt, toHex, toNumber, toQuantity,
fromTwos, toTwos, mask, fromTwos, toTwos, mask,
formatEther, parseEther, formatUnits, parseUnits, formatEther, parseEther, formatUnits, parseUnits,
@ -149,6 +149,7 @@ export type {
BytesLike, BytesLike,
BigNumberish, Numeric, BigNumberish, Numeric,
ErrorCode, ErrorCode,
FixedFormat,
Utf8ErrorFunc, UnicodeNormalizationForm, Utf8ErrorReason, Utf8ErrorFunc, UnicodeNormalizationForm, Utf8ErrorReason,
RlpStructuredData, RlpStructuredData,

822
src.ts/utils/fixednumber.ts
View File

@ -5,172 +5,39 @@
*/ */
import { getBytes } from "./data.js"; import { getBytes } from "./data.js";
import { assert, assertArgument, assertPrivate } from "./errors.js"; import { assert, assertArgument, assertPrivate } from "./errors.js";
import { getBigInt, getNumber, fromTwos, toBigInt, toHex, toTwos } from "./maths.js"; import {
getBigInt, fromTwos, mask, toBigInt, toHex, toTwos
} from "./maths.js";
import { defineProperties } from "./properties.js";
import type { BigNumberish, BytesLike, Numeric } from "./index.js"; import type { BigNumberish, BytesLike } from "./index.js";
if (0) {
console.log(getBytes, toBigInt, toHex, toTwos);
}
const BN_N1 = BigInt(-1);
const BN_0 = BigInt(0);
const BN_1 = BigInt(1);
const BN_5 = BigInt(5);
const _guard = { }; const _guard = { };
const NegativeOne = BigInt(-1);
function throwFault(message: string, fault: string, operation: string, value?: any): never {
const params: any = { fault: fault, operation: operation };
if (value !== undefined) { params.value = value; }
assert(false, message, "NUMERIC_FAULT", params);
}
// Constant to pull zeros from for multipliers // Constant to pull zeros from for multipliers
let zeros = "0"; let Zeros = "0000";
while (zeros.length < 256) { zeros += zeros; } while (Zeros.length < 80) { Zeros += Zeros; }
// Returns a string "1" followed by decimal "0"s // Returns a string "1" followed by decimal "0"s
function getMultiplier(decimals: number): bigint { function getTens(decimals: number): bigint {
let result = Zeros;
assertArgument(Number.isInteger(decimals) && decimals >= 0 && decimals <= 256, while (result.length < decimals) { result += result; }
"invalid decimal length", "decimals", decimals); return BigInt("1" + result.substring(0, decimals));
return BigInt("1" + zeros.substring(0, decimals));
} }
/**
* Returns the fixed-point string representation of %%value%% to
* divided by %%decimal%% places.
*
* @param {Numeric = 18} decimals
*/
export function formatFixed(_value: BigNumberish, _decimals?: Numeric): string {
if (_decimals == null) { _decimals = 18; }
let value = getBigInt(_value, "value");
const decimals = getNumber(_decimals, "decimals");
const multiplier = getMultiplier(decimals); /*
const multiplierStr = String(multiplier);
const negative = (value < 0);
if (negative) { value *= NegativeOne; }
let fraction = String(value % multiplier);
// Make sure there are enough place-holders
while (fraction.length < multiplierStr.length - 1) { fraction = "0" + fraction; }
// Strip training 0
while (fraction.length > 1 && fraction.substring(fraction.length - 1) === "0") {
fraction = fraction.substring(0, fraction.length - 1);
}
let result = String(value / multiplier);
if (multiplierStr.length !== 1) { result += "." + fraction; }
if (negative) { result = "-" + result; }
return result;
}
/**
* Returns the value of %%value%% multiplied by %%decimal%% places.
*
* @param {Numeric = 18} decimals
*/
export function parseFixed(str: string, _decimals: Numeric): bigint {
if (_decimals == null) { _decimals = 18; }
const decimals = getNumber(_decimals, "decimals");
const multiplier = getMultiplier(decimals);
assertArgument(typeof(str) === "string" && str.match(/^-?[0-9.]+$/),
"invalid decimal value", "str", str);
// Is it negative?
const negative = (str.substring(0, 1) === "-");
if (negative) { str = str.substring(1); }
assertArgument(str !== ".", "missing value", "str", str);
// Split it into a whole and fractional part
const comps = str.split(".");
assertArgument(comps.length <= 2, "too many decimal points", "str", str);
let whole = (comps[0] || "0"), fraction = (comps[1] || "0");
// Trim trialing zeros
while (fraction[fraction.length - 1] === "0") {
fraction = fraction.substring(0, fraction.length - 1);
}
// Check the fraction doesn't exceed our decimals size
if (fraction.length > String(multiplier).length - 1) {
throwFault("fractional component exceeds decimals", "underflow", "parseFixed");
}
// If decimals is 0, we have an empty string for fraction
if (fraction === "") { fraction = "0"; }
// Fully pad the string with zeros to get to wei
while (fraction.length < String(multiplier).length - 1) { fraction += "0"; }
const wholeValue = BigInt(whole);
const fractionValue = BigInt(fraction);
let wei = (wholeValue * multiplier) + fractionValue;
if (negative) { wei *= NegativeOne; }
return wei;
}
/**
* A FixedFormat encapsulates the properties required to describe
* a fixed-point arithmetic field.
*/
export class FixedFormat {
/**
* If true, negative values are permitted, otherwise only
* positive values and zero are allowed.
*/
readonly signed: boolean;
/**
* The number of bits available to store the value in the
* fixed-point arithmetic field.
*/
readonly width: number;
/**
* The number of decimal places in the fixed-point arithment field.
*/
readonly decimals: number;
/**
* A human-readable representation of the fixed-point arithmetic field.
*/
readonly name: string;
/**
* @private
*/
readonly _multiplier: bigint;
/**
* @private
*/
constructor(guard: any, signed: boolean, width: number, decimals: number) {
assertPrivate(guard, _guard, "FixedFormat");
this.signed = signed;
this.width = width;
this.decimals = decimals;
this.name = (signed ? "": "u") + "fixed" + String(width) + "x" + String(decimals);
this._multiplier = getMultiplier(decimals);
Object.freeze(this);
}
/**
* Returns a new FixedFormat for %%value%%. * Returns a new FixedFormat for %%value%%.
* *
* If %%value%% is specified as a ``number``, the bit-width is * If %%value%% is specified as a ``number``, the bit-width is
@ -189,130 +56,424 @@ export class FixedFormat {
* If %%value%% is an other object, its properties for ``signed``, * If %%value%% is an other object, its properties for ``signed``,
* ``width`` and ``decimals`` are checked. * ``width`` and ``decimals`` are checked.
*/ */
static from(value: any): FixedFormat {
if (value instanceof FixedFormat) { return value; }
if (typeof(value) === "number") { /**
value = `fixed128x${value}` * A description of a fixed-point arithmetic field.
*
* When specifying the fixed format, the values override the default of
* a ``fixed128x18``, which implies a signed 128-bit value with 18
* decimals of precision.
*
* The alias ``fixed`` and ``ufixed`` can be used for ``fixed128x18`` and
* ``ufixed128x18`` respectively.
*
* When a fixed format string begins with a ``u``, it indicates the field
* is unsigned, so any negative values will overflow. The first number
* indicates the bit-width and the second number indicates the decimal
* precision.
*
* When a ``number`` is used for a fixed format, it indicates the number
* of decimal places, and the default width and signed-ness will be used.
*
* The bit-width must be byte aligned and the decimals can be at most 80.
*/
export type FixedFormat = number | string | {
signed?: boolean,
width?: number,
decimals?: number
};
function checkValue(val: bigint, format: _FixedFormat, safeOp?: string): bigint {
const width = BigInt(format.width);
if (format.signed) {
const limit = (BN_1 << (width - BN_1));
assert(safeOp == null || (val >= -limit && val < limit), "overflow", "NUMERIC_FAULT", {
operation: <string>safeOp, fault: "overflow", value: val
});
if (val > BN_0) {
val = fromTwos(mask(val, width), width);
} else {
val = -fromTwos(mask(-val, width), width);
} }
let signed = true; } else {
let width = 128; const limit = (BN_1 << width);
let decimals = 18; assert(safeOp == null || (val >= 0 && val < limit), "overflow", "NUMERIC_FAULT", {
operation: <string>safeOp, fault: "overflow", value: val
if (typeof(value) === "string") { });
if (value === "fixed") { val = (((val % limit) + limit) % limit) & (limit - BN_1);
// defaults...
} else if (value === "ufixed") {
signed = false;
} else {
const match = value.match(/^(u?)fixed([0-9]+)x([0-9]+)$/);
assertArgument(match, "invalid fixed format", "format", value);
signed = (match[1] !== "u");
width = parseInt(match[2]);
decimals = parseInt(match[3]);
}
} else if (value) {
const check = (key: string, type: string, defaultValue: any): any => {
if (value[key] == null) { return defaultValue; }
assertArgument(typeof(value[key]) === type,
"invalid fixed format (" + key + " not " + type +")", "format." + key, value[key]);
return value[key];
}
signed = check("signed", "boolean", signed);
width = check("width", "number", width);
decimals = check("decimals", "number", decimals);
}
assertArgument((width % 8) === 0, "invalid fixed format width (not byte aligned)", "format.width", width);
assertArgument(decimals <= 80, "invalid fixed format (decimals too large)", "format.decimals", decimals);
return new FixedFormat(_guard, signed, width, decimals);
} }
return val;
} }
type _FixedFormat = { signed: boolean, width: number, decimals: number, name: string }
function getFormat(value?: FixedFormat): _FixedFormat {
if (typeof(value) === "number") { value = `fixed128x${value}` }
let signed = true;
let width = 128;
let decimals = 18;
if (typeof(value) === "string") {
// Parse the format string
if (value === "fixed") {
// defaults...
} else if (value === "ufixed") {
signed = false;
} else {
const match = value.match(/^(u?)fixed([0-9]+)x([0-9]+)$/);
assertArgument(match, "invalid fixed format", "format", value);
signed = (match[1] !== "u");
width = parseInt(match[2]);
decimals = parseInt(match[3]);
}
} else if (value) {
// Extract the values from the object
const v: any = value;
const check = (key: string, type: string, defaultValue: any): any => {
if (v[key] == null) { return defaultValue; }
assertArgument(typeof(v[key]) === type,
"invalid fixed format (" + key + " not " + type +")", "format." + key, v[key]);
return v[key];
}
signed = check("signed", "boolean", signed);
width = check("width", "number", width);
decimals = check("decimals", "number", decimals);
}
assertArgument((width % 8) === 0, "invalid FixedNumber width (not byte aligned)", "format.width", width);
assertArgument(decimals <= 80, "invalid FixedNumber decimals (too large)", "format.decimals", decimals);
const name = (signed ? "": "u") + "fixed" + String(width) + "x" + String(decimals);
return { signed, width, decimals, name };
}
function toString(val: bigint, decimals: number) {
let negative = "";
if (val < BN_0) {
negative = "-";
val *= BN_N1;
}
let str = val.toString();
// No decimal point for whole values
if (decimals === 0) { return str; }
// Pad out to the whole component
while (str.length < decimals) { str = Zeros + str; }
// Insert the decimal point
const index = str.length - decimals;
str = str.substring(0, index) + "." + str.substring(index);
// Trim the whole component (leaving at least one 0)
while (str[0] === "0" && str[1] !== ".") {
str = str.substring(1);
}
// Trim the decimal component (leaving at least one 0)
while (str[str.length - 1] === "0" && str[str.length - 2] !== ".") {
str = str.substring(0, str.length - 1);
}
return (negative + str);
}
/** /**
* A FixedNumber represents a value over its [[FixedFormat]] * A FixedNumber represents a value over its [[FixedFormat]]
* arithmetic field. * arithmetic field.
* *
* A FixedNumber can be used to perform math, losslessly, on * A FixedNumber can be used to perform math, losslessly, on
* values which have decmial places. * values which have decmial places.
*
* A FixedNumber has a fixed bit-width to store values in, and stores all
* values internally by multiplying the value by 10 raised to the power of
* %%decimals%%.
*
* If operations are performed that cause a value to grow too high (close to
* positive infinity) or too low (close to negative infinity), the value
* is said to //overflow//.
*
* For example, an 8-bit signed value, with 0 decimals may only be within
* the range ``-128`` to ``127``; so ``-128 - 1`` will overflow and become
* ``127``. Likewise, ``127 + 1`` will overflow and become ``-127``.
*
* Many operation have a normal and //unsafe// variant. The normal variant
* will throw a [[NumericFaultError]] on any overflow, while the //unsafe//
* variant will silently allow overflow, corrupting its value value.
*
* If operations are performed that cause a value to become too small
* (close to zero), the value loses precison and is said to //underflow//.
*
* For example, an value with 1 decimal place may store a number as small
* as ``0.1``, but the value of ``0.1 / 2`` is ``0.05``, which cannot fit
* into 1 decimal place, so underflow occurs which means precision is lost
* and the value becomes ``0``.
*
* Some operations have a normal and //signalling// variant. The normal
* variant will silently ignore underflow, while the //signalling// variant
* will thow a [[NumericFaultError]] on underflow.
*/ */
export class FixedNumber { export class FixedNumber {
readonly format: FixedFormat;
/**
* The specific fixed-point arithmetic field for this value.
*/
readonly format!: string;
readonly #format: _FixedFormat;
// The actual value (accounting for decimals)
#val: bigint;
// A base-10 value to multiple values by to maintain the magnitude
readonly #tens: bigint;
/**
* This is a property so console.log shows a human-meaningful value.
*
* @private
*/
readonly _value!: string;
// Use this when changing this file to get some typing info,
// but then switch to any to mask the internal type
//constructor(guard: any, value: bigint, format: _FixedFormat) {
/** /**
* @private * @private
*/ */
readonly _isFixedNumber: boolean; constructor(guard: any, value: bigint, format: any) {
//#hex: string;
#value: string;
/**
* @private
*/
constructor(guard: any, hex: string, value: string, format?: FixedFormat) {
assertPrivate(guard, _guard, "FixedNumber"); assertPrivate(guard, _guard, "FixedNumber");
this.format = FixedFormat.from(format); this.#val = value;
//this.#hex = hex;
this.#value = value;
this._isFixedNumber = true; this.#format = format;
Object.freeze(this); const _value = toString(value, format.decimals);
defineProperties<FixedNumber>(this, { format: format.name, _value });
this.#tens = getTens(format.decimals);
} }
/**
* If true, negative values are permitted, otherwise only
* positive values and zero are allowed.
*/
get signed(): boolean { return this.#format.signed; }
/**
* The number of bits available to store the value.
*/
get width(): number { return this.#format.width; }
/**
* The number of decimal places in the fixed-point arithment field.
*/
get decimals(): number { return this.#format.decimals; }
/**
* The value as an integer, based on the smallest unit the
* [[decimals]] allow.
*/
get value(): bigint { return this.#val; }
#checkFormat(other: FixedNumber): void { #checkFormat(other: FixedNumber): void {
assertArgument(this.format.name === other.format.name, assertArgument(this.format === other.format,
"incompatible format; use fixedNumber.toFormat", "other", other); "incompatible format; use fixedNumber.toFormat", "other", other);
} }
#checkValue(val: bigint, safeOp?: string): FixedNumber {
/*
const width = BigInt(this.width);
if (this.signed) {
const limit = (BN_1 << (width - BN_1));
assert(safeOp == null || (val >= -limit && val < limit), "overflow", "NUMERIC_FAULT", {
operation: <string>safeOp, fault: "overflow", value: val
});
if (val > BN_0) {
val = fromTwos(mask(val, width), width);
} else {
val = -fromTwos(mask(-val, width), width);
}
} else {
const masked = mask(val, width);
assert(safeOp == null || (val >= 0 && val === masked), "overflow", "NUMERIC_FAULT", {
operation: <string>safeOp, fault: "overflow", value: val
});
val = masked;
}
*/
val = checkValue(val, this.#format, safeOp);
return new FixedNumber(_guard, val, this.#format);
}
#add(o: FixedNumber, safeOp?: string): FixedNumber {
this.#checkFormat(o);
return this.#checkValue(this.#val + o.#val, safeOp);
}
/** /**
* Returns a new [[FixedNumber]] with the result of %%this%% added * Returns a new [[FixedNumber]] with the result of %%this%% added
* to %%other%%. * to %%other%%, ignoring overflow.
*/ */
addUnsafe(other: FixedNumber): FixedNumber { addUnsafe(other: FixedNumber): FixedNumber { return this.#add(other); }
this.#checkFormat(other);
const a = parseFixed(this.#value, this.format.decimals); /**
const b = parseFixed(other.#value, other.format.decimals); * Returns a new [[FixedNumber]] with the result of %%this%% added
return FixedNumber.fromValue(a + b, this.format.decimals, this.format); * to %%other%%. A [[NumericFaultError]] is thrown if overflow
* occurs.
*/
add(other: FixedNumber): FixedNumber { return this.#add(other, "add"); }
#sub(o: FixedNumber, safeOp?: string): FixedNumber {
this.#checkFormat(o);
return this.#checkValue(this.#val - o.#val, safeOp);
} }
/** /**
* Returns a new [[FixedNumber]] with the result of %%other%% subtracted * Returns a new [[FixedNumber]] with the result of %%other%% subtracted
* %%this%%. * from %%this%%, ignoring overflow.
*/ */
subUnsafe(other: FixedNumber): FixedNumber { subUnsafe(other: FixedNumber): FixedNumber { return this.#sub(other); }
this.#checkFormat(other);
const a = parseFixed(this.#value, this.format.decimals); /**
const b = parseFixed(other.#value, other.format.decimals); * Returns a new [[FixedNumber]] with the result of %%other%% subtracted
return FixedNumber.fromValue(a - b, this.format.decimals, this.format); * from %%this%%. A [[NumericFaultError]] is thrown if overflow
* occurs.
*/
sub(other: FixedNumber): FixedNumber { return this.#sub(other, "sub"); }
#mul(o: FixedNumber, safeOp?: string): FixedNumber {
this.#checkFormat(o);
return this.#checkValue((this.#val * o.#val) / this.#tens, safeOp);
} }
/** /**
* Returns a new [[FixedNumber]] with the result of %%this%% multiplied * Returns a new [[FixedNumber]] with the result of %%this%% multiplied
* by %%other%%. * by %%other%%, ignoring overflow and underflow (precision loss).
*/ */
mulUnsafe(other: FixedNumber): FixedNumber { mulUnsafe(other: FixedNumber): FixedNumber { return this.#mul(other); }
/**
* Returns a new [[FixedNumber]] with the result of %%this%% multiplied
* by %%other%%. A [[NumericFaultError]] is thrown if overflow
* occurs.
*/
mul(other: FixedNumber): FixedNumber { return this.#mul(other, "mul"); }
/**
* Returns a new [[FixedNumber]] with the result of %%this%% multiplied
* by %%other%%. A [[NumericFaultError]] is thrown if overflow
* occurs or if underflow (precision loss) occurs.
*/
mulSignal(other: FixedNumber): FixedNumber {
this.#checkFormat(other); this.#checkFormat(other);
const a = parseFixed(this.#value, this.format.decimals); const value = this.#val * other.#val;
const b = parseFixed(other.#value, other.format.decimals); assert((value % this.#tens) === BN_0, "precision lost during signalling mul", "NUMERIC_FAULT", {
return FixedNumber.fromValue((a * b) / this.format._multiplier, this.format.decimals, this.format); operation: "mulSignal", fault: "underflow", value: this
});
return this.#checkValue(value / this.#tens, "mulSignal");
}
#div(o: FixedNumber, safeOp?: string): FixedNumber {
assert(o.#val !== BN_0, "division by zero", "NUMERIC_FAULT", {
operation: "div", fault: "divide-by-zero", value: this
});
this.#checkFormat(o);
return this.#checkValue((this.#val * this.#tens) / o.#val, safeOp);
} }
/** /**
* Returns a new [[FixedNumber]] with the result of %%this%% divided * Returns a new [[FixedNumber]] with the result of %%this%% divided
* by %%other%%. * by %%other%%, ignoring underflow (precision loss). A
* [[NumericFaultError]] is thrown if overflow occurs.
*/ */
divUnsafe(other: FixedNumber): FixedNumber { divUnsafe(other: FixedNumber): FixedNumber { return this.#div(other); }
/**
* Returns a new [[FixedNumber]] with the result of %%this%% divided
* by %%other%%, ignoring underflow (precision loss). A
* [[NumericFaultError]] is thrown if overflow occurs.
*/
div(other: FixedNumber): FixedNumber { return this.#div(other, "div"); }
/**
* Returns a new [[FixedNumber]] with the result of %%this%% divided
* by %%other%%. A [[NumericFaultError]] is thrown if underflow
* (precision loss) occurs.
*/
divSignal(other: FixedNumber): FixedNumber {
assert(other.#val !== BN_0, "division by zero", "NUMERIC_FAULT", {
operation: "div", fault: "divide-by-zero", value: this
});
this.#checkFormat(other); this.#checkFormat(other);
const a = parseFixed(this.#value, this.format.decimals); const value = (this.#val * this.#tens);
const b = parseFixed(other.#value, other.format.decimals); assert((value % other.#val) === BN_0, "precision lost during signalling div", "NUMERIC_FAULT", {
return FixedNumber.fromValue((a * this.format._multiplier) / b, this.format.decimals, this.format); operation: "divSignal", fault: "underflow", value: this
});
return this.#checkValue(value / other.#val, "divSignal");
} }
/**
* Returns a comparison result between %%this%% and %%other%%.
*
* This is suitable for use in sorting, where ``-1`` implies %%this%%
* is smaller, ``1`` implies %%other%% is larger and ``0`` implies
* both are equal.
*/
cmp(other: FixedNumber): number {
let a = this.value, b = other.value;
// Coerce a and b to the same magnitude
const delta = this.decimals - other.decimals;
if (delta > 0) {
b *= getTens(delta);
} else if (delta < 0) {
a *= getTens(-delta);
}
// Comnpare
if (a < b) { return -1; }
if (a > b) { return -1; }
return 0;
}
/**
* Returns true if %%other%% is equal to %%this%%.
*/
eq(other: FixedNumber): boolean { return this.cmp(other) === 0; }
/**
* Returns true if %%other%% is less than to %%this%%.
*/
lt(other: FixedNumber): boolean { return this.cmp(other) < 0; }
/**
* Returns true if %%other%% is less than or equal to %%this%%.
*/
lte(other: FixedNumber): boolean { return this.cmp(other) <= 0; }
/**
* Returns true if %%other%% is greater than to %%this%%.
*/
gt(other: FixedNumber): boolean { return this.cmp(other) > 0; }
/**
* Returns true if %%other%% is greater than or equal to %%this%%.
*/
gte(other: FixedNumber): boolean { return this.cmp(other) >= 0; }
/** /**
* Returns a new [[FixedNumber]] which is the largest **integer** * Returns a new [[FixedNumber]] which is the largest **integer**
* that is less than or equal to %%this%%. * that is less than or equal to %%this%%.
@ -320,17 +481,10 @@ export class FixedNumber {
* The decimal component of the result will always be ``0``. * The decimal component of the result will always be ``0``.
*/ */
floor(): FixedNumber { floor(): FixedNumber {
const comps = this.toString().split("."); let val = this.#val;
if (comps.length === 1) { comps.push("0"); } if (this.#val < BN_0) { val -= this.#tens - BN_1; }
val = (this.#val / this.#tens) * this.#tens;
let result = FixedNumber.from(comps[0], this.format); return this.#checkValue(val, "floor");
const hasFraction = !comps[1].match(/^(0*)$/);
if (this.isNegative() && hasFraction) {
result = result.subUnsafe(ONE.toFormat(result.format));
}
return result;
} }
/** /**
@ -340,77 +494,48 @@ export class FixedNumber {
* The decimal component of the result will always be ``0``. * The decimal component of the result will always be ``0``.
*/ */
ceiling(): FixedNumber { ceiling(): FixedNumber {
const comps = this.toString().split("."); let val = this.#val;
if (comps.length === 1) { comps.push("0"); } if (this.#val > BN_0) { val += this.#tens - BN_1; }
val = (this.#val / this.#tens) * this.#tens;
let result = FixedNumber.from(comps[0], this.format); return this.#checkValue(val, "ceiling");
const hasFraction = !comps[1].match(/^(0*)$/);
if (!this.isNegative() && hasFraction) {
result = result.addUnsafe(ONE.toFormat(result.format));
}
return result;
} }
/** /**
* Returns a new [[FixedNumber]] with the decimal component * Returns a new [[FixedNumber]] with the decimal component
* rounded up on ties. * rounded up on ties at %%decimals%% places.
*
* The decimal component of the result will always be ``0``.
*
* @param {number = 0} decimals
*/ */
round(decimals?: number): FixedNumber { round(decimals?: number): FixedNumber {
if (decimals == null) { decimals = 0; } if (decimals == null) { decimals = 0; }
// If we are already in range, we're done // Not enough precision to not already be rounded
const comps = this.toString().split("."); if (decimals >= this.decimals) { return this; }
if (comps.length === 1) { comps.push("0"); }
assertArgument(Number.isInteger(decimals) && decimals >= 0 && decimals <= 80, const delta = this.decimals - decimals;
"invalid decimal count", "decimals", decimals); const bump = BN_5 * getTens(delta - 1);
if (comps[1].length <= decimals) { return this; } let value = this.value + bump;
const tens = getTens(delta);
value = (value / tens) * tens;
const factor = FixedNumber.from("1" + zeros.substring(0, decimals), this.format); checkValue(value, this.#format, "round");
const bump = BUMP.toFormat(this.format);
return this.mulUnsafe(factor).addUnsafe(bump).floor().divUnsafe(factor); return new FixedNumber(_guard, value, this.#format);
} }
/** /**
* Returns true if %%this%% is equal to ``0``. * Returns true if %%this%% is equal to ``0``.
*/ */
isZero(): boolean { isZero(): boolean { return (this.#val === BN_0); }
return (this.#value === "0.0" || this.#value === "0");
}
/** /**
* Returns true if %%this%% is less than ``0``. * Returns true if %%this%% is less than ``0``.
*/ */
isNegative(): boolean { isNegative(): boolean { return (this.#val < BN_0); }
return (this.#value[0] === "-");
}
/** /**
* Returns the string representation of %%this%%. * Returns the string representation of %%this%%.
*/ */
toString(): string { return this.#value; } toString(): string { return this._value; }
toHexString(_width: Numeric): string {
throw new Error("TODO");
/*
return toHex();
if (width == null) { return this.#hex; }
const width = logger.getNumeric(_width);
if (width % 8) { logger.throwArgumentError("invalid byte width", "width", width); }
const hex = BigNumber.from(this.#hex).fromTwos(this.format.width).toTwos(width).toHexString();
return zeroPadLeft(hex, width / 8);
*/
}
/** /**
* Returns a float approximation. * Returns a float approximation.
@ -427,102 +552,91 @@ export class FixedNumber {
* *
* This will throw if the value cannot fit into %%format%%. * This will throw if the value cannot fit into %%format%%.
*/ */
toFormat(format: FixedFormat | string): FixedNumber { toFormat(format: FixedFormat): FixedNumber {
return FixedNumber.fromString(this.#value, format); return FixedNumber.fromString(this.toString(), format);
} }
/** /**
* Creates a new [[FixedNumber]] for %%value%% multiplied by * Creates a new [[FixedNumber]] for %%value%% divided by
* %%decimal%% places with %%format%%. * %%decimal%% places with %%format%%.
* *
* @param {number = 0} decimals * This will throw a [[NumericFaultError]] if %%value%% (once adjusted
* @param {FixedFormat | string | number = "fixed"} format * for %%decimals%%) cannot fit in %%format%%, either due to overflow
* or underflow (precision loss).
*/ */
static fromValue(value: BigNumberish, decimals?: number, format?: FixedFormat | string | number): FixedNumber { static fromValue(_value: BigNumberish, decimals?: number, _format?: FixedFormat): FixedNumber {
if (decimals == null) { decimals = 0; } if (decimals == null) { decimals = 0; }
if (format == null) { format = "fixed"; } const format = getFormat(_format);
return FixedNumber.fromString(formatFixed(value, decimals), FixedFormat.from(format));
let value = getBigInt(_value, "value");
const delta = decimals - format.decimals;
if (delta > 0) {
const tens = getTens(delta);
assert((value % tens) === BN_0, "value loses precision for format", "NUMERIC_FAULT", {
operation: "fromValue", fault: "underflow", value: _value
});
value /= tens;
} else if (delta < 0) {
value *= getTens(-delta);
}
checkValue(value, format, "fromValue");
return new FixedNumber(_guard, value, format);
} }
/** /**
* Creates a new [[FixedNumber]] for %%value%% with %%format%%. * Creates a new [[FixedNumber]] for %%value%% with %%format%%.
* *
* @param {FixedFormat | string | number = "fixed"} format * This will throw a [[NumericFaultError]] if %%value%% cannot fit
* in %%format%%, either due to overflow or underflow (precision loss).
*/ */
static fromString(value: string, format?: FixedFormat | string | number): FixedNumber { static fromString(_value: string, _format?: FixedFormat): FixedNumber {
if (format == null) { format = "fixed"; } const match = _value.match(/^(-?)([0-9]*)\.?([0-9]*)$/);
const fixedFormat = FixedFormat.from(format); assertArgument(match && (match[2].length + match[3].length) > 0, "invalid FixedNumber string value", "value", _value);
const numeric = parseFixed(value, fixedFormat.decimals);
if (!fixedFormat.signed && numeric < 0) { const format = getFormat(_format);
throwFault("unsigned value cannot be negative", "overflow", "value", value);
}
const hex = (function() { let whole = (match[2] || "0"), decimal = (match[3] || "");
if (fixedFormat.signed) {
return toHex(toTwos(numeric, fixedFormat.width));
}
return toHex(numeric, fixedFormat.width / 8);
})();
const decimal = formatFixed(numeric, fixedFormat.decimals); // Pad out the decimals
while (decimal.length < format.decimals) { decimal += Zeros; }
return new FixedNumber(_guard, hex, decimal, fixedFormat); // Check precision is safe
assert(decimal.substring(format.decimals).match(/^0*$/), "too many decimals for format", "NUMERIC_FAULT", {
operation: "fromString", fault: "underflow", value: _value
});
// Remove extra padding
decimal = decimal.substring(0, format.decimals);
const value = BigInt(match[1] + whole + decimal)
checkValue(value, format, "fromString");
return new FixedNumber(_guard, value, format);
} }
/** /**
* Creates a new [[FixedNumber]] with the big-endian representation * Creates a new [[FixedNumber]] with the big-endian representation
* %%value%% with %%format%%. * %%value%% with %%format%%.
*
* This will throw a [[NumericFaultError]] if %%value%% cannot fit
* in %%format%% due to overflow.
*/ */
static fromBytes(_value: BytesLike, format?: FixedFormat | string | number): FixedNumber { static fromBytes(_value: BytesLike, _format?: FixedFormat): FixedNumber {
if (format == null) { format = "fixed"; } let value = toBigInt(getBytes(_value, "value"));
const value = getBytes(_value, "value"); const format = getFormat(_format);
const fixedFormat = FixedFormat.from(format);
if (value.length > fixedFormat.width / 8) { if (format.signed) { value = fromTwos(value, format.width); }
throw new Error("overflow");
}
let numeric = toBigInt(value); checkValue(value, format, "fromBytes");
if (fixedFormat.signed) { numeric = fromTwos(numeric, fixedFormat.width); }
const hex = toHex(toTwos(numeric, (fixedFormat.signed ? 0: 1) + fixedFormat.width)); return new FixedNumber(_guard, value, format);
const decimal = formatFixed(numeric, fixedFormat.decimals);
return new FixedNumber(_guard, hex, decimal, fixedFormat);
}
/**
* Creates a new [[FixedNumber]].
*/
static from(value: any, format?: FixedFormat | string | number): FixedNumber {
if (typeof(value) === "string") {
return FixedNumber.fromString(value, format);
}
if (value instanceof Uint8Array) {
return FixedNumber.fromBytes(value, format);
}
try {
return FixedNumber.fromValue(value, 0, format);
} catch (error: any) {
// Allow NUMERIC_FAULT to bubble up
if (error.code !== "INVALID_ARGUMENT") {
throw error;
}
}
assertArgument(false, "invalid FixedNumber value", "value", value);
}
/**
* Returns true if %%value%% is a [[FixedNumber]].
*/
static isFixedNumber(value: any): value is FixedNumber {
return !!(value && value._isFixedNumber);
} }
} }
const ONE = FixedNumber.from(1); //const f1 = FixedNumber.fromString("12.56", "fixed16x2");
const BUMP = FixedNumber.from("0.5"); //const f2 = FixedNumber.fromString("0.3", "fixed16x2");
//console.log(f1.divSignal(f2));
//const BUMP = FixedNumber.from("0.5");

6
src.ts/utils/index.ts
View File

@ -26,7 +26,7 @@ export {
FetchRequest, FetchResponse, FetchCancelSignal, FetchRequest, FetchResponse, FetchCancelSignal,
} from "./fetch.js"; } from "./fetch.js";
export { FixedFormat, FixedNumber, formatFixed, parseFixed } from "./fixednumber.js" export { FixedNumber } from "./fixednumber.js"
export { export {
fromTwos, toTwos, mask, fromTwos, toTwos, mask,
@ -82,7 +82,9 @@ export type {
FetchGatewayFunc, FetchGetUrlFunc FetchGatewayFunc, FetchGetUrlFunc
} from "./fetch.js"; } from "./fetch.js";
export { BigNumberish, Numeric } from "./maths.js"; export type { FixedFormat } from "./fixednumber.js"
export type { BigNumberish, Numeric } from "./maths.js";
export type { RlpStructuredData } from "./rlp.js"; export type { RlpStructuredData } from "./rlp.js";

26
src.ts/utils/maths.ts
View File

@ -4,7 +4,7 @@
* @_subsection: api/utils:Math Helpers [maths] * @_subsection: api/utils:Math Helpers [maths]
*/ */
import { hexlify, isBytesLike } from "./data.js"; import { hexlify, isBytesLike } from "./data.js";
import { assertArgument } from "./errors.js"; import { assert, assertArgument } from "./errors.js";
import type { BytesLike } from "./data.js"; import type { BytesLike } from "./data.js";
@ -35,6 +35,11 @@ export function fromTwos(_value: BigNumberish, _width: Numeric): bigint {
const value = getBigInt(_value, "value"); const value = getBigInt(_value, "value");
const width = BigInt(getNumber(_width, "width")); const width = BigInt(getNumber(_width, "width"));
assertArgument(value >= BN_0, "invalid twos complement value", "value", value);
assert((value >> width) === BN_0, "overflow", "NUMERIC_FAULT", {
operation: "fromTwos", fault: "overflow", value: _value
});
// Top bit set; treat as a negative value // Top bit set; treat as a negative value
if (value >> (width - BN_1)) { if (value >> (width - BN_1)) {
const mask = (BN_1 << width) - BN_1; const mask = (BN_1 << width) - BN_1;
@ -51,14 +56,23 @@ export function fromTwos(_value: BigNumberish, _width: Numeric): bigint {
* The result will always be positive. * The result will always be positive.
*/ */
export function toTwos(_value: BigNumberish, _width: Numeric): bigint { export function toTwos(_value: BigNumberish, _width: Numeric): bigint {
const value = getBigInt(_value, "value"); let value = getBigInt(_value, "value");
const width = BigInt(getNumber(_width, "width")); const width = BigInt(getNumber(_width, "width"));
if (value < BN_0) { const limit = (BN_1 << (width - BN_1));
const mask = (BN_1 << width) - BN_1;
return ((~(-value)) & mask) + BN_1;
}
if (value < BN_0) {
value = -value;
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 {
assert(value < limit, "too high", "NUMERIC_FAULT", {
operation: "toTwos", fault: "overflow", value: _value
});
}
return value; return value;
} }

18
src.ts/utils/units.ts
View File

@ -19,8 +19,9 @@
* *
* @_subsection api/utils:Unit Conversion [units] * @_subsection api/utils:Unit Conversion [units]
*/ */
import { formatFixed, parseFixed } from "./fixednumber.js";
import { assertArgument } from "./errors.js"; import { assertArgument } from "./errors.js";
import { FixedNumber } from "./fixednumber.js";
import { getNumber } from "./maths.js";
import type { BigNumberish, Numeric } from "../utils/index.js"; import type { BigNumberish, Numeric } from "../utils/index.js";
@ -42,12 +43,16 @@ const names = [
* *
*/ */
export function formatUnits(value: BigNumberish, unit?: string | Numeric): string { export function formatUnits(value: BigNumberish, unit?: string | Numeric): string {
let decimals = 18;
if (typeof(unit) === "string") { if (typeof(unit) === "string") {
const index = names.indexOf(unit); const index = names.indexOf(unit);
assertArgument(index >= 0, "invalid unit", "unit", unit); assertArgument(index >= 0, "invalid unit", "unit", unit);
unit = 3 * index; decimals = 3 * index;
} else if (unit != null) {
decimals = getNumber(unit, "unit");
} }
return formatFixed(value, (unit != null) ? unit: 18);
return FixedNumber.fromValue(value, decimals, "fixed256x80").toString();
} }
/** /**
@ -58,13 +63,16 @@ export function formatUnits(value: BigNumberish, unit?: string | Numeric): strin
export function parseUnits(value: string, unit?: string | Numeric): bigint { export function parseUnits(value: string, unit?: string | Numeric): bigint {
assertArgument(typeof(value) === "string", "value must be a string", "value", value); assertArgument(typeof(value) === "string", "value must be a string", "value", value);
let decimals = 18;
if (typeof(unit) === "string") { if (typeof(unit) === "string") {
const index = names.indexOf(unit); const index = names.indexOf(unit);
assertArgument(index >= 0, "invalid unit", "unit", unit); assertArgument(index >= 0, "invalid unit", "unit", unit);
unit = 3 * index; decimals = 3 * index;
} else if (unit != null) {
decimals = getNumber(unit, "unit");
} }
return parseFixed(value, (unit != null) ? unit: 18); return FixedNumber.fromString(value, { decimals }).value;
} }
/** /**