@transia/ripple-binary-codec 1.4.6-alpha.9 → 2.5.1-quantum.0

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,38 @@
+import { UInt } from './uint';
+import { BinaryParser } from '../serdes/binary-parser';
+import { XrplDefinitionsBase } from '../enums';
+/**
+ * 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, fieldName?: string): UInt64;
+    /**
+     * The JSON representation of a UInt64 object
+     *
+     * @returns a hex-string
+     */
+    toJSON(_definitions?: XrplDefinitionsBase, fieldName?: string): 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,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UInt64 = void 0;
+const uint_1 = require("./uint");
+const utils_1 = require("@transia/isomorphic/utils");
+const utils_2 = require("../utils");
+const enums_1 = require("../enums");
+const HEX_REGEX = /^[a-fA-F0-9]{1,16}$/;
+const BASE10_REGEX = /^[0-9]{1,20}$/;
+const mask = BigInt(0x00000000ffffffff);
+const BASE10_AMOUNT_FIELDS = new Set([
+    'MaximumAmount',
+    'OutstandingAmount',
+    'MPTAmount',
+    'LockedAmount',
+]);
+function isBase10(fieldName) {
+    return BASE10_AMOUNT_FIELDS.has(fieldName);
+}
+/**
+ * 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, fieldName = '') {
+        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 (isBase10(fieldName)) {
+                if (!BASE10_REGEX.test(val)) {
+                    throw new Error(`${fieldName} ${val} is not a valid base 10 string`);
+                }
+                val = BigInt(val).toString(16);
+            }
+            if (typeof val === 'string' && !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(_definitions = enums_1.DEFAULT_DEFINITIONS, fieldName = '') {
+        const hexString = (0, utils_1.bytesToHex)(this.bytes);
+        if (isBase10(fieldName)) {
+            return BigInt('0x' + hexString).toString(10);
+        }
+        return hexString;
+    }
+    /**
+     * 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,qDAA0E;AAC1E,oCAAsD;AACtD,oCAAmE;AAEnE,MAAM,SAAS,GAAG,qBAAqB,CAAA;AACvC,MAAM,YAAY,GAAG,eAAe,CAAA;AACpC,MAAM,IAAI,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAA;AAEvC,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC;IACnC,eAAe;IACf,mBAAmB;IACnB,WAAW;IACX,cAAc;CACf,CAAC,CAAA;AAEF,SAAS,QAAQ,CAAC,SAAiB;IACjC,OAAO,oBAAoB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;AAC5C,CAAC;AAED;;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,CACT,GAAM,EACN,SAAS,GAAG,EAAE;QAEd,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,QAAQ,CAAC,SAAS,CAAC,EAAE;gBACvB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;oBAC3B,MAAM,IAAI,KAAK,CAAC,GAAG,SAAS,IAAI,GAAG,gCAAgC,CAAC,CAAA;iBACrE;gBACD,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAM,CAAA;aACpC;YAED,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,4BAA4B,CAAC,CAAA;aACpD;YAED,MAAM,MAAM,GAAI,GAAc,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;YAChD,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,CACJ,eAAoC,2BAAmB,EACvD,SAAS,GAAG,EAAE;QAEd,MAAM,SAAS,GAAG,IAAA,kBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACxC,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE;YACvB,OAAO,MAAM,CAAC,IAAI,GAAG,SAAS,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;SAC7C;QAED,OAAO,SAAS,CAAA;IAClB,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;AA7Ga,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("@transia/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,qDAAsD;AACtD,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 };

package/dist/src/types/vector-256.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Vector256 = void 0;
+const serialized_type_1 = require("./serialized-type");
+const hash_256_1 = require("./hash-256");
+const binary_serializer_1 = require("../serdes/binary-serializer");
+const utils_1 = require("@transia/isomorphic/utils");
+/**
+ * TypeGuard for Array<string>
+ */
+function isStrings(arg) {
+    return Array.isArray(arg) && (arg.length === 0 || typeof arg[0] === 'string');
+}
+/**
+ * Class for serializing and deserializing vectors of Hash256
+ */
+class Vector256 extends serialized_type_1.SerializedType {
+    constructor(bytes) {
+        super(bytes);
+    }
+    /**
+     * 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, hint) {
+        const bytesList = new binary_serializer_1.BytesList();
+        const bytes = hint !== null && hint !== void 0 ? hint : parser.size();
+        const hashes = bytes / 32;
+        for (let i = 0; i < hashes; i++) {
+            hash_256_1.Hash256.fromParser(parser).toBytesSink(bytesList);
+        }
+        return new Vector256(bytesList.toBytes());
+    }
+    /**
+     * 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(value) {
+        if (value instanceof Vector256) {
+            return value;
+        }
+        if (isStrings(value)) {
+            const bytesList = new binary_serializer_1.BytesList();
+            value.forEach((hash) => {
+                hash_256_1.Hash256.from(hash).toBytesSink(bytesList);
+            });
+            return new Vector256(bytesList.toBytes());
+        }
+        throw new Error('Cannot construct Vector256 from given value');
+    }
+    /**
+     * Return an Array of hex-strings represented by this.bytes
+     *
+     * @returns An Array of strings representing the Hash256 objects
+     */
+    toJSON() {
+        if (this.bytes.byteLength % 32 !== 0) {
+            throw new Error('Invalid bytes for Vector256');
+        }
+        const result = [];
+        for (let i = 0; i < this.bytes.byteLength; i += 32) {
+            result.push((0, utils_1.bytesToHex)(this.bytes.slice(i, i + 32)));
+        }
+        return result;
+    }
+}
+exports.Vector256 = Vector256;
+//# sourceMappingURL=vector-256.js.map

package/dist/src/types/vector-256.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vector-256.js","sourceRoot":"","sources":["../../../src/types/vector-256.ts"],"names":[],"mappings":";;;AAAA,uDAAkD;AAElD,yCAAoC;AACpC,mEAAuD;AACvD,qDAAsD;AAEtD;;GAEG;AACH,SAAS,SAAS,CAAC,GAAG;IACpB,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAA;AAC/E,CAAC;AAED;;GAEG;AACH,MAAM,SAAU,SAAQ,gCAAc;IACpC,YAAY,KAAiB;QAC3B,KAAK,CAAC,KAAK,CAAC,CAAA;IACd,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB,EAAE,IAAa;QACnD,MAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAA;QACjC,MAAM,KAAK,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,MAAM,CAAC,IAAI,EAAE,CAAA;QACnC,MAAM,MAAM,GAAG,KAAK,GAAG,EAAE,CAAA;QACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE;YAC/B,kBAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;SAClD;QACD,OAAO,IAAI,SAAS,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAA;IAC3C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAsC,KAAQ;QACvD,IAAI,KAAK,YAAY,SAAS,EAAE;YAC9B,OAAO,KAAK,CAAA;SACb;QAED,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;YACpB,MAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAA;YACjC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACrB,kBAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;YAC3C,CAAC,CAAC,CAAA;YACF,OAAO,IAAI,SAAS,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAA;SAC1C;QAED,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;IAChE,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,EAAE,KAAK,CAAC,EAAE;YACpC,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;SAC/C;QAED,MAAM,MAAM,GAAkB,EAAE,CAAA;QAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE;YAClD,MAAM,CAAC,IAAI,CAAC,IAAA,kBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAA;SACrD;QACD,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAEQ,8BAAS"}

package/dist/src/types/xchain-bridge.d.ts

@@ -0,0 +1,44 @@
+import { BinaryParser } from '../serdes/binary-parser';
+import { JsonObject, SerializedType } from './serialized-type';
+import { IssueObject } from './issue';
+/**
+ * Interface for JSON objects that represent cross-chain bridges
+ */
+interface XChainBridgeObject extends JsonObject {
+    LockingChainDoor: string;
+    LockingChainIssue: IssueObject | string;
+    IssuingChainDoor: string;
+    IssuingChainIssue: IssueObject | string;
+}
+/**
+ * Class for serializing/deserializing XChainBridges
+ */
+declare class XChainBridge extends SerializedType {
+    static readonly ZERO_XCHAIN_BRIDGE: XChainBridge;
+    static readonly TYPE_ORDER: {
+        name: string;
+        type: typeof SerializedType;
+    }[];
+    constructor(bytes: Uint8Array);
+    /**
+     * Construct a cross-chain bridge from a JSON
+     *
+     * @param value XChainBridge or JSON to parse into an XChainBridge
+     * @returns An XChainBridge object
+     */
+    static from<T extends XChainBridge | XChainBridgeObject>(value: T): XChainBridge;
+    /**
+     * Read an XChainBridge from a BinaryParser
+     *
+     * @param parser BinaryParser to read the XChainBridge from
+     * @returns An XChainBridge object
+     */
+    static fromParser(parser: BinaryParser): XChainBridge;
+    /**
+     * Get the JSON representation of this XChainBridge
+     *
+     * @returns the JSON interpretation of this.bytes
+     */
+    toJSON(): XChainBridgeObject;
+}
+export { XChainBridge, XChainBridgeObject };

package/dist/src/types/xchain-bridge.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XChainBridge = void 0;
+const binary_parser_1 = require("../serdes/binary-parser");
+const account_id_1 = require("./account-id");
+const serialized_type_1 = require("./serialized-type");
+const issue_1 = require("./issue");
+const utils_1 = require("@transia/isomorphic/utils");
+/**
+ * Type guard for XChainBridgeObject
+ */
+function isXChainBridgeObject(arg) {
+    const keys = Object.keys(arg).sort();
+    return (keys.length === 4 &&
+        keys[0] === 'IssuingChainDoor' &&
+        keys[1] === 'IssuingChainIssue' &&
+        keys[2] === 'LockingChainDoor' &&
+        keys[3] === 'LockingChainIssue');
+}
+/**
+ * Class for serializing/deserializing XChainBridges
+ */
+class XChainBridge extends serialized_type_1.SerializedType {
+    constructor(bytes) {
+        super(bytes !== null && bytes !== void 0 ? bytes : XChainBridge.ZERO_XCHAIN_BRIDGE.bytes);
+    }
+    /**
+     * Construct a cross-chain bridge from a JSON
+     *
+     * @param value XChainBridge or JSON to parse into an XChainBridge
+     * @returns An XChainBridge object
+     */
+    static from(value) {
+        if (value instanceof XChainBridge) {
+            return value;
+        }
+        if (!isXChainBridgeObject(value)) {
+            throw new Error('Invalid type to construct an XChainBridge');
+        }
+        const bytes = [];
+        this.TYPE_ORDER.forEach((item) => {
+            const { name, type } = item;
+            if (type === account_id_1.AccountID) {
+                bytes.push(Uint8Array.from([0x14]));
+            }
+            const object = type.from(value[name]);
+            bytes.push(object.toBytes());
+        });
+        return new XChainBridge((0, utils_1.concat)(bytes));
+    }
+    /**
+     * Read an XChainBridge from a BinaryParser
+     *
+     * @param parser BinaryParser to read the XChainBridge from
+     * @returns An XChainBridge object
+     */
+    static fromParser(parser) {
+        const bytes = [];
+        this.TYPE_ORDER.forEach((item) => {
+            const { type } = item;
+            if (type === account_id_1.AccountID) {
+                parser.skip(1);
+                bytes.push(Uint8Array.from([0x14]));
+            }
+            const object = type.fromParser(parser);
+            bytes.push(object.toBytes());
+        });
+        return new XChainBridge((0, utils_1.concat)(bytes));
+    }
+    /**
+     * Get the JSON representation of this XChainBridge
+     *
+     * @returns the JSON interpretation of this.bytes
+     */
+    toJSON() {
+        const parser = new binary_parser_1.BinaryParser(this.toString());
+        const json = {};
+        XChainBridge.TYPE_ORDER.forEach((item) => {
+            const { name, type } = item;
+            if (type === account_id_1.AccountID) {
+                parser.skip(1);
+            }
+            const object = type.fromParser(parser).toJSON();
+            json[name] = object;
+        });
+        return json;
+    }
+}
+exports.XChainBridge = XChainBridge;
+XChainBridge.ZERO_XCHAIN_BRIDGE = new XChainBridge((0, utils_1.concat)([
+    Uint8Array.from([0x14]),
+    new Uint8Array(40),
+    Uint8Array.from([0x14]),
+    new Uint8Array(40),
+]));
+XChainBridge.TYPE_ORDER = [
+    { name: 'LockingChainDoor', type: account_id_1.AccountID },
+    { name: 'LockingChainIssue', type: issue_1.Issue },
+    { name: 'IssuingChainDoor', type: account_id_1.AccountID },
+    { name: 'IssuingChainIssue', type: issue_1.Issue },
+];
+//# sourceMappingURL=xchain-bridge.js.map

package/dist/src/types/xchain-bridge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xchain-bridge.js","sourceRoot":"","sources":["../../../src/types/xchain-bridge.ts"],"names":[],"mappings":";;;AAAA,2DAAsD;AAEtD,6CAAwC;AACxC,uDAA8D;AAC9D,mCAA4C;AAC5C,qDAAkD;AAYlD;;GAEG;AACH,SAAS,oBAAoB,CAAC,GAAG;IAC/B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IACpC,OAAO,CACL,IAAI,CAAC,MAAM,KAAK,CAAC;QACjB,IAAI,CAAC,CAAC,CAAC,KAAK,kBAAkB;QAC9B,IAAI,CAAC,CAAC,CAAC,KAAK,mBAAmB;QAC/B,IAAI,CAAC,CAAC,CAAC,KAAK,kBAAkB;QAC9B,IAAI,CAAC,CAAC,CAAC,KAAK,mBAAmB,CAChC,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,YAAa,SAAQ,gCAAc;IAkBvC,YAAY,KAAiB;QAC3B,KAAK,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,YAAY,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAA;IACvD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CACT,KAAQ;QAER,IAAI,KAAK,YAAY,YAAY,EAAE;YACjC,OAAO,KAAK,CAAA;SACb;QAED,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;SAC7D;QAED,MAAM,KAAK,GAAsB,EAAE,CAAA;QACnC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/B,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;YAC3B,IAAI,IAAI,KAAK,sBAAS,EAAE;gBACtB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;aACpC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;YACrC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;QAC9B,CAAC,CAAC,CAAA;QACF,OAAO,IAAI,YAAY,CAAC,IAAA,cAAM,EAAC,KAAK,CAAC,CAAC,CAAA;IACxC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,MAAM,KAAK,GAAsB,EAAE,CAAA;QAEnC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/B,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;YACrB,IAAI,IAAI,KAAK,sBAAS,EAAE;gBACtB,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBACd,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;aACpC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;YACtC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;QAC9B,CAAC,CAAC,CAAA;QAEF,OAAO,IAAI,YAAY,CAAC,IAAA,cAAM,EAAC,KAAK,CAAC,CAAC,CAAA;IACxC,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,MAAM,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QAChD,MAAM,IAAI,GAAG,EAAE,CAAA;QACf,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACvC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;YAC3B,IAAI,IAAI,KAAK,sBAAS,EAAE;gBACtB,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;aACf;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAA;YAC/C,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,CAAA;QACrB,CAAC,CAAC,CAAA;QACF,OAAO,IAA0B,CAAA;IACnC,CAAC;;AAGM,oCAAY;AA5FH,+BAAkB,GAAiB,IAAI,YAAY,CACjE,IAAA,cAAM,EAAC;IACL,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;IACvB,IAAI,UAAU,CAAC,EAAE,CAAC;IAClB,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;IACvB,IAAI,UAAU,CAAC,EAAE,CAAC;CACnB,CAAC,CACH,CAAA;AAEe,uBAAU,GACxB;IACE,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,sBAAS,EAAE;IAC7C,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,aAAK,EAAE;IAC1C,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,sBAAS,EAAE;IAC7C,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,aAAK,EAAE;CAC3C,CAAA"}