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

package/dist/src/types/issue.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Issue = void 0;
+const utils_1 = require("@transia/isomorphic/utils");
+const binary_parser_1 = require("../serdes/binary-parser");
+const account_id_1 = require("./account-id");
+const currency_1 = require("./currency");
+const serialized_type_1 = require("./serialized-type");
+const hash_192_1 = require("./hash-192");
+/**
+ * Type guard for Issue Object
+ */
+function isIssueObject(arg) {
+    const keys = Object.keys(arg).sort();
+    const isXRP = keys.length === 1 && keys[0] === 'currency';
+    const isIOU = keys.length === 2 && keys[0] === 'currency' && keys[1] === 'issuer';
+    const isMPT = keys.length === 1 && keys[0] === 'mpt_issuance_id';
+    return isXRP || isIOU || isMPT;
+}
+/**
+ * Class for serializing/Deserializing Amounts
+ */
+class Issue extends serialized_type_1.SerializedType {
+    constructor(bytes) {
+        super(bytes !== null && bytes !== void 0 ? bytes : Issue.ZERO_ISSUED_CURRENCY.bytes);
+    }
+    /**
+     * Construct an amount from an IOU or string amount
+     *
+     * @param value An Amount, object representing an IOU, MPTAmount, or a string
+     *     representing an integer amount
+     * @returns An Issue object
+     */
+    static from(value) {
+        if (value instanceof Issue) {
+            return value;
+        }
+        if (isIssueObject(value)) {
+            if (value.currency) {
+                const currency = currency_1.Currency.from(value.currency.toString()).toBytes();
+                //IOU case
+                if (value.issuer) {
+                    const issuer = account_id_1.AccountID.from(value.issuer.toString()).toBytes();
+                    return new Issue((0, utils_1.concat)([currency, issuer]));
+                }
+                //XRP case
+                return new Issue(currency);
+            }
+            // MPT case
+            if (value.mpt_issuance_id) {
+                const mptIssuanceIdBytes = hash_192_1.Hash192.from(value.mpt_issuance_id.toString()).toBytes();
+                return new Issue(mptIssuanceIdBytes);
+            }
+        }
+        throw new Error('Invalid type to construct an Amount');
+    }
+    /**
+     * Read an amount from a BinaryParser
+     *
+     * @param parser BinaryParser to read the Amount from
+     * @param hint The number of bytes to consume from the parser.
+     * For an MPT amount, pass 24 (the fixed length for Hash192).
+     *
+     * @returns An Issue object
+     */
+    static fromParser(parser, hint) {
+        if (hint === hash_192_1.Hash192.width) {
+            const mptBytes = parser.read(hash_192_1.Hash192.width);
+            return new Issue(mptBytes);
+        }
+        const currency = parser.read(20);
+        if (new currency_1.Currency(currency).toJSON() === 'XRP') {
+            return new Issue(currency);
+        }
+        const currencyAndIssuer = [currency, parser.read(20)];
+        return new Issue((0, utils_1.concat)(currencyAndIssuer));
+    }
+    /**
+     * Get the JSON representation of this Amount
+     *
+     * @returns the JSON interpretation of this.bytes
+     */
+    toJSON() {
+        // If the buffer is exactly 24 bytes, treat it as an MPT amount.
+        if (this.toBytes().length === hash_192_1.Hash192.width) {
+            return {
+                mpt_issuance_id: this.toHex().toUpperCase(),
+            };
+        }
+        const parser = new binary_parser_1.BinaryParser(this.toString());
+        const currency = currency_1.Currency.fromParser(parser);
+        if (currency.toJSON() === 'XRP') {
+            return { currency: currency.toJSON() };
+        }
+        const issuer = account_id_1.AccountID.fromParser(parser);
+        return {
+            currency: currency.toJSON(),
+            issuer: issuer.toJSON(),
+        };
+    }
+}
+exports.Issue = Issue;
+Issue.ZERO_ISSUED_CURRENCY = new Issue(new Uint8Array(20));
+//# sourceMappingURL=issue.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"issue.js","sourceRoot":"","sources":["../../../src/types/issue.ts"],"names":[],"mappings":";;;AAAA,qDAAkD;AAClD,2DAAsD;AAEtD,6CAAwC;AACxC,yCAAqC;AACrC,uDAA8D;AAC9D,yCAAoC;AAkBpC;;GAEG;AACH,SAAS,aAAa,CAAC,GAAG;IACxB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IACpC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,CAAA;IACzD,MAAM,KAAK,GACT,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAA;IACrE,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,iBAAiB,CAAA;IAEhE,OAAO,KAAK,IAAI,KAAK,IAAI,KAAK,CAAA;AAChC,CAAC;AAED;;GAEG;AACH,MAAM,KAAM,SAAQ,gCAAc;IAGhC,YAAY,KAAiB;QAC3B,KAAK,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAA;IAClD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAgC,KAAQ;QACjD,IAAI,KAAK,YAAY,KAAK,EAAE;YAC1B,OAAO,KAAK,CAAA;SACb;QAED,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE;YACxB,IAAI,KAAK,CAAC,QAAQ,EAAE;gBAClB,MAAM,QAAQ,GAAG,mBAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAA;gBAEnE,UAAU;gBACV,IAAI,KAAK,CAAC,MAAM,EAAE;oBAChB,MAAM,MAAM,GAAG,sBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAA;oBAChE,OAAO,IAAI,KAAK,CAAC,IAAA,cAAM,EAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAA;iBAC7C;gBAED,UAAU;gBACV,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAA;aAC3B;YAED,WAAW;YACX,IAAI,KAAK,CAAC,eAAe,EAAE;gBACzB,MAAM,kBAAkB,GAAG,kBAAO,CAAC,IAAI,CACrC,KAAK,CAAC,eAAe,CAAC,QAAQ,EAAE,CACjC,CAAC,OAAO,EAAE,CAAA;gBACX,OAAO,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAA;aACrC;SACF;QAED,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;IACxD,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB,EAAE,IAAa;QACnD,IAAI,IAAI,KAAK,kBAAO,CAAC,KAAK,EAAE;YAC1B,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,kBAAO,CAAC,KAAK,CAAC,CAAA;YAC3C,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAA;SAC3B;QACD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAChC,IAAI,IAAI,mBAAQ,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,KAAK,KAAK,EAAE;YAC7C,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAA;SAC3B;QACD,MAAM,iBAAiB,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;QACrD,OAAO,IAAI,KAAK,CAAC,IAAA,cAAM,EAAC,iBAAiB,CAAC,CAAC,CAAA;IAC7C,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,gEAAgE;QAChE,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,KAAK,kBAAO,CAAC,KAAK,EAAE;YAC3C,OAAO;gBACL,eAAe,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE;aAC5C,CAAA;SACF;QAED,MAAM,MAAM,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QAEhD,MAAM,QAAQ,GAAG,mBAAQ,CAAC,UAAU,CAAC,MAAM,CAAa,CAAA;QACxD,IAAI,QAAQ,CAAC,MAAM,EAAE,KAAK,KAAK,EAAE;YAC/B,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAA;SACvC;QACD,MAAM,MAAM,GAAG,sBAAS,CAAC,UAAU,CAAC,MAAM,CAAc,CAAA;QAExD,OAAO;YACL,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE;YAC3B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;SACxB,CAAA;IACH,CAAC;;AAGM,sBAAK;AA9FI,0BAAoB,GAAU,IAAI,KAAK,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,CAAA"}

package/dist/src/types/path-set.d.ts

@@ -0,0 +1,36 @@
+import { BinaryParser } from '../serdes/binary-parser';
+import { SerializedType, JsonObject } from './serialized-type';
+/**
+ * The object representation of a Hop, an issuer AccountID, an account AccountID, and a Currency
+ */
+interface HopObject extends JsonObject {
+    issuer?: string;
+    account?: string;
+    currency?: string;
+}
+/**
+ * Deserialize and Serialize the PathSet type
+ */
+declare class PathSet extends 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<T extends PathSet | Array<Array<HopObject>>>(value: T): PathSet;
+    /**
+     * Construct a PathSet from a BinaryParser
+     *
+     * @param parser A BinaryParser to read PathSet from
+     * @returns the PathSet read from parser
+     */
+    static fromParser(parser: BinaryParser): PathSet;
+    /**
+     * Get the JSON representation of this PathSet
+     *
+     * @returns an Array of Array of HopObjects, representing this PathSet
+     */
+    toJSON(): Array<Array<HopObject>>;
+}
+export { PathSet };

package/dist/src/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 utils_1 = require("@transia/isomorphic/utils");
+/**
+ * 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 = [Uint8Array.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((0, utils_1.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 = [Uint8Array.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((0, utils_1.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((0, utils_1.bytesToHex)(this.bytes));
+        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((0, utils_1.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((0, utils_1.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(Uint8Array.from([PATH_SEPARATOR_BYTE]));
+            });
+            bytes[bytes.length - 1] = Uint8Array.from([PATHSET_END_BYTE]);
+            return new PathSet((0, utils_1.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((0, utils_1.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/src/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,qDAA8D;AAE9D;;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,GAAsB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAEvD,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,IAAA,cAAM,EAAC,KAAK,CAAC,CAAC,CAAA;IAC/B,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,EAAE,CAAA;QAC/B,MAAM,KAAK,GAAsB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAE1D,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,IAAA,cAAM,EAAC,KAAK,CAAC,CAAC,CAAA;IAC/B,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,SAAS,GAAG,IAAI,4BAAY,CAAC,IAAA,kBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;QAC1D,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,GAAsB,EAAE,CAAA;QACnC,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,IAAA,cAAM,EAAC,KAAK,CAAC,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,MAAM,KAAK,GAAsB,EAAE,CAAA;QACnC,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,IAAA,cAAM,EAAC,KAAK,CAAC,CAAC,CAAA;IAChC,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,GAAsB,EAAE,CAAA;YAEnC,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,UAAU,CAAC,IAAI,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAA;YACpD,CAAC,CAAC,CAAA;YAEF,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAA;YAE7D,OAAO,IAAI,OAAO,CAAC,IAAA,cAAM,EAAC,KAAK,CAAC,CAAC,CAAA;SAClC;QAED,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;IAC9D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,MAAM,KAAK,GAAsB,EAAE,CAAA;QAEnC,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,IAAA,cAAM,EAAC,KAAK,CAAC,CAAC,CAAA;IACnC,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/src/types/serialized-type.d.ts

@@ -0,0 +1,70 @@
+import { BytesList } from '../serdes/binary-serializer';
+import { BinaryParser } from '../serdes/binary-parser';
+import { XrplDefinitionsBase } from '../enums';
+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: Uint8Array;
+    constructor(bytes?: Uint8Array);
+    static fromParser(parser: BinaryParser, hint?: number): SerializedType;
+    static from(value: SerializedType | JSON | bigint): 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 Uint8Array of the bytes
+     */
+    toBytes(): Uint8Array;
+    /**
+     * Return the JSON representation of a SerializedType
+     *
+     * @param _definitions rippled definitions used to parse the values of transaction types and such.
+     *                          Unused in default, but used in STObject, STArray
+     *                          Can be customized for sidechains and amendments.
+     * @returns any type, if not overloaded returns hexString representation of bytes
+     */
+    toJSON(_definitions?: XrplDefinitionsBase, _fieldName?: string): JSON;
+    /**
+     * @returns hexString representation of this.bytes
+     */
+    toString(): string;
+}
+/**
+ * Base class for SerializedTypes that are comparable.
+ *
+ * @template T - What types you want to allow comparisons between. You must specify all types. Primarily used to allow
+ * comparisons between built-in types (like `string`) and SerializedType subclasses (like `Hash`).
+ *
+ * Ex. `class Hash extends Comparable<Hash | string>`
+ */
+declare class Comparable<T extends Object> extends SerializedType {
+    lt(other: T): boolean;
+    eq(other: T): boolean;
+    gt(other: T): boolean;
+    gte(other: T): boolean;
+    lte(other: T): 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: T): number;
+}
+export { SerializedType, Comparable, JSON, JsonObject };

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

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Comparable = exports.SerializedType = void 0;
+const binary_serializer_1 = require("../serdes/binary-serializer");
+const utils_1 = require("@transia/isomorphic/utils");
+/**
+ * The base class for all binary-codec types
+ */
+class SerializedType {
+    constructor(bytes) {
+        this.bytes = new Uint8Array(0);
+        this.bytes = bytes !== null && bytes !== void 0 ? bytes : new Uint8Array(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 (0, utils_1.bytesToHex)(this.toBytes());
+    }
+    /**
+     * Get the bytes representation of a SerializedType
+     *
+     * @returns A Uint8Array 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
+     *
+     * @param _definitions rippled definitions used to parse the values of transaction types and such.
+     *                          Unused in default, but used in STObject, STArray
+     *                          Can be customized for sidechains and amendments.
+     * @returns any type, if not overloaded returns hexString representation of bytes
+     */
+    toJSON(_definitions, _fieldName) {
+        return this.toHex();
+    }
+    /**
+     * @returns hexString representation of this.bytes
+     */
+    toString() {
+        return this.toHex();
+    }
+}
+exports.SerializedType = SerializedType;
+/**
+ * Base class for SerializedTypes that are comparable.
+ *
+ * @template T - What types you want to allow comparisons between. You must specify all types. Primarily used to allow
+ * comparisons between built-in types (like `string`) and SerializedType subclasses (like `Hash`).
+ *
+ * Ex. `class Hash extends Comparable<Hash | string>`
+ */
+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/src/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,qDAAsD;AAMtD;;GAEG;AACH,MAAM,cAAc;IAGlB,YAAY,KAAkB;QAFX,UAAK,GAAe,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;QAGtD,IAAI,CAAC,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;IACzC,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,CAAC,KAAqC;QAC/C,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,IAAA,kBAAU,EAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;IACnC,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;;;;;;;OAOG;IACH,MAAM,CAAC,YAAkC,EAAE,UAAmB;QAC5D,OAAO,IAAI,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;CACF;AA0CQ,wCAAc;AAxCvB;;;;;;;GAOG;AACH,MAAM,UAA6B,SAAQ,cAAc;IACvD,EAAE,CAAC,KAAQ;QACT,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAClC,CAAC;IAED,EAAE,CAAC,KAAQ;QACT,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IACpC,CAAC;IAED,EAAE,CAAC,KAAQ;QACT,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAClC,CAAC;IAED,GAAG,CAAC,KAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;IACnC,CAAC;IAED,GAAG,CAAC,KAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAClC,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,KAAQ;QAChB,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,CAAC,QAAQ,EAAE,QAAQ,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IAC9E,CAAC;CACF;AAEwB,gCAAU"}

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

@@ -0,0 +1,31 @@
+import { XrplDefinitionsBase } from '../enums';
+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
+     * @param definitions optional, types and values to use to encode/decode a transaction
+     * @returns An STArray object
+     */
+    static from<T extends STArray | Array<JsonObject>>(value: T, definitions?: XrplDefinitionsBase): STArray;
+    /**
+     * Return the JSON representation of this.bytes
+     *
+     * @param definitions optional, types and values to use to encode/decode a transaction
+     * @returns An Array of JSON objects
+     */
+    toJSON(definitions?: XrplDefinitionsBase): Array<JsonObject>;
+}
+export { STArray };