ripple-binary-codec 1.0.2 → 1.0.3-mpt-beta

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

@@ -1 +1 @@
-{"version":3,"file":"vector-256.js","sourceRoot":"","sources":["../../src/types/vector-256.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmD;AAEnD,uCAAqC;AACrC,iEAAwD;AAExD;;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,CAAC;AAChF,CAAC;AAED;;GAEG;AACH;IAAwB,6BAAc;IACpC,mBAAY,KAAa;eACvB,kBAAM,KAAK,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,oBAAU,GAAjB,UAAkB,MAAoB,EAAE,IAAa;QACnD,IAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAC;QAClC,IAAM,KAAK,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QACpC,IAAM,MAAM,GAAG,KAAK,GAAG,EAAE,CAAC;QAC1B,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,CAAC;SACnD;QACD,OAAO,IAAI,SAAS,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACI,cAAI,GAAX,UAAiD,KAAQ;QACvD,IAAI,KAAK,YAAY,SAAS,EAAE;YAC9B,OAAO,KAAK,CAAC;SACd;QAED,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;YACpB,IAAM,WAAS,GAAG,IAAI,6BAAS,EAAE,CAAC;YAClC,KAAK,CAAC,OAAO,CAAC,UAAC,IAAI;gBACjB,kBAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,WAAS,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;YACH,OAAO,IAAI,SAAS,CAAC,WAAS,CAAC,OAAO,EAAE,CAAC,CAAC;SAC3C;QAED,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACH,0BAAM,GAAN;QACE,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,EAAE,KAAK,CAAC,EAAE;YACpC,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;SAChD;QAED,IAAM,MAAM,GAAkB,EAAE,CAAC;QACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE;YAClD,MAAM,CAAC,IAAI,CACT,IAAI,CAAC,KAAK;iBACP,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC;iBAChB,QAAQ,CAAC,KAAK,CAAC;iBACf,WAAW,EAAE,CACjB,CAAC;SACH;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACH,gBAAC;AAAD,CAAC,AAjED,CAAwB,gCAAc,GAiErC;AAEQ,8BAAS"}
+{"version":3,"file":"vector-256.js","sourceRoot":"","sources":["../../src/types/vector-256.ts"],"names":[],"mappings":";;;AAAA,uDAAkD;AAElD,yCAAoC;AACpC,mEAAuD;AACvD,mDAAoD;AAEpD;;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/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/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("@xrplf/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/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,mDAAgD;AAYhD;;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"}

package/dist/utils.d.ts

@@ -0,0 +1,47 @@
+/// <reference types="node" />
+import TypedArray = NodeJS.TypedArray;
+/**
+ * Writes value to array at the specified offset. The value must be a valid unsigned 8-bit integer.
+ * @param array Uint8Array to be written to
+ * @param value Number to be written to array.
+ * @param offset plus the number of bytes written.
+ */
+export declare function writeUInt8(array: Uint8Array, value: number, offset: number): void;
+/**
+ * Writes value to array at the specified offset as big-endian. The value must be a valid unsigned 16-bit integer.
+ * @param array Uint8Array to be written to
+ * @param value Number to be written to array.
+ * @param offset plus the number of bytes written.
+ */
+export declare function writeUInt16BE(array: Uint8Array, value: number, offset: number): void;
+/**
+ * Writes value to array at the specified offset as big-endian. The value must be a valid unsigned 32-bit integer.
+ * @param array Uint8Array to be written to
+ * @param value Number to be written to array.
+ * @param offset plus the number of bytes written.
+ */
+export declare function writeUInt32BE(array: Uint8Array, value: number, offset: number): void;
+/**
+ * Reads an unsigned, big-endian 16-bit integer from the array at the specified offset.
+ * @param array Uint8Array to read
+ * @param offset Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
+ */
+export declare function readUInt16BE(array: Uint8Array, offset: number): string;
+/**
+ * Reads an unsigned, big-endian 16-bit integer from the array at the specified offset.
+ * @param array Uint8Array to read
+ * @param offset Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
+ */
+export declare function readUInt32BE(array: Uint8Array, offset: number): string;
+/**
+ * Compares two Uint8Array or ArrayBuffers
+ * @param a first array to compare
+ * @param b second array to compare
+ */
+export declare function equal(a: Uint8Array | ArrayBuffer, b: Uint8Array | ArrayBuffer): boolean;
+/**
+ * Compare two TypedArrays
+ * @param a first array to compare
+ * @param b second array to compare
+ */
+export declare function compare(a: TypedArray, b: TypedArray): 1 | -1 | 0;

package/dist/utils.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compare = exports.equal = exports.readUInt32BE = exports.readUInt16BE = exports.writeUInt32BE = exports.writeUInt16BE = exports.writeUInt8 = void 0;
+/**
+ * Writes value to array at the specified offset. The value must be a valid unsigned 8-bit integer.
+ * @param array Uint8Array to be written to
+ * @param value Number to be written to array.
+ * @param offset plus the number of bytes written.
+ */
+function writeUInt8(array, value, offset) {
+    value = Number(value);
+    array[offset] = value;
+}
+exports.writeUInt8 = writeUInt8;
+/**
+ * Writes value to array at the specified offset as big-endian. The value must be a valid unsigned 16-bit integer.
+ * @param array Uint8Array to be written to
+ * @param value Number to be written to array.
+ * @param offset plus the number of bytes written.
+ */
+function writeUInt16BE(array, value, offset) {
+    value = Number(value);
+    array[offset] = value >>> 8;
+    array[offset + 1] = value;
+}
+exports.writeUInt16BE = writeUInt16BE;
+/**
+ * Writes value to array at the specified offset as big-endian. The value must be a valid unsigned 32-bit integer.
+ * @param array Uint8Array to be written to
+ * @param value Number to be written to array.
+ * @param offset plus the number of bytes written.
+ */
+function writeUInt32BE(array, value, offset) {
+    array[offset] = (value >>> 24) & 0xff;
+    array[offset + 1] = (value >>> 16) & 0xff;
+    array[offset + 2] = (value >>> 8) & 0xff;
+    array[offset + 3] = value & 0xff;
+}
+exports.writeUInt32BE = writeUInt32BE;
+/**
+ * Reads an unsigned, big-endian 16-bit integer from the array at the specified offset.
+ * @param array Uint8Array to read
+ * @param offset Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
+ */
+function readUInt16BE(array, offset) {
+    return new DataView(array.buffer).getUint16(offset, false).toString(10);
+}
+exports.readUInt16BE = readUInt16BE;
+/**
+ * Reads an unsigned, big-endian 16-bit integer from the array at the specified offset.
+ * @param array Uint8Array to read
+ * @param offset Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
+ */
+function readUInt32BE(array, offset) {
+    return new DataView(array.buffer).getUint32(offset, false).toString(10);
+}
+exports.readUInt32BE = readUInt32BE;
+/**
+ * Compares two Uint8Array or ArrayBuffers
+ * @param a first array to compare
+ * @param b second array to compare
+ */
+function equal(a, b) {
+    const aUInt = a instanceof ArrayBuffer ? new Uint8Array(a, 0) : a;
+    const bUInt = b instanceof ArrayBuffer ? new Uint8Array(b, 0) : b;
+    if (aUInt.byteLength != bUInt.byteLength)
+        return false;
+    if (aligned32(aUInt) && aligned32(bUInt))
+        return compare32(aUInt, bUInt) === 0;
+    if (aligned16(aUInt) && aligned16(bUInt))
+        return compare16(aUInt, bUInt) === 0;
+    return compare8(aUInt, bUInt) === 0;
+}
+exports.equal = equal;
+/**
+ * Compares two 8 bit aligned arrays
+ * @param a first array to compare
+ * @param b second array to compare
+ */
+function compare8(a, b) {
+    const ua = new Uint8Array(a.buffer, a.byteOffset, a.byteLength);
+    const ub = new Uint8Array(b.buffer, b.byteOffset, b.byteLength);
+    return compare(ua, ub);
+}
+/**
+ * Compares two 16 bit aligned arrays
+ * @param a first array to compare
+ * @param b second array to compare
+ */
+function compare16(a, b) {
+    const ua = new Uint16Array(a.buffer, a.byteOffset, a.byteLength / 2);
+    const ub = new Uint16Array(b.buffer, b.byteOffset, b.byteLength / 2);
+    return compare(ua, ub);
+}
+/**
+ * Compares two 32 bit aligned arrays
+ * @param a first array to compare
+ * @param b second array to compare
+ */
+function compare32(a, b) {
+    const ua = new Uint32Array(a.buffer, a.byteOffset, a.byteLength / 4);
+    const ub = new Uint32Array(b.buffer, b.byteOffset, b.byteLength / 4);
+    return compare(ua, ub);
+}
+/**
+ * Compare two TypedArrays
+ * @param a first array to compare
+ * @param b second array to compare
+ */
+function compare(a, b) {
+    if (a.byteLength !== b.byteLength) {
+        throw new Error('Cannot compare arrays of different length');
+    }
+    for (let i = 0; i < a.length - 1; i += 1) {
+        if (a[i] > b[i])
+            return 1;
+        if (a[i] < b[i])
+            return -1;
+    }
+    return 0;
+}
+exports.compare = compare;
+/**
+ * Determine if TypedArray is 16 bit aligned
+ * @param array The array to check
+ */
+function aligned16(array) {
+    return array.byteOffset % 2 === 0 && array.byteLength % 2 === 0;
+}
+/**
+ * Determine if TypedArray is 32 bit aligned
+ * @param array The array to check
+ */
+function aligned32(array) {
+    return array.byteOffset % 4 === 0 && array.byteLength % 4 === 0;
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAGA;;;;;GAKG;AACH,SAAgB,UAAU,CACxB,KAAiB,EACjB,KAAa,EACb,MAAc;IAEd,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;IACrB,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAA;AACvB,CAAC;AAPD,gCAOC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAC3B,KAAiB,EACjB,KAAa,EACb,MAAc;IAEd,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;IAErB,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,KAAK,CAAC,CAAA;IAC3B,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,KAAK,CAAA;AAC3B,CAAC;AATD,sCASC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAC3B,KAAiB,EACjB,KAAa,EACb,MAAc;IAEd,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE,CAAC,GAAG,IAAI,CAAA;IACrC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE,CAAC,GAAG,IAAI,CAAA;IACzC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC,GAAG,IAAI,CAAA;IACxC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,IAAI,CAAA;AAClC,CAAC;AATD,sCASC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAAC,KAAiB,EAAE,MAAc;IAC5D,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;AACzE,CAAC;AAFD,oCAEC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAAC,KAAiB,EAAE,MAAc;IAC5D,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;AACzE,CAAC;AAFD,oCAEC;AAED;;;;GAIG;AACH,SAAgB,KAAK,CACnB,CAA2B,EAC3B,CAA2B;IAE3B,MAAM,KAAK,GAAG,CAAC,YAAY,WAAW,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACjE,MAAM,KAAK,GAAG,CAAC,YAAY,WAAW,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACjE,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU;QAAE,OAAO,KAAK,CAAA;IACtD,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;IAC9E,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;IAC9E,OAAO,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;AACrC,CAAC;AAVD,sBAUC;AAED;;;;GAIG;AACH,SAAS,QAAQ,CAAC,CAAC,EAAE,CAAC;IACpB,MAAM,EAAE,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,CAAC,CAAA;IAC/D,MAAM,EAAE,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,CAAC,CAAA;IAC/D,OAAO,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;AACxB,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,CAAa,EAAE,CAAa;IAC7C,MAAM,EAAE,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA;IACpE,MAAM,EAAE,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA;IACpE,OAAO,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;AACxB,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,CAAa,EAAE,CAAa;IAC7C,MAAM,EAAE,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA;IACpE,MAAM,EAAE,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA;IACpE,OAAO,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;AACxB,CAAC;AAED;;;;GAIG;AACH,SAAgB,OAAO,CAAC,CAAa,EAAE,CAAa;IAClD,IAAI,CAAC,CAAC,UAAU,KAAK,CAAC,CAAC,UAAU,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;KAC7D;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE;QACxC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAA;QACzB,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAC,CAAA;KAC3B;IACD,OAAO,CAAC,CAAA;AACV,CAAC;AAVD,0BAUC;AAED;;;GAGG;AACH,SAAS,SAAS,CAAC,KAAiB;IAClC,OAAO,KAAK,CAAC,UAAU,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,GAAG,CAAC,KAAK,CAAC,CAAA;AACjE,CAAC;AAED;;;GAGG;AACH,SAAS,SAAS,CAAC,KAAiB;IAClC,OAAO,KAAK,CAAC,UAAU,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,GAAG,CAAC,KAAK,CAAC,CAAA;AACjE,CAAC"}

package/package.json

@@ -1,57 +1,47 @@
 {
   "name": "ripple-binary-codec",
-  "version": "1.0.2",
+  "version": "1.0.3-mpt-beta",
   "description": "XRP Ledger binary codec",
   "files": [
     "dist/*",
-    "bin/*",
-    "test/*"
+    "src/*"
   ],
   "main": "dist/",
   "directories": {
     "test": "test"
   },
   "dependencies": {
-    "create-hash": "^1.2.0",
-    "decimal.js": "^10.2.0",
-    "ripple-address-codec": "^4.1.1"
-  },
-  "devDependencies": {
-    "@types/jest": "^26.0.7",
-    "@types/node": "^14.0.10",
-    "@typescript-eslint/eslint-plugin": "^3.2.0",
-    "@typescript-eslint/parser": "^3.2.0",
-    "eslint": "^7.7.0",
-    "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-import": "^2.21.1",
-    "eslint-plugin-jest": "^23.20.0",
-    "eslint-plugin-mocha": "^7.0.1",
-    "eslint-plugin-prettier": "^3.1.3",
-    "jest": "^26.0.1",
-    "prettier": "^2.0.4",
-    "typescript": "^3.9.5"
+    "@xrplf/isomorphic": "^1.0.1",
+    "bignumber.js": "^9.0.0",
+    "ripple-address-codec": "^5.0.0"
   },
   "scripts": {
-    "compile": "tsc && cp ./src/enums/definitions.json ./dist/enums",
-    "prepare": "npm run compile && npm test",
-    "test": "jest",
+    "build": "tsc --build tsconfig.build.json && copyfiles ./src/enums/definitions.json ./dist/enums/",
+    "clean": "rm -rf ./dist ./coverage ./test/testCompiledForWeb tsconfig.build.tsbuildinfo",
+    "prepublishOnly": "npm test",
+    "test": "npm run build && jest --verbose false --silent=false ./test/*.test.ts",
+    "test:browser": "npm run build && karma start ./karma.config.js",
     "lint": "eslint . --ext .ts --ext .test.js"
   },
+  "keywords": [
+    "ripple",
+    "xrp",
+    "xrp ledger",
+    "xrpl"
+  ],
   "repository": {
     "type": "git",
-    "url": "git://github.com/ripple/ripple-binary-codec.git"
+    "url": "git@github.com:XRPLF/xrpl.js.git"
   },
   "bugs": {
-    "url": "https://github.com/ripple/ripple-binary-codec/issues"
+    "url": "https://github.com/XRPLF/xrpl.js/issues"
   },
-  "homepage": "https://github.com/ripple/ripple-binary-codec#readme",
+  "homepage": "https://github.com/XRPLF/xrpl.js/tree/main/packages/ripple-binary-codec#readme",
   "license": "ISC",
   "readmeFilename": "README.md",
-  "prettier": {
-    "semi": true
-  },
+  "prettier": "@xrplf/prettier-config",
   "engines": {
-    "node": ">=10.22.0",
-    "yarn": "^1.22.4"
-  }
+    "node": ">= 16"
+  },
+  "gitHead": "0ff8b47616b659385f07b43d508e81233809ca62"
 }

package/src/README.md

@@ -0,0 +1,5 @@
+# ripple-binary-codec
+
+Serialize and deserialize transactions according to the XRP Ledger protocol.
+
+If you'd like to add a new transaction, data type, or generally modify this library, please read the [CONTRIBUTING.md](CONTRIBUTING.md)

package/src/binary.ts

@@ -0,0 +1,194 @@
+/* eslint-disable func-style */
+
+import { bytesToHex } from '@xrplf/isomorphic/utils'
+import { coreTypes } from './types'
+import { BinaryParser } from './serdes/binary-parser'
+import { AccountID } from './types/account-id'
+import { HashPrefix } from './hash-prefixes'
+import { BinarySerializer, BytesList } from './serdes/binary-serializer'
+import { sha512Half, transactionID } from './hashes'
+import {
+  type XrplDefinitionsBase,
+  DEFAULT_DEFINITIONS,
+  type FieldInstance,
+} from './enums'
+import { STObject } from './types/st-object'
+import { JsonObject } from './types/serialized-type'
+
+/**
+ * Construct a BinaryParser
+ *
+ * @param bytes hex-string or Uint8Array to construct BinaryParser from
+ * @param definitions rippled definitions used to parse the values of transaction types and such.
+ *                          Can be customized for sidechains and amendments.
+ * @returns BinaryParser
+ */
+const makeParser = (
+  bytes: string | Uint8Array,
+  definitions?: XrplDefinitionsBase,
+): BinaryParser =>
+  new BinaryParser(
+    bytes instanceof Uint8Array ? bytesToHex(bytes) : bytes,
+    definitions,
+  )
+
+/**
+ * Parse BinaryParser into JSON
+ *
+ * @param parser BinaryParser object
+ * @param definitions rippled definitions used to parse the values of transaction types and such.
+ *                          Can be customized for sidechains and amendments.
+ * @returns JSON for the bytes in the BinaryParser
+ */
+const readJSON = (
+  parser: BinaryParser,
+  definitions: XrplDefinitionsBase = DEFAULT_DEFINITIONS,
+): JsonObject =>
+  (parser.readType(coreTypes.STObject) as STObject).toJSON(definitions)
+
+/**
+ * Parse a hex-string into its JSON interpretation
+ *
+ * @param bytes hex-string to parse into JSON
+ * @param definitions rippled definitions used to parse the values of transaction types and such.
+ *                          Can be customized for sidechains and amendments.
+ * @returns JSON
+ */
+const binaryToJSON = (
+  bytes: string,
+  definitions?: XrplDefinitionsBase,
+): JsonObject => readJSON(makeParser(bytes, definitions), definitions)
+
+/**
+ * Interface for passing parameters to SerializeObject
+ *
+ * @field set signingFieldOnly to true if you want to serialize only signing fields
+ */
+interface OptionObject {
+  prefix?: Uint8Array
+  suffix?: Uint8Array
+  signingFieldsOnly?: boolean
+  definitions?: XrplDefinitionsBase
+}
+
+/**
+ * Function to serialize JSON object representing a transaction
+ *
+ * @param object JSON object to serialize
+ * @param opts options for serializing, including optional prefix, suffix, signingFieldOnly, and definitions
+ * @returns A Uint8Array containing the serialized object
+ */
+function serializeObject(
+  object: JsonObject,
+  opts: OptionObject = {},
+): Uint8Array {
+  const { prefix, suffix, signingFieldsOnly = false, definitions } = opts
+  const bytesList = new BytesList()
+
+  if (prefix) {
+    bytesList.put(prefix)
+  }
+
+  const filter = signingFieldsOnly
+    ? (f: FieldInstance): boolean => f.isSigningField
+    : undefined
+  ;(coreTypes.STObject as typeof STObject)
+    .from(object, filter, definitions)
+    .toBytesSink(bytesList)
+
+  if (suffix) {
+    bytesList.put(suffix)
+  }
+
+  return bytesList.toBytes()
+}
+
+/**
+ * Serialize an object for signing
+ *
+ * @param transaction Transaction to serialize
+ * @param prefix Prefix bytes to put before the serialized object
+ * @param opts.definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
+ * @returns A Uint8Array with the serialized object
+ */
+function signingData(
+  transaction: JsonObject,
+  prefix: Uint8Array = HashPrefix.transactionSig,
+  opts: { definitions?: XrplDefinitionsBase } = {},
+): Uint8Array {
+  return serializeObject(transaction, {
+    prefix,
+    signingFieldsOnly: true,
+    definitions: opts.definitions,
+  })
+}
+
+/**
+ * Interface describing fields required for a Claim
+ */
+interface ClaimObject extends JsonObject {
+  channel: string
+  amount: string | number
+}
+
+/**
+ * Serialize a signingClaim
+ *
+ * @param claim A claim object to serialize
+ * @param opts.definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
+ * @returns the serialized object with appropriate prefix
+ */
+function signingClaimData(claim: ClaimObject): Uint8Array {
+  const num = BigInt(String(claim.amount))
+  const prefix = HashPrefix.paymentChannelClaim
+  const channel = coreTypes.Hash256.from(claim.channel).toBytes()
+  const amount = coreTypes.UInt64.from(num).toBytes()
+
+  const bytesList = new BytesList()
+
+  bytesList.put(prefix)
+  bytesList.put(channel)
+  bytesList.put(amount)
+  return bytesList.toBytes()
+}
+
+/**
+ * Serialize a transaction object for multiSigning
+ *
+ * @param transaction transaction to serialize
+ * @param signingAccount Account to sign the transaction with
+ * @param opts.definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
+ * @returns serialized transaction with appropriate prefix and suffix
+ */
+function multiSigningData(
+  transaction: JsonObject,
+  signingAccount: string | AccountID,
+  opts: { definitions: XrplDefinitionsBase } = {
+    definitions: DEFAULT_DEFINITIONS,
+  },
+): Uint8Array {
+  const prefix = HashPrefix.transactionMultiSig
+  const suffix = coreTypes.AccountID.from(signingAccount).toBytes()
+  return serializeObject(transaction, {
+    prefix,
+    suffix,
+    signingFieldsOnly: true,
+    definitions: opts.definitions,
+  })
+}
+
+export {
+  BinaryParser,
+  BinarySerializer,
+  BytesList,
+  ClaimObject,
+  makeParser,
+  serializeObject,
+  readJSON,
+  multiSigningData,
+  signingData,
+  signingClaimData,
+  binaryToJSON,
+  sha512Half,
+  transactionID,
+}

package/src/coretypes.ts

@@ -0,0 +1,31 @@
+import {
+  DEFAULT_DEFINITIONS,
+  Field,
+  TransactionType,
+  LedgerEntryType,
+  Type,
+  TransactionResult,
+} from './enums'
+import * as types from './types'
+import * as binary from './binary'
+import { ShaMap } from './shamap'
+import * as ledgerHashes from './ledger-hashes'
+import * as hashes from './hashes'
+import { quality } from './quality'
+import { HashPrefix } from './hash-prefixes'
+
+export {
+  hashes,
+  binary,
+  ledgerHashes,
+  DEFAULT_DEFINITIONS,
+  Field,
+  TransactionType,
+  LedgerEntryType,
+  Type,
+  TransactionResult,
+  quality,
+  HashPrefix,
+  ShaMap,
+  types,
+}