ox 0.0.1 → 0.1.0

package/_esm/ValidatorData.js

@@ -0,0 +1,52 @@
+import * as Hash from './Hash.js';
+import * as Hex from './Hex.js';
+/**
+ * Encodes data with a validator in [ERC-191 format](https://eips.ethereum.org/EIPS/eip-191#version-0x00): `0x19 ‖ 0x00 ‖ <intended validator address> ‖ <data to sign>`.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Hex, ValidatorData } from 'ox'
+ *
+ * const encoded = ValidatorData.encode({
+ *   data: Hex.fromString('hello world'),
+ *   validator: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045',
+ * })
+ * // @log: '0x1900d8da6bf26964af9d7eed9e03e53415d37aa9604568656c6c6f20776f726c64'
+ * // @log: '0x19 ‖ 0x00 ‖ 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 ‖ "hello world"'
+ * ```
+ *
+ * @param value - The data to encode.
+ * @returns The encoded personal sign message.
+ */
+export function encode(value) {
+    const { data, validator } = value;
+    return Hex.concat(
+    // Validator Data Format: `0x19 ‖ 0x00 ‖ <intended validator address> ‖ <data to sign>`
+    '0x19', '0x00', validator, Hex.from(data));
+}
+/* v8 ignore next */
+encode.parseError = (error) => error;
+/**
+ * Gets the payload to use for signing [ERC-191 formatted](https://eips.ethereum.org/EIPS/eip-191#0x00) data with an intended validator.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Hex, Secp256k1, ValidatorData } from 'ox'
+ *
+ * const payload = ValidatorData.getSignPayload({ // [!code focus]
+ *   data: Hex.fromString('hello world'), // [!code focus]
+ *   validator: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045', // [!code focus]
+ * }) // [!code focus]
+ *
+ * const signature = Secp256k1.sign({ payload, privateKey: '0x...' })
+ * ```
+ *
+ * @param value - The data to get the sign payload for.
+ * @returns The payload to use for signing.
+ */
+export function getSignPayload(value) {
+    return Hash.keccak256(encode(value));
+}
+/* v8 ignore next */
+getSignPayload.parseError = (error) => error;
+//# sourceMappingURL=ValidatorData.js.map

package/_esm/ValidatorData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidatorData.js","sourceRoot":"","sources":["../ValidatorData.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAE/B;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,MAAM,CAAC,KAAmB;IACxC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,KAAK,CAAA;IACjC,OAAO,GAAG,CAAC,MAAM;IACf,uFAAuF;IACvF,MAAM,EACN,MAAM,EACN,SAAS,EACT,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CACf,CAAA;AACH,CAAC;AAcD,oBAAoB;AACpB,MAAM,CAAC,UAAU,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,KAAyB,CAAA;AAEjE;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,cAAc,CAAC,KAA2B;IACxD,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;AACtC,CAAC;AAcD,oBAAoB;AACpB,cAAc,CAAC,UAAU,GAAG,CAAC,KAAc,EAAE,EAAE,CAC7C,KAAiC,CAAA"}

package/_esm/Value.js

@@ -0,0 +1,196 @@
+import * as Errors from './Errors.js';
+/** @see https://ethereum.github.io/yellowpaper/paper.pdf */
+export const exponents = {
+    wei: 0,
+    gwei: 9,
+    szabo: 12,
+    finney: 15,
+    ether: 18,
+};
+/**
+ * Formats a `bigint` Value to its string representation (divided by the given exponent).
+ *
+ * @example
+ * ```ts twoslash
+ * import { Value } from 'ox'
+ *
+ * Value.format(420_000_000_000n, 9)
+ * // @log: '420'
+ * ```
+ *
+ * @param value - The `bigint` Value to format.
+ * @param decimals - The exponent to divide the `bigint` Value by.
+ * @returns The string representation of the Value.
+ */
+export function format(value, decimals = 0) {
+    let display = value.toString();
+    const negative = display.startsWith('-');
+    if (negative)
+        display = display.slice(1);
+    display = display.padStart(decimals, '0');
+    let [integer, fraction] = [
+        display.slice(0, display.length - decimals),
+        display.slice(display.length - decimals),
+    ];
+    fraction = fraction.replace(/(0+)$/, '');
+    return `${negative ? '-' : ''}${integer || '0'}${fraction ? `.${fraction}` : ''}`;
+}
+/* v8 ignore next */
+format.parseError = (error) => error;
+/**
+ * Formats a `bigint` Value (default: wei) to a string representation of Ether.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Value } from 'ox'
+ *
+ * Value.formatEther(1_000_000_000_000_000_000n)
+ * // @log: '1'
+ * ```
+ *
+ * @param wei - The Value to format.
+ * @param unit - The unit to format the Value in. @default 'wei'.
+ * @returns The Ether string representation of the Value.
+ */
+export function formatEther(wei, unit = 'wei') {
+    return format(wei, exponents.ether - exponents[unit]);
+}
+/* v8 ignore next */
+formatEther.parseError = (error) => error;
+/**
+ * Formats a `bigint` Value (default: wei) to a string representation of Gwei.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Value } from 'ox'
+ *
+ * Value.formatGwei(1_000_000_000n)
+ * // @log: '1'
+ * ```
+ *
+ * @param wei - The Value to format.
+ * @param unit - The unit to format the Value in. @default 'wei'.
+ * @returns The Gwei string representation of the Value.
+ */
+export function formatGwei(wei, unit = 'wei') {
+    return format(wei, exponents.gwei - exponents[unit]);
+}
+/* v8 ignore next */
+formatGwei.parseError = (error) => error;
+/**
+ * Parses a `string` representation of a Value to `bigint` (multiplied by the given exponent).
+ *
+ * @example
+ * ```ts twoslash
+ * import { Value } from 'ox'
+ *
+ * Value.from('420', 9)
+ * // @log: 420000000000n
+ * ```
+ *
+ * @param value - The string representation of the Value.
+ * @param decimals - The exponent to multiply the Value by.
+ * @returns The `bigint` representation of the Value.
+ */
+export function from(value, decimals = 0) {
+    if (!/^(-?)([0-9]*)\.?([0-9]*)$/.test(value))
+        throw new InvalidDecimalNumberError({ value });
+    let [integer = '', fraction = '0'] = value.split('.');
+    const negative = integer.startsWith('-');
+    if (negative)
+        integer = integer.slice(1);
+    // trim trailing zeros.
+    fraction = fraction.replace(/(0+)$/, '');
+    // round off if the fraction is larger than the number of decimals.
+    if (decimals === 0) {
+        if (Math.round(Number(`.${fraction}`)) === 1)
+            integer = `${BigInt(integer) + 1n}`;
+        fraction = '';
+    }
+    else if (fraction.length > decimals) {
+        const [left, unit, right] = [
+            fraction.slice(0, decimals - 1),
+            fraction.slice(decimals - 1, decimals),
+            fraction.slice(decimals),
+        ];
+        const rounded = Math.round(Number(`${unit}.${right}`));
+        if (rounded > 9)
+            fraction = `${BigInt(left) + BigInt(1)}0`.padStart(left.length + 1, '0');
+        else
+            fraction = `${left}${rounded}`;
+        if (fraction.length > decimals) {
+            fraction = fraction.slice(1);
+            integer = `${BigInt(integer) + 1n}`;
+        }
+        fraction = fraction.slice(0, decimals);
+    }
+    else {
+        fraction = fraction.padEnd(decimals, '0');
+    }
+    return BigInt(`${negative ? '-' : ''}${integer}${fraction}`);
+}
+/* v8 ignore next */
+from.parseError = (error) => error;
+/**
+ * Parses a string representation of Ether to a `bigint` Value (default: wei).
+ *
+ * @example
+ * ```ts twoslash
+ * import { Value } from 'ox'
+ *
+ * Value.fromEther('420')
+ * // @log: 420000000000000000000n
+ * ```
+ *
+ * @param ether - String representation of Ether.
+ * @param unit - The unit to parse to. @default 'wei'.
+ * @returns A `bigint` Value.
+ */
+export function fromEther(ether, unit = 'wei') {
+    return from(ether, exponents.ether - exponents[unit]);
+}
+/* v8 ignore next */
+fromEther.parseError = (error) => error;
+/**
+ * Parses a string representation of Gwei to a `bigint` Value (default: wei).
+ *
+ * @example
+ * ```ts twoslash
+ * import { Value } from 'ox'
+ *
+ * Value.fromGwei('420')
+ * // @log: 420000000000n
+ * ```
+ *
+ * @param gwei - String representation of Gwei.
+ * @param unit - The unit to parse to. @default 'wei'.
+ * @returns A `bigint` Value.
+ */
+export function fromGwei(gwei, unit = 'wei') {
+    return from(gwei, exponents.gwei - exponents[unit]);
+}
+/* v8 ignore next */
+fromGwei.parseError = (error) => error;
+/**
+ * Thrown when a value is not a valid decimal number.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Value } from 'ox'
+ *
+ * Value.fromEther('123.456.789')
+ * // @error: Value.InvalidDecimalNumberError: Value `123.456.789` is not a valid decimal number.
+ * ```
+ */
+export class InvalidDecimalNumberError extends Errors.BaseError {
+    constructor({ value }) {
+        super(`Value \`${value}\` is not a valid decimal number.`);
+        Object.defineProperty(this, "name", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Value.InvalidDecimalNumberError'
+        });
+    }
+}
+//# sourceMappingURL=Value.js.map

package/_esm/Value.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Value.js","sourceRoot":"","sources":["../Value.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,4DAA4D;AAC5D,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,GAAG,EAAE,CAAC;IACN,IAAI,EAAE,CAAC;IACP,KAAK,EAAE,EAAE;IACT,MAAM,EAAE,EAAE;IACV,KAAK,EAAE,EAAE;CACD,CAAA;AAEV;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,MAAM,CAAC,KAAa,EAAE,QAAQ,GAAG,CAAC;IAChD,IAAI,OAAO,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;IAE9B,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IACxC,IAAI,QAAQ;QAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAExC,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;IAEzC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG;QACxB,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC;QAC3C,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC;KACzC,CAAA;IACD,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IACxC,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,IAAI,GAAG,GAC5C,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,EAC9B,EAAE,CAAA;AACJ,CAAC;AAMD,oBAAoB;AACpB,MAAM,CAAC,UAAU,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,KAAyB,CAAA;AAEjE;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,WAAW,CACzB,GAAW,EACX,OAA4C,KAAK;IAEjD,OAAO,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;AACvD,CAAC;AAMD,oBAAoB;AACpB,WAAW,CAAC,UAAU,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,KAA8B,CAAA;AAE3E;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW,EAAE,OAAc,KAAK;IACzD,OAAO,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;AACtD,CAAC;AAMD,oBAAoB;AACpB,UAAU,CAAC,UAAU,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,KAA6B,CAAA;AAEzE;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,IAAI,CAAC,KAAa,EAAE,QAAQ,GAAG,CAAC;IAC9C,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC;QAC1C,MAAM,IAAI,yBAAyB,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;IAEhD,IAAI,CAAC,OAAO,GAAG,EAAE,EAAE,QAAQ,GAAG,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAErD,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IACxC,IAAI,QAAQ;QAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAExC,uBAAuB;IACvB,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IAExC,mEAAmE;IACnE,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;QACnB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC;YAC1C,OAAO,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAA;QACrC,QAAQ,GAAG,EAAE,CAAA;IACf,CAAC;SAAM,IAAI,QAAQ,CAAC,MAAM,GAAG,QAAQ,EAAE,CAAC;QACtC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG;YAC1B,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,GAAG,CAAC,CAAC;YAC/B,QAAQ,CAAC,KAAK,CAAC,QAAQ,GAAG,CAAC,EAAE,QAAQ,CAAC;YACtC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC;SACzB,CAAA;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAA;QACtD,IAAI,OAAO,GAAG,CAAC;YACb,QAAQ,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;;YACrE,QAAQ,GAAG,GAAG,IAAI,GAAG,OAAO,EAAE,CAAA;QAEnC,IAAI,QAAQ,CAAC,MAAM,GAAG,QAAQ,EAAE,CAAC;YAC/B,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAC5B,OAAO,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAA;QACrC,CAAC;QAED,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA;IACxC,CAAC;SAAM,CAAC;QACN,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;IAC3C,CAAC;IAED,OAAO,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,GAAG,QAAQ,EAAE,CAAC,CAAA;AAC9D,CAAC;AAMD,oBAAoB;AACpB,IAAI,CAAC,UAAU,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,KAAuB,CAAA;AAE7D;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,SAAS,CACvB,KAAa,EACb,OAA4C,KAAK;IAEjD,OAAO,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;AACvD,CAAC;AAMD,oBAAoB;AACpB,SAAS,CAAC,UAAU,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,KAA4B,CAAA;AAEvE;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,OAAc,KAAK;IACxD,OAAO,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;AACrD,CAAC;AAMD,oBAAoB;AACpB,QAAQ,CAAC,UAAU,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,KAA2B,CAAA;AAErE;;;;;;;;;;GAUG;AACH,MAAM,OAAO,yBAA0B,SAAQ,MAAM,CAAC,SAAS;IAE7D,YAAY,EAAE,KAAK,EAAqB;QACtC,KAAK,CAAC,WAAW,KAAK,mCAAmC,CAAC,CAAA;QAF1C;;;;mBAAO,iCAAiC;WAAA;IAG1D,CAAC;CACF"}