@transia/ripple-binary-codec 1.4.4-alpha.0

package/dist/types/path-set.js

@@ -0,0 +1,233 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathSet = void 0;
+const account_id_1 = require("./account-id");
+const currency_1 = require("./currency");
+const binary_parser_1 = require("../serdes/binary-parser");
+const serialized_type_1 = require("./serialized-type");
+const buffer_1 = require("buffer/");
+/**
+ * Constants for separating Paths in a PathSet
+ */
+const PATHSET_END_BYTE = 0x00;
+const PATH_SEPARATOR_BYTE = 0xff;
+/**
+ * Constant for masking types of a Hop
+ */
+const TYPE_ACCOUNT = 0x01;
+const TYPE_CURRENCY = 0x10;
+const TYPE_ISSUER = 0x20;
+/**
+ * TypeGuard for HopObject
+ */
+function isHopObject(arg) {
+    return (arg.issuer !== undefined ||
+        arg.account !== undefined ||
+        arg.currency !== undefined);
+}
+/**
+ * TypeGuard for PathSet
+ */
+function isPathSet(arg) {
+    return ((Array.isArray(arg) && arg.length === 0) ||
+        (Array.isArray(arg) && Array.isArray(arg[0]) && arg[0].length === 0) ||
+        (Array.isArray(arg) && Array.isArray(arg[0]) && isHopObject(arg[0][0])));
+}
+/**
+ * Serialize and Deserialize a Hop
+ */
+class Hop extends serialized_type_1.SerializedType {
+    /**
+     * Create a Hop from a HopObject
+     *
+     * @param value Either a hop or HopObject to create a hop with
+     * @returns a Hop
+     */
+    static from(value) {
+        if (value instanceof Hop) {
+            return value;
+        }
+        const bytes = [buffer_1.Buffer.from([0])];
+        if (value.account) {
+            bytes.push(account_id_1.AccountID.from(value.account).toBytes());
+            bytes[0][0] |= TYPE_ACCOUNT;
+        }
+        if (value.currency) {
+            bytes.push(currency_1.Currency.from(value.currency).toBytes());
+            bytes[0][0] |= TYPE_CURRENCY;
+        }
+        if (value.issuer) {
+            bytes.push(account_id_1.AccountID.from(value.issuer).toBytes());
+            bytes[0][0] |= TYPE_ISSUER;
+        }
+        return new Hop(buffer_1.Buffer.concat(bytes));
+    }
+    /**
+     * Construct a Hop from a BinaryParser
+     *
+     * @param parser BinaryParser to read the Hop from
+     * @returns a Hop
+     */
+    static fromParser(parser) {
+        const type = parser.readUInt8();
+        const bytes = [buffer_1.Buffer.from([type])];
+        if (type & TYPE_ACCOUNT) {
+            bytes.push(parser.read(account_id_1.AccountID.width));
+        }
+        if (type & TYPE_CURRENCY) {
+            bytes.push(parser.read(currency_1.Currency.width));
+        }
+        if (type & TYPE_ISSUER) {
+            bytes.push(parser.read(account_id_1.AccountID.width));
+        }
+        return new Hop(buffer_1.Buffer.concat(bytes));
+    }
+    /**
+     * Get the JSON interpretation of this hop
+     *
+     * @returns a HopObject, an JS object with optional account, issuer, and currency
+     */
+    toJSON() {
+        const hopParser = new binary_parser_1.BinaryParser(this.bytes.toString('hex'));
+        const type = hopParser.readUInt8();
+        let account, currency, issuer;
+        if (type & TYPE_ACCOUNT) {
+            account = account_id_1.AccountID.fromParser(hopParser).toJSON();
+        }
+        if (type & TYPE_CURRENCY) {
+            currency = currency_1.Currency.fromParser(hopParser).toJSON();
+        }
+        if (type & TYPE_ISSUER) {
+            issuer = account_id_1.AccountID.fromParser(hopParser).toJSON();
+        }
+        const result = {};
+        if (account) {
+            result.account = account;
+        }
+        if (issuer) {
+            result.issuer = issuer;
+        }
+        if (currency) {
+            result.currency = currency;
+        }
+        return result;
+    }
+    /**
+     * get a number representing the type of this hop
+     *
+     * @returns a number to be bitwise and-ed with TYPE_ constants to describe the types in the hop
+     */
+    type() {
+        return this.bytes[0];
+    }
+}
+/**
+ * Class for serializing/deserializing Paths
+ */
+class Path extends serialized_type_1.SerializedType {
+    /**
+     * construct a Path from an array of Hops
+     *
+     * @param value Path or array of HopObjects to construct a Path
+     * @returns the Path
+     */
+    static from(value) {
+        if (value instanceof Path) {
+            return value;
+        }
+        const bytes = [];
+        value.forEach((hop) => {
+            bytes.push(Hop.from(hop).toBytes());
+        });
+        return new Path(buffer_1.Buffer.concat(bytes));
+    }
+    /**
+     * Read a Path from a BinaryParser
+     *
+     * @param parser BinaryParser to read Path from
+     * @returns the Path represented by the bytes read from the BinaryParser
+     */
+    static fromParser(parser) {
+        const bytes = [];
+        while (!parser.end()) {
+            bytes.push(Hop.fromParser(parser).toBytes());
+            if (parser.peek() === PATHSET_END_BYTE ||
+                parser.peek() === PATH_SEPARATOR_BYTE) {
+                break;
+            }
+        }
+        return new Path(buffer_1.Buffer.concat(bytes));
+    }
+    /**
+     * Get the JSON representation of this Path
+     *
+     * @returns an Array of HopObject constructed from this.bytes
+     */
+    toJSON() {
+        const json = [];
+        const pathParser = new binary_parser_1.BinaryParser(this.toString());
+        while (!pathParser.end()) {
+            json.push(Hop.fromParser(pathParser).toJSON());
+        }
+        return json;
+    }
+}
+/**
+ * Deserialize and Serialize the PathSet type
+ */
+class PathSet extends serialized_type_1.SerializedType {
+    /**
+     * Construct a PathSet from an Array of Arrays representing paths
+     *
+     * @param value A PathSet or Array of Array of HopObjects
+     * @returns the PathSet constructed from value
+     */
+    static from(value) {
+        if (value instanceof PathSet) {
+            return value;
+        }
+        if (isPathSet(value)) {
+            const bytes = [];
+            value.forEach((path) => {
+                bytes.push(Path.from(path).toBytes());
+                bytes.push(buffer_1.Buffer.from([PATH_SEPARATOR_BYTE]));
+            });
+            bytes[bytes.length - 1] = buffer_1.Buffer.from([PATHSET_END_BYTE]);
+            return new PathSet(buffer_1.Buffer.concat(bytes));
+        }
+        throw new Error('Cannot construct PathSet from given value');
+    }
+    /**
+     * Construct a PathSet from a BinaryParser
+     *
+     * @param parser A BinaryParser to read PathSet from
+     * @returns the PathSet read from parser
+     */
+    static fromParser(parser) {
+        const bytes = [];
+        while (!parser.end()) {
+            bytes.push(Path.fromParser(parser).toBytes());
+            bytes.push(parser.read(1));
+            if (bytes[bytes.length - 1][0] == PATHSET_END_BYTE) {
+                break;
+            }
+        }
+        return new PathSet(buffer_1.Buffer.concat(bytes));
+    }
+    /**
+     * Get the JSON representation of this PathSet
+     *
+     * @returns an Array of Array of HopObjects, representing this PathSet
+     */
+    toJSON() {
+        const json = [];
+        const pathParser = new binary_parser_1.BinaryParser(this.toString());
+        while (!pathParser.end()) {
+            json.push(Path.fromParser(pathParser).toJSON());
+            pathParser.skip(1);
+        }
+        return json;
+    }
+}
+exports.PathSet = PathSet;
+//# sourceMappingURL=path-set.js.map

package/dist/types/path-set.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"path-set.js","sourceRoot":"","sources":["../../src/types/path-set.ts"],"names":[],"mappings":";;;AAAA,6CAAwC;AACxC,yCAAqC;AACrC,2DAAsD;AACtD,uDAA8D;AAC9D,oCAAgC;AAEhC;;GAEG;AACH,MAAM,gBAAgB,GAAG,IAAI,CAAA;AAC7B,MAAM,mBAAmB,GAAG,IAAI,CAAA;AAEhC;;GAEG;AACH,MAAM,YAAY,GAAG,IAAI,CAAA;AACzB,MAAM,aAAa,GAAG,IAAI,CAAA;AAC1B,MAAM,WAAW,GAAG,IAAI,CAAA;AAWxB;;GAEG;AACH,SAAS,WAAW,CAAC,GAAG;IACtB,OAAO,CACL,GAAG,CAAC,MAAM,KAAK,SAAS;QACxB,GAAG,CAAC,OAAO,KAAK,SAAS;QACzB,GAAG,CAAC,QAAQ,KAAK,SAAS,CAC3B,CAAA;AACH,CAAC;AAED;;GAEG;AACH,SAAS,SAAS,CAAC,GAAG;IACpB,OAAO,CACL,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC;QACxC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;QACpE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACxE,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,GAAI,SAAQ,gCAAc;IAC9B;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,KAAsB;QAChC,IAAI,KAAK,YAAY,GAAG,EAAE;YACxB,OAAO,KAAK,CAAA;SACb;QAED,MAAM,KAAK,GAAkB,CAAC,eAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAE/C,IAAI,KAAK,CAAC,OAAO,EAAE;YACjB,KAAK,CAAC,IAAI,CAAC,sBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;YACnD,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,YAAY,CAAA;SAC5B;QAED,IAAI,KAAK,CAAC,QAAQ,EAAE;YAClB,KAAK,CAAC,IAAI,CAAC,mBAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;YACnD,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,aAAa,CAAA;SAC7B;QAED,IAAI,KAAK,CAAC,MAAM,EAAE;YAChB,KAAK,CAAC,IAAI,CAAC,sBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;YAClD,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,WAAW,CAAA;SAC3B;QAED,OAAO,IAAI,GAAG,CAAC,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IACtC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,EAAE,CAAA;QAC/B,MAAM,KAAK,GAAkB,CAAC,eAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAElD,IAAI,IAAI,GAAG,YAAY,EAAE;YACvB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAS,CAAC,KAAK,CAAC,CAAC,CAAA;SACzC;QAED,IAAI,IAAI,GAAG,aAAa,EAAE;YACxB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;SACxC;QAED,IAAI,IAAI,GAAG,WAAW,EAAE;YACtB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAS,CAAC,KAAK,CAAC,CAAC,CAAA;SACzC;QAED,OAAO,IAAI,GAAG,CAAC,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IACtC,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,SAAS,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;QAC9D,MAAM,IAAI,GAAG,SAAS,CAAC,SAAS,EAAE,CAAA;QAElC,IAAI,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAA;QAC7B,IAAI,IAAI,GAAG,YAAY,EAAE;YACvB,OAAO,GAAI,sBAAS,CAAC,UAAU,CAAC,SAAS,CAAe,CAAC,MAAM,EAAE,CAAA;SAClE;QAED,IAAI,IAAI,GAAG,aAAa,EAAE;YACxB,QAAQ,GAAI,mBAAQ,CAAC,UAAU,CAAC,SAAS,CAAc,CAAC,MAAM,EAAE,CAAA;SACjE;QAED,IAAI,IAAI,GAAG,WAAW,EAAE;YACtB,MAAM,GAAI,sBAAS,CAAC,UAAU,CAAC,SAAS,CAAe,CAAC,MAAM,EAAE,CAAA;SACjE;QAED,MAAM,MAAM,GAAc,EAAE,CAAA;QAC5B,IAAI,OAAO,EAAE;YACX,MAAM,CAAC,OAAO,GAAG,OAAO,CAAA;SACzB;QAED,IAAI,MAAM,EAAE;YACV,MAAM,CAAC,MAAM,GAAG,MAAM,CAAA;SACvB;QAED,IAAI,QAAQ,EAAE;YACZ,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAA;SAC3B;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACtB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,IAAK,SAAQ,gCAAc;IAC/B;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,KAA8B;QACxC,IAAI,KAAK,YAAY,IAAI,EAAE;YACzB,OAAO,KAAK,CAAA;SACb;QAED,MAAM,KAAK,GAAkB,EAAE,CAAA;QAC/B,KAAK,CAAC,OAAO,CAAC,CAAC,GAAc,EAAE,EAAE;YAC/B,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;QACrC,CAAC,CAAC,CAAA;QAEF,OAAO,IAAI,IAAI,CAAC,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IACvC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,MAAM,KAAK,GAAkB,EAAE,CAAA;QAC/B,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE;YACpB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;YAE5C,IACE,MAAM,CAAC,IAAI,EAAE,KAAK,gBAAgB;gBAClC,MAAM,CAAC,IAAI,EAAE,KAAK,mBAAmB,EACrC;gBACA,MAAK;aACN;SACF;QACD,OAAO,IAAI,IAAI,CAAC,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IACvC,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,IAAI,GAAqB,EAAE,CAAA;QACjC,MAAM,UAAU,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QAEpD,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE;YACxB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC,CAAA;SAC/C;QAED,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAQ,SAAQ,gCAAc;IAClC;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAA8C,KAAQ;QAC/D,IAAI,KAAK,YAAY,OAAO,EAAE;YAC5B,OAAO,KAAK,CAAA;SACb;QAED,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;YACpB,MAAM,KAAK,GAAkB,EAAE,CAAA;YAE/B,KAAK,CAAC,OAAO,CAAC,CAAC,IAAsB,EAAE,EAAE;gBACvC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;gBACrC,KAAK,CAAC,IAAI,CAAC,eAAM,CAAC,IAAI,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAA;YAChD,CAAC,CAAC,CAAA;YAEF,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,eAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAA;YAEzD,OAAO,IAAI,OAAO,CAAC,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;SACzC;QAED,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;IAC9D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,MAAM,KAAK,GAAkB,EAAE,CAAA;QAE/B,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE;YACpB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;YAC7C,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;YAE1B,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,gBAAgB,EAAE;gBAClD,MAAK;aACN;SACF;QAED,OAAO,IAAI,OAAO,CAAC,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAC1C,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,IAAI,GAA4B,EAAE,CAAA;QACxC,MAAM,UAAU,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QAEpD,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE;YACxB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC,CAAA;YAC/C,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SACnB;QAED,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAEQ,0BAAO"}

package/dist/types/serialized-type.d.ts

@@ -0,0 +1,63 @@
+import { BytesList } from '../serdes/binary-serializer';
+import { BinaryParser } from '../serdes/binary-parser';
+import bigInt = require('big-integer');
+import { Buffer } from 'buffer/';
+type JSON = string | number | boolean | null | undefined | JSON[] | JsonObject;
+type JsonObject = {
+    [key: string]: JSON;
+};
+/**
+ * The base class for all binary-codec types
+ */
+declare class SerializedType {
+    protected readonly bytes: Buffer;
+    constructor(bytes: Buffer);
+    static fromParser(parser: BinaryParser, hint?: number): SerializedType;
+    static from(value: SerializedType | JSON | bigInt.BigInteger): SerializedType;
+    /**
+     * Write the bytes representation of a SerializedType to a BytesList
+     *
+     * @param list The BytesList to write SerializedType bytes to
+     */
+    toBytesSink(list: BytesList): void;
+    /**
+     * Get the hex representation of a SerializedType's bytes
+     *
+     * @returns hex String of this.bytes
+     */
+    toHex(): string;
+    /**
+     * Get the bytes representation of a SerializedType
+     *
+     * @returns A buffer of the bytes
+     */
+    toBytes(): Buffer;
+    /**
+     * Return the JSON representation of a SerializedType
+     *
+     * @returns any type, if not overloaded returns hexString representation of bytes
+     */
+    toJSON(): JSON;
+    /**
+     * @returns hexString representation of this.bytes
+     */
+    toString(): string;
+}
+/**
+ * Base class for SerializedTypes that are comparable
+ */
+declare class Comparable extends SerializedType {
+    lt(other: Comparable): boolean;
+    eq(other: Comparable): boolean;
+    gt(other: Comparable): boolean;
+    gte(other: Comparable): boolean;
+    lte(other: Comparable): boolean;
+    /**
+     * Overload this method to define how two Comparable SerializedTypes are compared
+     *
+     * @param other The comparable object to compare this to
+     * @returns A number denoting the relationship of this and other
+     */
+    compareTo(other: Comparable): number;
+}
+export { SerializedType, Comparable, JSON, JsonObject };

package/dist/types/serialized-type.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Comparable = exports.SerializedType = void 0;
+const binary_serializer_1 = require("../serdes/binary-serializer");
+const buffer_1 = require("buffer/");
+/**
+ * The base class for all binary-codec types
+ */
+class SerializedType {
+    constructor(bytes) {
+        this.bytes = buffer_1.Buffer.alloc(0);
+        this.bytes = bytes !== null && bytes !== void 0 ? bytes : buffer_1.Buffer.alloc(0);
+    }
+    static fromParser(parser, hint) {
+        throw new Error('fromParser not implemented');
+        return this.fromParser(parser, hint);
+    }
+    static from(value) {
+        throw new Error('from not implemented');
+        return this.from(value);
+    }
+    /**
+     * Write the bytes representation of a SerializedType to a BytesList
+     *
+     * @param list The BytesList to write SerializedType bytes to
+     */
+    toBytesSink(list) {
+        list.put(this.bytes);
+    }
+    /**
+     * Get the hex representation of a SerializedType's bytes
+     *
+     * @returns hex String of this.bytes
+     */
+    toHex() {
+        return this.toBytes().toString('hex').toUpperCase();
+    }
+    /**
+     * Get the bytes representation of a SerializedType
+     *
+     * @returns A buffer of the bytes
+     */
+    toBytes() {
+        if (this.bytes) {
+            return this.bytes;
+        }
+        const bytes = new binary_serializer_1.BytesList();
+        this.toBytesSink(bytes);
+        return bytes.toBytes();
+    }
+    /**
+     * Return the JSON representation of a SerializedType
+     *
+     * @returns any type, if not overloaded returns hexString representation of bytes
+     */
+    toJSON() {
+        return this.toHex();
+    }
+    /**
+     * @returns hexString representation of this.bytes
+     */
+    toString() {
+        return this.toHex();
+    }
+}
+exports.SerializedType = SerializedType;
+/**
+ * Base class for SerializedTypes that are comparable
+ */
+class Comparable extends SerializedType {
+    lt(other) {
+        return this.compareTo(other) < 0;
+    }
+    eq(other) {
+        return this.compareTo(other) === 0;
+    }
+    gt(other) {
+        return this.compareTo(other) > 0;
+    }
+    gte(other) {
+        return this.compareTo(other) > -1;
+    }
+    lte(other) {
+        return this.compareTo(other) < 1;
+    }
+    /**
+     * Overload this method to define how two Comparable SerializedTypes are compared
+     *
+     * @param other The comparable object to compare this to
+     * @returns A number denoting the relationship of this and other
+     */
+    compareTo(other) {
+        throw new Error(`cannot compare ${this.toString()} and ${other.toString()}`);
+    }
+}
+exports.Comparable = Comparable;
+//# sourceMappingURL=serialized-type.js.map

package/dist/types/serialized-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serialized-type.js","sourceRoot":"","sources":["../../src/types/serialized-type.ts"],"names":[],"mappings":";;;AAAA,mEAAuD;AAGvD,oCAAgC;AAMhC;;GAEG;AACH,MAAM,cAAc;IAGlB,YAAY,KAAa;QAFN,UAAK,GAAW,eAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAGhD,IAAI,CAAC,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,eAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACvC,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,MAAoB,EAAE,IAAa;QACnD,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;QAC7C,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACtC,CAAC;IAED,MAAM,CAAC,IAAI,CACT,KAAgD;QAEhD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACzB,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,IAAe;QACzB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACtB,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAA;IACrD,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,OAAO,IAAI,CAAC,KAAK,CAAA;SAClB;QACD,MAAM,KAAK,GAAG,IAAI,6BAAS,EAAE,CAAA;QAC7B,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;QACvB,OAAO,KAAK,CAAC,OAAO,EAAE,CAAA;IACxB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;CACF;AAqCQ,wCAAc;AAnCvB;;GAEG;AACH,MAAM,UAAW,SAAQ,cAAc;IACrC,EAAE,CAAC,KAAiB;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAClC,CAAC;IAED,EAAE,CAAC,KAAiB;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IACpC,CAAC;IAED,EAAE,CAAC,KAAiB;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAClC,CAAC;IAED,GAAG,CAAC,KAAiB;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;IACnC,CAAC;IAED,GAAG,CAAC,KAAiB;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAClC,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,KAAiB;QACzB,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,CAAC,QAAQ,EAAE,QAAQ,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IAC9E,CAAC;CACF;AAEwB,gCAAU"}

package/dist/types/st-array.d.ts

@@ -0,0 +1,28 @@
+import { SerializedType, JsonObject } from './serialized-type';
+import { BinaryParser } from '../serdes/binary-parser';
+/**
+ * Class for serializing and deserializing Arrays of Objects
+ */
+declare class STArray extends SerializedType {
+    /**
+     * Construct an STArray from a BinaryParser
+     *
+     * @param parser BinaryParser to parse an STArray from
+     * @returns An STArray Object
+     */
+    static fromParser(parser: BinaryParser): STArray;
+    /**
+     * Construct an STArray from an Array of JSON Objects
+     *
+     * @param value STArray or Array of Objects to parse into an STArray
+     * @returns An STArray object
+     */
+    static from<T extends STArray | Array<JsonObject>>(value: T): STArray;
+    /**
+     * Return the JSON representation of this.bytes
+     *
+     * @returns An Array of JSON objects
+     */
+    toJSON(): Array<JsonObject>;
+}
+export { STArray };

package/dist/types/st-array.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STArray = void 0;
+const serialized_type_1 = require("./serialized-type");
+const st_object_1 = require("./st-object");
+const binary_parser_1 = require("../serdes/binary-parser");
+const buffer_1 = require("buffer/");
+const ARRAY_END_MARKER = buffer_1.Buffer.from([0xf1]);
+const ARRAY_END_MARKER_NAME = 'ArrayEndMarker';
+const OBJECT_END_MARKER = buffer_1.Buffer.from([0xe1]);
+/**
+ * TypeGuard for Array<JsonObject>
+ */
+function isObjects(args) {
+    return (Array.isArray(args) && (args.length === 0 || typeof args[0] === 'object'));
+}
+/**
+ * Class for serializing and deserializing Arrays of Objects
+ */
+class STArray extends serialized_type_1.SerializedType {
+    /**
+     * Construct an STArray from a BinaryParser
+     *
+     * @param parser BinaryParser to parse an STArray from
+     * @returns An STArray Object
+     */
+    static fromParser(parser) {
+        const bytes = [];
+        while (!parser.end()) {
+            const field = parser.readField();
+            if (field.name === ARRAY_END_MARKER_NAME) {
+                break;
+            }
+            bytes.push(field.header, parser.readFieldValue(field).toBytes(), OBJECT_END_MARKER);
+        }
+        bytes.push(ARRAY_END_MARKER);
+        return new STArray(buffer_1.Buffer.concat(bytes));
+    }
+    /**
+     * Construct an STArray from an Array of JSON Objects
+     *
+     * @param value STArray or Array of Objects to parse into an STArray
+     * @returns An STArray object
+     */
+    static from(value) {
+        if (value instanceof STArray) {
+            return value;
+        }
+        if (isObjects(value)) {
+            const bytes = [];
+            value.forEach((obj) => {
+                bytes.push(st_object_1.STObject.from(obj).toBytes());
+            });
+            bytes.push(ARRAY_END_MARKER);
+            return new STArray(buffer_1.Buffer.concat(bytes));
+        }
+        throw new Error('Cannot construct STArray from value given');
+    }
+    /**
+     * Return the JSON representation of this.bytes
+     *
+     * @returns An Array of JSON objects
+     */
+    toJSON() {
+        const result = [];
+        const arrayParser = new binary_parser_1.BinaryParser(this.toString());
+        while (!arrayParser.end()) {
+            const field = arrayParser.readField();
+            if (field.name === ARRAY_END_MARKER_NAME) {
+                break;
+            }
+            const outer = {};
+            outer[field.name] = st_object_1.STObject.fromParser(arrayParser).toJSON();
+            result.push(outer);
+        }
+        return result;
+    }
+}
+exports.STArray = STArray;
+//# sourceMappingURL=st-array.js.map

package/dist/types/st-array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"st-array.js","sourceRoot":"","sources":["../../src/types/st-array.ts"],"names":[],"mappings":";;;AAAA,uDAA8D;AAC9D,2CAAsC;AACtC,2DAAsD;AACtD,oCAAgC;AAEhC,MAAM,gBAAgB,GAAG,eAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;AAC5C,MAAM,qBAAqB,GAAG,gBAAgB,CAAA;AAE9C,MAAM,iBAAiB,GAAG,eAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;AAE7C;;GAEG;AACH,SAAS,SAAS,CAAC,IAAI;IACrB,OAAO,CACL,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAC1E,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,OAAQ,SAAQ,gCAAc;IAClC;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,MAAM,KAAK,GAAkB,EAAE,CAAA;QAE/B,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE;YACpB,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,EAAE,CAAA;YAChC,IAAI,KAAK,CAAC,IAAI,KAAK,qBAAqB,EAAE;gBACxC,MAAK;aACN;YAED,KAAK,CAAC,IAAI,CACR,KAAK,CAAC,MAAM,EACZ,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EACtC,iBAAiB,CAClB,CAAA;SACF;QAED,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAC5B,OAAO,IAAI,OAAO,CAAC,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAC1C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAwC,KAAQ;QACzD,IAAI,KAAK,YAAY,OAAO,EAAE;YAC5B,OAAO,KAAK,CAAA;SACb;QAED,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;YACpB,MAAM,KAAK,GAAkB,EAAE,CAAA;YAC/B,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBACpB,KAAK,CAAC,IAAI,CAAC,oBAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;YAC1C,CAAC,CAAC,CAAA;YAEF,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;YAC5B,OAAO,IAAI,OAAO,CAAC,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;SACzC;QAED,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;IAC9D,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,MAAM,GAAsB,EAAE,CAAA;QAEpC,MAAM,WAAW,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QAErD,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE;YACzB,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,EAAE,CAAA;YACrC,IAAI,KAAK,CAAC,IAAI,KAAK,qBAAqB,EAAE;gBACxC,MAAK;aACN;YAED,MAAM,KAAK,GAAG,EAAE,CAAA;YAChB,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,oBAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,MAAM,EAAE,CAAA;YAC7D,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;SACnB;QAED,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAEQ,0BAAO"}

package/dist/types/st-object.d.ts

@@ -0,0 +1,32 @@
+import { XrplDefinitionsBase } from '../enums';
+import { SerializedType, JsonObject } from './serialized-type';
+import { BinaryParser } from '../serdes/binary-parser';
+/**
+ * Class for Serializing/Deserializing objects
+ */
+declare class STObject extends SerializedType {
+    /**
+     * Construct a STObject from a BinaryParser
+     *
+     * @param parser BinaryParser to read STObject from
+     * @returns A STObject object
+     */
+    static fromParser(parser: BinaryParser): STObject;
+    /**
+     * 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<T extends STObject | JsonObject>(value: T, filter?: (...any: any[]) => boolean, definitions?: XrplDefinitionsBase): STObject;
+    /**
+     * 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?: XrplDefinitionsBase): JsonObject;
+}
+export { STObject };