ripple-binary-codec 2.0.0-beta.0 → 2.0.0

package/dist/src/types/st-object.js

@@ -0,0 +1,155 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STObject = void 0;
+const enums_1 = require("../enums");
+const serialized_type_1 = require("./serialized-type");
+const ripple_address_codec_1 = require("ripple-address-codec");
+const binary_parser_1 = require("../serdes/binary-parser");
+const binary_serializer_1 = require("../serdes/binary-serializer");
+const st_array_1 = require("./st-array");
+const OBJECT_END_MARKER_BYTE = Uint8Array.from([0xe1]);
+const OBJECT_END_MARKER = 'ObjectEndMarker';
+const ST_OBJECT = 'STObject';
+const DESTINATION = 'Destination';
+const ACCOUNT = 'Account';
+const SOURCE_TAG = 'SourceTag';
+const DEST_TAG = 'DestinationTag';
+/**
+ * Break down an X-Address into an account and a tag
+ *
+ * @param field Name of field
+ * @param xAddress X-Address corresponding to the field
+ */
+function handleXAddress(field, xAddress) {
+    const decoded = (0, ripple_address_codec_1.xAddressToClassicAddress)(xAddress);
+    let tagName;
+    if (field === DESTINATION)
+        tagName = DEST_TAG;
+    else if (field === ACCOUNT)
+        tagName = SOURCE_TAG;
+    else if (decoded.tag !== false)
+        throw new Error(`${field} cannot have an associated tag`);
+    return decoded.tag !== false
+        ? { [field]: decoded.classicAddress, [tagName]: decoded.tag }
+        : { [field]: decoded.classicAddress };
+}
+/**
+ * Validate that two objects don't both have the same tag fields
+ *
+ * @param obj1 First object to check for tags
+ * @param obj2 Second object to check for tags
+ * @throws When both objects have SourceTag or DestinationTag
+ */
+function checkForDuplicateTags(obj1, obj2) {
+    if (!(obj1[SOURCE_TAG] === undefined || obj2[SOURCE_TAG] === undefined))
+        throw new Error('Cannot have Account X-Address and SourceTag');
+    if (!(obj1[DEST_TAG] === undefined || obj2[DEST_TAG] === undefined))
+        throw new Error('Cannot have Destination X-Address and DestinationTag');
+}
+/**
+ * Class for Serializing/Deserializing objects
+ */
+class STObject extends serialized_type_1.SerializedType {
+    /**
+     * Construct a STObject from a BinaryParser
+     *
+     * @param parser BinaryParser to read STObject from
+     * @returns A STObject object
+     */
+    static fromParser(parser) {
+        const list = new binary_serializer_1.BytesList();
+        const bytes = new binary_serializer_1.BinarySerializer(list);
+        while (!parser.end()) {
+            const field = parser.readField();
+            if (field.name === OBJECT_END_MARKER) {
+                break;
+            }
+            const associatedValue = parser.readFieldValue(field);
+            bytes.writeFieldAndValue(field, associatedValue);
+            if (field.type.name === ST_OBJECT) {
+                bytes.put(OBJECT_END_MARKER_BYTE);
+            }
+        }
+        return new STObject(list.toBytes());
+    }
+    /**
+     * Construct a STObject from a JSON object
+     *
+     * @param value An object to include
+     * @param filter optional, denote which field to include in serialized object
+     * @param definitions optional, types and values to use to encode/decode a transaction
+     * @returns a STObject object
+     */
+    static from(value, filter, definitions = enums_1.DEFAULT_DEFINITIONS) {
+        if (value instanceof STObject) {
+            return value;
+        }
+        const list = new binary_serializer_1.BytesList();
+        const bytes = new binary_serializer_1.BinarySerializer(list);
+        let isUnlModify = false;
+        const xAddressDecoded = Object.entries(value).reduce((acc, [key, val]) => {
+            let handled = undefined;
+            if (val && (0, ripple_address_codec_1.isValidXAddress)(val.toString())) {
+                handled = handleXAddress(key, val.toString());
+                checkForDuplicateTags(handled, value);
+            }
+            return Object.assign(acc, handled !== null && handled !== void 0 ? handled : { [key]: val });
+        }, {});
+        let sorted = Object.keys(xAddressDecoded)
+            .map((f) => definitions.field[f])
+            .filter((f) => f !== undefined &&
+            xAddressDecoded[f.name] !== undefined &&
+            f.isSerialized)
+            .sort((a, b) => {
+            return a.ordinal - b.ordinal;
+        });
+        if (filter !== undefined) {
+            sorted = sorted.filter(filter);
+        }
+        sorted.forEach((field) => {
+            const associatedValue = field.type.name === ST_OBJECT
+                ? this.from(xAddressDecoded[field.name], undefined, definitions)
+                : field.type.name === 'STArray'
+                    ? st_array_1.STArray.from(xAddressDecoded[field.name], definitions)
+                    : field.associatedType.from(xAddressDecoded[field.name]);
+            if (associatedValue == undefined) {
+                throw new TypeError(`Unable to interpret "${field.name}: ${xAddressDecoded[field.name]}".`);
+            }
+            if (associatedValue.name === 'UNLModify') {
+                // triggered when the TransactionType field has a value of 'UNLModify'
+                isUnlModify = true;
+            }
+            // true when in the UNLModify pseudotransaction (after the transaction type has been processed) and working with the
+            // Account field
+            // The Account field must not be a part of the UNLModify pseudotransaction encoding, due to a bug in rippled
+            const isUnlModifyWorkaround = field.name == 'Account' && isUnlModify;
+            bytes.writeFieldAndValue(field, associatedValue, isUnlModifyWorkaround);
+            if (field.type.name === ST_OBJECT) {
+                bytes.put(OBJECT_END_MARKER_BYTE);
+            }
+        });
+        return new STObject(list.toBytes());
+    }
+    /**
+     * Get the JSON interpretation of this.bytes
+     * @param definitions rippled definitions used to parse the values of transaction types and such.
+     *                          Can be customized for sidechains and amendments.
+     * @returns a JSON object
+     */
+    toJSON(definitions) {
+        const objectParser = new binary_parser_1.BinaryParser(this.toString(), definitions);
+        const accumulator = {};
+        while (!objectParser.end()) {
+            const field = objectParser.readField();
+            if (field.name === OBJECT_END_MARKER) {
+                break;
+            }
+            accumulator[field.name] = objectParser
+                .readFieldValue(field)
+                .toJSON(definitions);
+        }
+        return accumulator;
+    }
+}
+exports.STObject = STObject;
+//# sourceMappingURL=st-object.js.map

package/dist/src/types/st-object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"st-object.js","sourceRoot":"","sources":["../../../src/types/st-object.ts"],"names":[],"mappings":";;;AAAA,oCAKiB;AACjB,uDAA8D;AAC9D,+DAAgF;AAChF,2DAAsD;AACtD,mEAAyE;AAEzE,yCAAoC;AAEpC,MAAM,sBAAsB,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;AACtD,MAAM,iBAAiB,GAAG,iBAAiB,CAAA;AAC3C,MAAM,SAAS,GAAG,UAAU,CAAA;AAC5B,MAAM,WAAW,GAAG,aAAa,CAAA;AACjC,MAAM,OAAO,GAAG,SAAS,CAAA;AACzB,MAAM,UAAU,GAAG,WAAW,CAAA;AAC9B,MAAM,QAAQ,GAAG,gBAAgB,CAAA;AAEjC;;;;;GAKG;AACH,SAAS,cAAc,CAAC,KAAa,EAAE,QAAgB;IACrD,MAAM,OAAO,GAAG,IAAA,+CAAwB,EAAC,QAAQ,CAAC,CAAA;IAElD,IAAI,OAAO,CAAA;IACX,IAAI,KAAK,KAAK,WAAW;QAAE,OAAO,GAAG,QAAQ,CAAA;SACxC,IAAI,KAAK,KAAK,OAAO;QAAE,OAAO,GAAG,UAAU,CAAA;SAC3C,IAAI,OAAO,CAAC,GAAG,KAAK,KAAK;QAC5B,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,gCAAgC,CAAC,CAAA;IAE3D,OAAO,OAAO,CAAC,GAAG,KAAK,KAAK;QAC1B,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE;QAC7D,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,EAAE,CAAA;AACzC,CAAC;AAED;;;;;;GAMG;AACH,SAAS,qBAAqB,CAAC,IAAgB,EAAE,IAAgB;IAC/D,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,SAAS,CAAC;QACrE,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;IAChE,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC;QACjE,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;AAC3E,CAAC;AAED;;GAEG;AACH,MAAM,QAAS,SAAQ,gCAAc;IACnC;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,MAAM,IAAI,GAAc,IAAI,6BAAS,EAAE,CAAA;QACvC,MAAM,KAAK,GAAqB,IAAI,oCAAgB,CAAC,IAAI,CAAC,CAAA;QAE1D,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE;YACpB,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,EAAE,CAAA;YAChC,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,EAAE;gBACpC,MAAK;aACN;YAED,MAAM,eAAe,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;YAEpD,KAAK,CAAC,kBAAkB,CAAC,KAAK,EAAE,eAAe,CAAC,CAAA;YAChD,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;gBACjC,KAAK,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;aAClC;SACF;QAED,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;IACrC,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,KAAQ,EACR,MAA4B,EAC5B,cAAmC,2BAAmB;QAEtD,IAAI,KAAK,YAAY,QAAQ,EAAE;YAC7B,OAAO,KAAK,CAAA;SACb;QAED,MAAM,IAAI,GAAc,IAAI,6BAAS,EAAE,CAAA;QACvC,MAAM,KAAK,GAAqB,IAAI,oCAAgB,CAAC,IAAI,CAAC,CAAA;QAE1D,IAAI,WAAW,GAAG,KAAK,CAAA;QAEvB,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE;YACvE,IAAI,OAAO,GAA2B,SAAS,CAAA;YAC/C,IAAI,GAAG,IAAI,IAAA,sCAAe,EAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,EAAE;gBAC1C,OAAO,GAAG,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAA;gBAC7C,qBAAqB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;aACtC;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAA;QACtD,CAAC,EAAE,EAAE,CAAC,CAAA;QAEN,IAAI,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC;aACtC,GAAG,CAAC,CAAC,CAAS,EAAiB,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAkB,CAAC;aACxE,MAAM,CACL,CAAC,CAAgB,EAAW,EAAE,CAC5B,CAAC,KAAK,SAAS;YACf,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,SAAS;YACrC,CAAC,CAAC,YAAY,CACjB;aACA,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACb,OAAO,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CAAA;QAC9B,CAAC,CAAC,CAAA;QAEJ,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;SAC/B;QAED,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACvB,MAAM,eAAe,GACnB,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS;gBAC3B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC;gBAChE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS;oBAC/B,CAAC,CAAC,kBAAO,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC;oBACxD,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;YAE5D,IAAI,eAAe,IAAI,SAAS,EAAE;gBAChC,MAAM,IAAI,SAAS,CACjB,wBAAwB,KAAK,CAAC,IAAI,KAChC,eAAe,CAAC,KAAK,CAAC,IAAI,CAC5B,IAAI,CACL,CAAA;aACF;YAED,IAAK,eAAoC,CAAC,IAAI,KAAK,WAAW,EAAE;gBAC9D,sEAAsE;gBACtE,WAAW,GAAG,IAAI,CAAA;aACnB;YACD,oHAAoH;YACpH,gBAAgB;YAChB,4GAA4G;YAC5G,MAAM,qBAAqB,GAAG,KAAK,CAAC,IAAI,IAAI,SAAS,IAAI,WAAW,CAAA;YACpE,KAAK,CAAC,kBAAkB,CAAC,KAAK,EAAE,eAAe,EAAE,qBAAqB,CAAC,CAAA;YACvE,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;gBACjC,KAAK,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;aAClC;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;IACrC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAiC;QACtC,MAAM,YAAY,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,WAAW,CAAC,CAAA;QACnE,MAAM,WAAW,GAAG,EAAE,CAAA;QAEtB,OAAO,CAAC,YAAY,CAAC,GAAG,EAAE,EAAE;YAC1B,MAAM,KAAK,GAAG,YAAY,CAAC,SAAS,EAAE,CAAA;YACtC,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,EAAE;gBACpC,MAAK;aACN;YAED,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,YAAY;iBACnC,cAAc,CAAC,KAAK,CAAC;iBACrB,MAAM,CAAC,WAAW,CAAC,CAAA;SACvB;QAED,OAAO,WAAW,CAAA;IACpB,CAAC;CACF;AAEQ,4BAAQ"}

package/dist/src/types/uint-16.d.ts

@@ -0,0 +1,24 @@
+import { UInt } from './uint';
+import { BinaryParser } from '../serdes/binary-parser';
+/**
+ * Derived UInt class for serializing/deserializing 16 bit UInt
+ */
+declare class UInt16 extends UInt {
+    protected static readonly width: number;
+    static readonly defaultUInt16: UInt16;
+    constructor(bytes: Uint8Array);
+    static fromParser(parser: BinaryParser): UInt;
+    /**
+     * Construct a UInt16 object from a number
+     *
+     * @param val UInt16 object or number
+     */
+    static from<T extends UInt16 | number>(val: T): UInt16;
+    /**
+     * get the value of a UInt16 object
+     *
+     * @returns the number represented by this.bytes
+     */
+    valueOf(): number;
+}
+export { UInt16 };

package/dist/src/types/uint-16.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UInt16 = void 0;
+const uint_1 = require("./uint");
+const utils_1 = require("../utils");
+/**
+ * Derived UInt class for serializing/deserializing 16 bit UInt
+ */
+class UInt16 extends uint_1.UInt {
+    constructor(bytes) {
+        super(bytes !== null && bytes !== void 0 ? bytes : UInt16.defaultUInt16.bytes);
+    }
+    static fromParser(parser) {
+        return new UInt16(parser.read(UInt16.width));
+    }
+    /**
+     * Construct a UInt16 object from a number
+     *
+     * @param val UInt16 object or number
+     */
+    static from(val) {
+        if (val instanceof UInt16) {
+            return val;
+        }
+        if (typeof val === 'number') {
+            UInt16.checkUintRange(val, 0, 0xffff);
+            const buf = new Uint8Array(UInt16.width);
+            (0, utils_1.writeUInt16BE)(buf, val, 0);
+            return new UInt16(buf);
+        }
+        throw new Error('Can not construct UInt16 with given value');
+    }
+    /**
+     * get the value of a UInt16 object
+     *
+     * @returns the number represented by this.bytes
+     */
+    valueOf() {
+        return parseInt((0, utils_1.readUInt16BE)(this.bytes, 0));
+    }
+}
+exports.UInt16 = UInt16;
+UInt16.width = 16 / 8; // 2
+UInt16.defaultUInt16 = new UInt16(new Uint8Array(UInt16.width));
+//# sourceMappingURL=uint-16.js.map

package/dist/src/types/uint-16.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uint-16.js","sourceRoot":"","sources":["../../../src/types/uint-16.ts"],"names":[],"mappings":";;;AAAA,iCAA6B;AAE7B,oCAAsD;AAEtD;;GAEG;AACH,MAAM,MAAO,SAAQ,WAAI;IAMvB,YAAY,KAAiB;QAC3B,KAAK,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;IAC5C,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAC9C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAA4B,GAAM;QAC3C,IAAI,GAAG,YAAY,MAAM,EAAE;YACzB,OAAO,GAAG,CAAA;SACX;QAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC3B,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC,EAAE,MAAM,CAAC,CAAA;YAErC,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;YACxC,IAAA,qBAAa,EAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YAC1B,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,CAAA;SACvB;QAED,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;IAC9D,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,OAAO,QAAQ,CAAC,IAAA,oBAAY,EAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAA;IAC9C,CAAC;;AAGM,wBAAM;AA5Ca,YAAK,GAAW,EAAE,GAAG,CAAC,CAAA,CAAC,IAAI;AACrC,oBAAa,GAAW,IAAI,MAAM,CAChD,IAAI,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAC7B,CAAA"}

package/dist/src/types/uint-32.d.ts

@@ -0,0 +1,24 @@
+import { UInt } from './uint';
+import { BinaryParser } from '../serdes/binary-parser';
+/**
+ * Derived UInt class for serializing/deserializing 32 bit UInt
+ */
+declare class UInt32 extends UInt {
+    protected static readonly width: number;
+    static readonly defaultUInt32: UInt32;
+    constructor(bytes: Uint8Array);
+    static fromParser(parser: BinaryParser): UInt;
+    /**
+     * Construct a UInt32 object from a number
+     *
+     * @param val UInt32 object or number
+     */
+    static from<T extends UInt32 | number | string>(val: T): UInt32;
+    /**
+     * get the value of a UInt32 object
+     *
+     * @returns the number represented by this.bytes
+     */
+    valueOf(): number;
+}
+export { UInt32 };

package/dist/src/types/uint-32.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UInt32 = void 0;
+const uint_1 = require("./uint");
+const utils_1 = require("../utils");
+/**
+ * Derived UInt class for serializing/deserializing 32 bit UInt
+ */
+class UInt32 extends uint_1.UInt {
+    constructor(bytes) {
+        super(bytes !== null && bytes !== void 0 ? bytes : UInt32.defaultUInt32.bytes);
+    }
+    static fromParser(parser) {
+        return new UInt32(parser.read(UInt32.width));
+    }
+    /**
+     * Construct a UInt32 object from a number
+     *
+     * @param val UInt32 object or number
+     */
+    static from(val) {
+        if (val instanceof UInt32) {
+            return val;
+        }
+        const buf = new Uint8Array(UInt32.width);
+        if (typeof val === 'string') {
+            const num = Number.parseInt(val);
+            (0, utils_1.writeUInt32BE)(buf, num, 0);
+            return new UInt32(buf);
+        }
+        if (typeof val === 'number') {
+            UInt32.checkUintRange(val, 0, 0xffffffff);
+            (0, utils_1.writeUInt32BE)(buf, val, 0);
+            return new UInt32(buf);
+        }
+        throw new Error('Cannot construct UInt32 from given value');
+    }
+    /**
+     * get the value of a UInt32 object
+     *
+     * @returns the number represented by this.bytes
+     */
+    valueOf() {
+        return parseInt((0, utils_1.readUInt32BE)(this.bytes, 0), 10);
+    }
+}
+exports.UInt32 = UInt32;
+UInt32.width = 32 / 8; // 4
+UInt32.defaultUInt32 = new UInt32(new Uint8Array(UInt32.width));
+//# sourceMappingURL=uint-32.js.map

package/dist/src/types/uint-32.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uint-32.js","sourceRoot":"","sources":["../../../src/types/uint-32.ts"],"names":[],"mappings":";;;AAAA,iCAA6B;AAE7B,oCAAsD;AAEtD;;GAEG;AACH,MAAM,MAAO,SAAQ,WAAI;IAMvB,YAAY,KAAiB;QAC3B,KAAK,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;IAC5C,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAC9C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAqC,GAAM;QACpD,IAAI,GAAG,YAAY,MAAM,EAAE;YACzB,OAAO,GAAG,CAAA;SACX;QAED,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAExC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC3B,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;YAChC,IAAA,qBAAa,EAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YAC1B,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,CAAA;SACvB;QAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC3B,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC,EAAE,UAAU,CAAC,CAAA;YACzC,IAAA,qBAAa,EAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YAC1B,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,CAAA;SACvB;QAED,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;IAC7D,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,OAAO,QAAQ,CAAC,IAAA,oBAAY,EAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAClD,CAAC;;AAGM,wBAAM;AAlDa,YAAK,GAAW,EAAE,GAAG,CAAC,CAAA,CAAC,IAAI;AACrC,oBAAa,GAAW,IAAI,MAAM,CAChD,IAAI,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAC7B,CAAA"}

package/dist/src/types/uint-64.d.ts

@@ -0,0 +1,37 @@
+import { UInt } from './uint';
+import { BinaryParser } from '../serdes/binary-parser';
+/**
+ * Derived UInt class for serializing/deserializing 64 bit UInt
+ */
+declare class UInt64 extends UInt {
+    protected static readonly width: number;
+    static readonly defaultUInt64: UInt64;
+    constructor(bytes: Uint8Array);
+    static fromParser(parser: BinaryParser): UInt;
+    /**
+     * Construct a UInt64 object
+     *
+     * @param val A UInt64, hex-string, bigInt, or number
+     * @returns A UInt64 object
+     */
+    static from<T extends UInt64 | string | bigint | number>(val: T): UInt64;
+    /**
+     * The JSON representation of a UInt64 object
+     *
+     * @returns a hex-string
+     */
+    toJSON(): string;
+    /**
+     * Get the value of the UInt64
+     *
+     * @returns the number represented buy this.bytes
+     */
+    valueOf(): bigint;
+    /**
+     * Get the bytes representation of the UInt64 object
+     *
+     * @returns 8 bytes representing the UInt64
+     */
+    toBytes(): Uint8Array;
+}
+export { UInt64 };

package/dist/src/types/uint-64.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UInt64 = void 0;
+const uint_1 = require("./uint");
+const utils_1 = require("@xrplf/isomorphic/utils");
+const utils_2 = require("../utils");
+const HEX_REGEX = /^[a-fA-F0-9]{1,16}$/;
+const mask = BigInt(0x00000000ffffffff);
+/**
+ * Derived UInt class for serializing/deserializing 64 bit UInt
+ */
+class UInt64 extends uint_1.UInt {
+    constructor(bytes) {
+        super(bytes !== null && bytes !== void 0 ? bytes : UInt64.defaultUInt64.bytes);
+    }
+    static fromParser(parser) {
+        return new UInt64(parser.read(UInt64.width));
+    }
+    /**
+     * Construct a UInt64 object
+     *
+     * @param val A UInt64, hex-string, bigInt, or number
+     * @returns A UInt64 object
+     */
+    static from(val) {
+        if (val instanceof UInt64) {
+            return val;
+        }
+        let buf = new Uint8Array(UInt64.width);
+        if (typeof val === 'number') {
+            if (val < 0) {
+                throw new Error('value must be an unsigned integer');
+            }
+            const number = BigInt(val);
+            const intBuf = [new Uint8Array(4), new Uint8Array(4)];
+            (0, utils_2.writeUInt32BE)(intBuf[0], Number(number >> BigInt(32)), 0);
+            (0, utils_2.writeUInt32BE)(intBuf[1], Number(number & BigInt(mask)), 0);
+            return new UInt64((0, utils_1.concat)(intBuf));
+        }
+        if (typeof val === 'string') {
+            if (!HEX_REGEX.test(val)) {
+                throw new Error(`${val} is not a valid hex-string`);
+            }
+            const strBuf = val.padStart(16, '0');
+            buf = (0, utils_1.hexToBytes)(strBuf);
+            return new UInt64(buf);
+        }
+        if (typeof val === 'bigint') {
+            const intBuf = [new Uint8Array(4), new Uint8Array(4)];
+            (0, utils_2.writeUInt32BE)(intBuf[0], Number(Number(val >> BigInt(32))), 0);
+            (0, utils_2.writeUInt32BE)(intBuf[1], Number(val & BigInt(mask)), 0);
+            return new UInt64((0, utils_1.concat)(intBuf));
+        }
+        throw new Error('Cannot construct UInt64 from given value');
+    }
+    /**
+     * The JSON representation of a UInt64 object
+     *
+     * @returns a hex-string
+     */
+    toJSON() {
+        return (0, utils_1.bytesToHex)(this.bytes);
+    }
+    /**
+     * Get the value of the UInt64
+     *
+     * @returns the number represented buy this.bytes
+     */
+    valueOf() {
+        const msb = BigInt((0, utils_2.readUInt32BE)(this.bytes.slice(0, 4), 0));
+        const lsb = BigInt((0, utils_2.readUInt32BE)(this.bytes.slice(4), 0));
+        return (msb << BigInt(32)) | lsb;
+    }
+    /**
+     * Get the bytes representation of the UInt64 object
+     *
+     * @returns 8 bytes representing the UInt64
+     */
+    toBytes() {
+        return this.bytes;
+    }
+}
+exports.UInt64 = UInt64;
+UInt64.width = 64 / 8; // 8
+UInt64.defaultUInt64 = new UInt64(new Uint8Array(UInt64.width));
+//# sourceMappingURL=uint-64.js.map

package/dist/src/types/uint-64.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uint-64.js","sourceRoot":"","sources":["../../../src/types/uint-64.ts"],"names":[],"mappings":";;;AAAA,iCAA6B;AAE7B,mDAAwE;AACxE,oCAAsD;AAEtD,MAAM,SAAS,GAAG,qBAAqB,CAAA;AACvC,MAAM,IAAI,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAA;AAEvC;;GAEG;AACH,MAAM,MAAO,SAAQ,WAAI;IAMvB,YAAY,KAAiB;QAC3B,KAAK,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;IAC5C,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAC9C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAA8C,GAAM;QAC7D,IAAI,GAAG,YAAY,MAAM,EAAE;YACzB,OAAO,GAAG,CAAA;SACX;QAED,IAAI,GAAG,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAEtC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC3B,IAAI,GAAG,GAAG,CAAC,EAAE;gBACX,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;aACrD;YAED,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;YAE1B,MAAM,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;YACrD,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YACzD,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YAE1D,OAAO,IAAI,MAAM,CAAC,IAAA,cAAM,EAAC,MAAM,CAAC,CAAC,CAAA;SAClC;QAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC3B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;gBACxB,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,4BAA4B,CAAC,CAAA;aACpD;YAED,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;YACpC,GAAG,GAAG,IAAA,kBAAU,EAAC,MAAM,CAAC,CAAA;YACxB,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,CAAA;SACvB;QAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC3B,MAAM,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;YACrD,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YAC9D,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YAEvD,OAAO,IAAI,MAAM,CAAC,IAAA,cAAM,EAAC,MAAM,CAAC,CAAC,CAAA;SAClC;QAED,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;IAC7D,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO,IAAA,kBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC/B,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,MAAM,GAAG,GAAG,MAAM,CAAC,IAAA,oBAAY,EAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAC3D,MAAM,GAAG,GAAG,MAAM,CAAC,IAAA,oBAAY,EAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QACxD,OAAO,CAAC,GAAG,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAA;IAClC,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;;AAGM,wBAAM;AA3Fa,YAAK,GAAW,EAAE,GAAG,CAAC,CAAA,CAAC,IAAI;AACrC,oBAAa,GAAW,IAAI,MAAM,CAChD,IAAI,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAC7B,CAAA"}

package/dist/src/types/uint-8.d.ts

@@ -0,0 +1,24 @@
+import { UInt } from './uint';
+import { BinaryParser } from '../serdes/binary-parser';
+/**
+ * Derived UInt class for serializing/deserializing 8 bit UInt
+ */
+declare class UInt8 extends UInt {
+    protected static readonly width: number;
+    static readonly defaultUInt8: UInt8;
+    constructor(bytes: Uint8Array);
+    static fromParser(parser: BinaryParser): UInt;
+    /**
+     * Construct a UInt8 object from a number
+     *
+     * @param val UInt8 object or number
+     */
+    static from<T extends UInt8 | number>(val: T): UInt8;
+    /**
+     * get the value of a UInt8 object
+     *
+     * @returns the number represented by this.bytes
+     */
+    valueOf(): number;
+}
+export { UInt8 };

package/dist/src/types/uint-8.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UInt8 = void 0;
+const uint_1 = require("./uint");
+const utils_1 = require("@xrplf/isomorphic/utils");
+const utils_2 = require("../utils");
+/**
+ * Derived UInt class for serializing/deserializing 8 bit UInt
+ */
+class UInt8 extends uint_1.UInt {
+    constructor(bytes) {
+        super(bytes !== null && bytes !== void 0 ? bytes : UInt8.defaultUInt8.bytes);
+    }
+    static fromParser(parser) {
+        return new UInt8(parser.read(UInt8.width));
+    }
+    /**
+     * Construct a UInt8 object from a number
+     *
+     * @param val UInt8 object or number
+     */
+    static from(val) {
+        if (val instanceof UInt8) {
+            return val;
+        }
+        if (typeof val === 'number') {
+            UInt8.checkUintRange(val, 0, 0xff);
+            const buf = new Uint8Array(UInt8.width);
+            (0, utils_2.writeUInt8)(buf, val, 0);
+            return new UInt8(buf);
+        }
+        throw new Error('Cannot construct UInt8 from given value');
+    }
+    /**
+     * get the value of a UInt8 object
+     *
+     * @returns the number represented by this.bytes
+     */
+    valueOf() {
+        return parseInt((0, utils_1.bytesToHex)(this.bytes), 16);
+    }
+}
+exports.UInt8 = UInt8;
+UInt8.width = 8 / 8; // 1
+UInt8.defaultUInt8 = new UInt8(new Uint8Array(UInt8.width));
+//# sourceMappingURL=uint-8.js.map

package/dist/src/types/uint-8.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uint-8.js","sourceRoot":"","sources":["../../../src/types/uint-8.ts"],"names":[],"mappings":";;;AAAA,iCAA6B;AAE7B,mDAAoD;AACpD,oCAAqC;AAErC;;GAEG;AACH,MAAM,KAAM,SAAQ,WAAI;IAItB,YAAY,KAAiB;QAC3B,KAAK,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;IAC1C,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAA;IAC5C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAA2B,GAAM;QAC1C,IAAI,GAAG,YAAY,KAAK,EAAE;YACxB,OAAO,GAAG,CAAA;SACX;QAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC3B,KAAK,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAA;YAElC,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YACvC,IAAA,kBAAU,EAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACvB,OAAO,IAAI,KAAK,CAAC,GAAG,CAAC,CAAA;SACtB;QAED,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;IAC5D,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,OAAO,QAAQ,CAAC,IAAA,kBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAA;IAC7C,CAAC;;AAGM,sBAAK;AA1Cc,WAAK,GAAW,CAAC,GAAG,CAAC,CAAA,CAAC,IAAI;AACpC,kBAAY,GAAU,IAAI,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAA"}

package/dist/src/types/uint.d.ts

@@ -0,0 +1,29 @@
+import { Comparable } from './serialized-type';
+/**
+ * Base class for serializing and deserializing unsigned integers.
+ */
+declare abstract class UInt extends Comparable<UInt | number> {
+    protected static width: number;
+    constructor(bytes: Uint8Array);
+    /**
+     * Overload of compareTo for Comparable
+     *
+     * @param other other UInt to compare this to
+     * @returns -1, 0, or 1 depending on how the objects relate to each other
+     */
+    compareTo(other: UInt | number): number;
+    /**
+     * Convert a UInt object to JSON
+     *
+     * @returns number or string represented by this.bytes
+     */
+    toJSON(): number | string;
+    /**
+     * Get the value of the UInt represented by this.bytes
+     *
+     * @returns the value
+     */
+    abstract valueOf(): number | bigint;
+    static checkUintRange(val: number, min: number, max: number): void;
+}
+export { UInt };

package/dist/src/types/uint.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UInt = void 0;
+const serialized_type_1 = require("./serialized-type");
+/**
+ * Compare numbers and bigInts n1 and n2
+ *
+ * @param n1 First object to compare
+ * @param n2 Second object to compare
+ * @returns -1, 0, or 1, depending on how the two objects compare
+ */
+function compare(n1, n2) {
+    return n1 < n2 ? -1 : n1 == n2 ? 0 : 1;
+}
+/**
+ * Base class for serializing and deserializing unsigned integers.
+ */
+class UInt extends serialized_type_1.Comparable {
+    constructor(bytes) {
+        super(bytes);
+    }
+    /**
+     * Overload of compareTo for Comparable
+     *
+     * @param other other UInt to compare this to
+     * @returns -1, 0, or 1 depending on how the objects relate to each other
+     */
+    compareTo(other) {
+        return compare(this.valueOf(), other.valueOf());
+    }
+    /**
+     * Convert a UInt object to JSON
+     *
+     * @returns number or string represented by this.bytes
+     */
+    toJSON() {
+        const val = this.valueOf();
+        return typeof val === 'number' ? val : val.toString();
+    }
+    static checkUintRange(val, min, max) {
+        if (val < min || val > max) {
+            throw new Error(`Invalid ${this.constructor.name}: ${val} must be >= ${min} and <= ${max}`);
+        }
+    }
+}
+exports.UInt = UInt;
+//# sourceMappingURL=uint.js.map

package/dist/src/types/uint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uint.js","sourceRoot":"","sources":["../../../src/types/uint.ts"],"names":[],"mappings":";;;AAAA,uDAA8C;AAE9C;;;;;;GAMG;AACH,SAAS,OAAO,CAAC,EAAmB,EAAE,EAAmB;IACvD,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AACxC,CAAC;AAED;;GAEG;AACH,MAAe,IAAK,SAAQ,4BAAyB;IAGnD,YAAY,KAAiB;QAC3B,KAAK,CAAC,KAAK,CAAC,CAAA;IACd,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,KAAoB;QAC5B,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;IACjD,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,CAAA;QAC1B,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAA;IACvD,CAAC;IASD,MAAM,CAAC,cAAc,CAAC,GAAW,EAAE,GAAW,EAAE,GAAW;QACzD,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,EAAE;YAC1B,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,GAAG,eAAe,GAAG,WAAW,GAAG,EAAE,CAC3E,CAAA;SACF;IACH,CAAC;CACF;AAEQ,oBAAI"}

package/dist/src/types/vector-256.d.ts

@@ -0,0 +1,30 @@
+import { SerializedType } from './serialized-type';
+import { BinaryParser } from '../serdes/binary-parser';
+/**
+ * Class for serializing and deserializing vectors of Hash256
+ */
+declare class Vector256 extends SerializedType {
+    constructor(bytes: Uint8Array);
+    /**
+     * Construct a Vector256 from a BinaryParser
+     *
+     * @param parser BinaryParser to
+     * @param hint length of the vector, in bytes, optional
+     * @returns a Vector256 object
+     */
+    static fromParser(parser: BinaryParser, hint?: number): Vector256;
+    /**
+     * Construct a Vector256 object from an array of hashes
+     *
+     * @param value A Vector256 object or array of hex-strings representing Hash256's
+     * @returns a Vector256 object
+     */
+    static from<T extends Vector256 | Array<string>>(value: T): Vector256;
+    /**
+     * Return an Array of hex-strings represented by this.bytes
+     *
+     * @returns An Array of strings representing the Hash256 objects
+     */
+    toJSON(): Array<string>;
+}
+export { Vector256 };