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

package/dist/src/types/currency.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Currency = void 0;
+const hash_160_1 = require("./hash-160");
+const utils_1 = require("@xrplf/isomorphic/utils");
+const XRP_HEX_REGEX = /^0{40}$/;
+const ISO_REGEX = /^[A-Z0-9a-z?!@#$%^&*(){}[\]|]{3}$/;
+const HEX_REGEX = /^[A-F0-9]{40}$/;
+// eslint-disable-next-line no-control-regex
+const STANDARD_FORMAT_HEX_REGEX = /^0{24}[\x00-\x7F]{6}0{10}$/;
+/**
+ * Convert an ISO code to a currency bytes representation
+ */
+function isoToBytes(iso) {
+    const bytes = new Uint8Array(20);
+    if (iso !== 'XRP') {
+        const isoBytes = iso.split('').map((c) => c.charCodeAt(0));
+        bytes.set(isoBytes, 12);
+    }
+    return bytes;
+}
+/**
+ * Tests if ISO is a valid iso code
+ */
+function isIsoCode(iso) {
+    return ISO_REGEX.test(iso);
+}
+function isoCodeFromHex(code) {
+    const iso = (0, utils_1.hexToString)((0, utils_1.bytesToHex)(code));
+    if (iso === 'XRP') {
+        return null;
+    }
+    if (isIsoCode(iso)) {
+        return iso;
+    }
+    return null;
+}
+/**
+ * Tests if hex is a valid hex-string
+ */
+function isHex(hex) {
+    return HEX_REGEX.test(hex);
+}
+/**
+ * Tests if a string is a valid representation of a currency
+ */
+function isStringRepresentation(input) {
+    return input.length === 3 || isHex(input);
+}
+/**
+ * Tests if a Uint8Array is a valid representation of a currency
+ */
+function isBytesArray(bytes) {
+    return bytes.byteLength === 20;
+}
+/**
+ * Ensures that a value is a valid representation of a currency
+ */
+function isValidRepresentation(input) {
+    return input instanceof Uint8Array
+        ? isBytesArray(input)
+        : isStringRepresentation(input);
+}
+/**
+ * Generate bytes from a string or UInt8Array representation of a currency
+ */
+function bytesFromRepresentation(input) {
+    if (!isValidRepresentation(input)) {
+        throw new Error(`Unsupported Currency representation: ${input}`);
+    }
+    return input.length === 3 ? isoToBytes(input) : (0, utils_1.hexToBytes)(input);
+}
+/**
+ * Class defining how to encode and decode Currencies
+ */
+class Currency extends hash_160_1.Hash160 {
+    constructor(byteBuf) {
+        super(byteBuf !== null && byteBuf !== void 0 ? byteBuf : Currency.XRP.bytes);
+        const hex = (0, utils_1.bytesToHex)(this.bytes);
+        if (XRP_HEX_REGEX.test(hex)) {
+            this._iso = 'XRP';
+        }
+        else if (STANDARD_FORMAT_HEX_REGEX.test(hex)) {
+            this._iso = isoCodeFromHex(this.bytes.slice(12, 15));
+        }
+        else {
+            this._iso = null;
+        }
+    }
+    /**
+     * Return the ISO code of this currency
+     *
+     * @returns ISO code if it exists, else null
+     */
+    iso() {
+        return this._iso;
+    }
+    /**
+     * Constructs a Currency object
+     *
+     * @param val Currency object or a string representation of a currency
+     */
+    static from(value) {
+        if (value instanceof Currency) {
+            return value;
+        }
+        if (typeof value === 'string') {
+            return new Currency(bytesFromRepresentation(value));
+        }
+        throw new Error('Cannot construct Currency from value given');
+    }
+    /**
+     * Gets the JSON representation of a currency
+     *
+     * @returns JSON representation
+     */
+    toJSON() {
+        const iso = this.iso();
+        if (iso !== null) {
+            return iso;
+        }
+        return (0, utils_1.bytesToHex)(this.bytes);
+    }
+}
+exports.Currency = Currency;
+Currency.XRP = new Currency(new Uint8Array(20));
+//# sourceMappingURL=currency.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../../src/types/currency.ts"],"names":[],"mappings":";;;AAAA,yCAAoC;AACpC,mDAA6E;AAE7E,MAAM,aAAa,GAAG,SAAS,CAAA;AAC/B,MAAM,SAAS,GAAG,mCAAmC,CAAA;AACrD,MAAM,SAAS,GAAG,gBAAgB,CAAA;AAClC,4CAA4C;AAC5C,MAAM,yBAAyB,GAAG,4BAA4B,CAAA;AAE9D;;GAEG;AACH,SAAS,UAAU,CAAC,GAAW;IAC7B,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC,CAAA;IAChC,IAAI,GAAG,KAAK,KAAK,EAAE;QACjB,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;QAC1D,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;KACxB;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;GAEG;AACH,SAAS,SAAS,CAAC,GAAW;IAC5B,OAAO,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAC5B,CAAC;AAED,SAAS,cAAc,CAAC,IAAgB;IACtC,MAAM,GAAG,GAAG,IAAA,mBAAW,EAAC,IAAA,kBAAU,EAAC,IAAI,CAAC,CAAC,CAAA;IACzC,IAAI,GAAG,KAAK,KAAK,EAAE;QACjB,OAAO,IAAI,CAAA;KACZ;IACD,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;QAClB,OAAO,GAAG,CAAA;KACX;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;GAEG;AACH,SAAS,KAAK,CAAC,GAAW;IACxB,OAAO,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAC5B,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,KAAa;IAC3C,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAA;AAC3C,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CAAC,KAAiB;IACrC,OAAO,KAAK,CAAC,UAAU,KAAK,EAAE,CAAA;AAChC,CAAC;AAED;;GAEG;AACH,SAAS,qBAAqB,CAAC,KAA0B;IACvD,OAAO,KAAK,YAAY,UAAU;QAChC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC;QACrB,CAAC,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAA;AACnC,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB,CAAC,KAAa;IAC5C,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,wCAAwC,KAAK,EAAE,CAAC,CAAA;KACjE;IACD,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,kBAAU,EAAC,KAAK,CAAC,CAAA;AACnE,CAAC;AAED;;GAEG;AACH,MAAM,QAAS,SAAQ,kBAAO;IAI5B,YAAY,OAAmB;QAC7B,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QACpC,MAAM,GAAG,GAAG,IAAA,kBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAElC,IAAI,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAC3B,IAAI,CAAC,IAAI,GAAG,KAAK,CAAA;SAClB;aAAM,IAAI,yBAAyB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAC9C,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAA;SACrD;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;SACjB;IACH,CAAC;IAED;;;;OAIG;IACH,GAAG;QACD,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAA6B,KAAQ;QAC9C,IAAI,KAAK,YAAY,QAAQ,EAAE;YAC7B,OAAO,KAAK,CAAA;SACb;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,QAAQ,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC,CAAA;SACpD;QAED,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;IAC/D,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACtB,IAAI,GAAG,KAAK,IAAI,EAAE;YAChB,OAAO,GAAG,CAAA;SACX;QACD,OAAO,IAAA,kBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC/B,CAAC;;AAGM,4BAAQ;AAxDC,YAAG,GAAG,IAAI,QAAQ,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,CAAA"}

package/dist/src/types/hash-128.d.ts

@@ -0,0 +1,16 @@
+import { Hash } from './hash';
+/**
+ * Hash with a width of 128 bits
+ */
+declare class Hash128 extends Hash {
+    static readonly width = 16;
+    static readonly ZERO_128: Hash128;
+    constructor(bytes: Uint8Array);
+    /**
+     * Get the hex representation of a hash-128 bytes, allowing unset
+     *
+     * @returns hex String of this.bytes
+     */
+    toHex(): string;
+}
+export { Hash128 };

package/dist/src/types/hash-128.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Hash128 = void 0;
+const hash_1 = require("./hash");
+const utils_1 = require("@xrplf/isomorphic/utils");
+/**
+ * Hash with a width of 128 bits
+ */
+class Hash128 extends hash_1.Hash {
+    constructor(bytes) {
+        if (bytes && bytes.byteLength === 0) {
+            bytes = Hash128.ZERO_128.bytes;
+        }
+        super(bytes !== null && bytes !== void 0 ? bytes : Hash128.ZERO_128.bytes);
+    }
+    /**
+     * Get the hex representation of a hash-128 bytes, allowing unset
+     *
+     * @returns hex String of this.bytes
+     */
+    toHex() {
+        const hex = (0, utils_1.bytesToHex)(this.toBytes());
+        if (/^0+$/.exec(hex)) {
+            return '';
+        }
+        return hex;
+    }
+}
+exports.Hash128 = Hash128;
+Hash128.width = 16;
+Hash128.ZERO_128 = new Hash128(new Uint8Array(Hash128.width));
+//# sourceMappingURL=hash-128.js.map

package/dist/src/types/hash-128.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash-128.js","sourceRoot":"","sources":["../../../src/types/hash-128.ts"],"names":[],"mappings":";;;AAAA,iCAA6B;AAC7B,mDAAoD;AAEpD;;GAEG;AACH,MAAM,OAAQ,SAAQ,WAAI;IAIxB,YAAY,KAAiB;QAC3B,IAAI,KAAK,IAAI,KAAK,CAAC,UAAU,KAAK,CAAC,EAAE;YACnC,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAA;SAC/B;QAED,KAAK,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;IACxC,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,MAAM,GAAG,GAAG,IAAA,kBAAU,EAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;QACtC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YACpB,OAAO,EAAE,CAAA;SACV;QACD,OAAO,GAAG,CAAA;IACZ,CAAC;;AAGM,0BAAO;AAzBE,aAAK,GAAG,EAAE,CAAA;AACV,gBAAQ,GAAY,IAAI,OAAO,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA"}

package/dist/src/types/hash-160.d.ts

@@ -0,0 +1,10 @@
+import { Hash } from './hash';
+/**
+ * Hash with a width of 160 bits
+ */
+declare class Hash160 extends Hash {
+    static readonly width = 20;
+    static readonly ZERO_160: Hash160;
+    constructor(bytes?: Uint8Array);
+}
+export { Hash160 };

package/dist/src/types/hash-160.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Hash160 = void 0;
+const hash_1 = require("./hash");
+/**
+ * Hash with a width of 160 bits
+ */
+class Hash160 extends hash_1.Hash {
+    constructor(bytes) {
+        if (bytes && bytes.byteLength === 0) {
+            bytes = Hash160.ZERO_160.bytes;
+        }
+        super(bytes !== null && bytes !== void 0 ? bytes : Hash160.ZERO_160.bytes);
+    }
+}
+exports.Hash160 = Hash160;
+Hash160.width = 20;
+Hash160.ZERO_160 = new Hash160(new Uint8Array(Hash160.width));
+//# sourceMappingURL=hash-160.js.map

package/dist/src/types/hash-160.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash-160.js","sourceRoot":"","sources":["../../../src/types/hash-160.ts"],"names":[],"mappings":";;;AAAA,iCAA6B;AAE7B;;GAEG;AACH,MAAM,OAAQ,SAAQ,WAAI;IAIxB,YAAY,KAAkB;QAC5B,IAAI,KAAK,IAAI,KAAK,CAAC,UAAU,KAAK,CAAC,EAAE;YACnC,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAA;SAC/B;QAED,KAAK,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;IACxC,CAAC;;AAGM,0BAAO;AAZE,aAAK,GAAG,EAAE,CAAA;AACV,gBAAQ,GAAY,IAAI,OAAO,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA"}

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

@@ -0,0 +1,10 @@
+import { Hash } from './hash';
+/**
+ * Hash with a width of 256 bits
+ */
+declare class Hash256 extends Hash {
+    static readonly width = 32;
+    static readonly ZERO_256: Hash256;
+    constructor(bytes: Uint8Array);
+}
+export { Hash256 };

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Hash256 = void 0;
+const hash_1 = require("./hash");
+/**
+ * Hash with a width of 256 bits
+ */
+class Hash256 extends hash_1.Hash {
+    constructor(bytes) {
+        super(bytes !== null && bytes !== void 0 ? bytes : Hash256.ZERO_256.bytes);
+    }
+}
+exports.Hash256 = Hash256;
+Hash256.width = 32;
+Hash256.ZERO_256 = new Hash256(new Uint8Array(Hash256.width));
+//# sourceMappingURL=hash-256.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hash-256.js","sourceRoot":"","sources":["../../../src/types/hash-256.ts"],"names":[],"mappings":";;;AAAA,iCAA6B;AAE7B;;GAEG;AACH,MAAM,OAAQ,SAAQ,WAAI;IAIxB,YAAY,KAAiB;QAC3B,KAAK,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;IACxC,CAAC;;AAGM,0BAAO;AARE,aAAK,GAAG,EAAE,CAAA;AACV,gBAAQ,GAAG,IAAI,OAAO,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA"}

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

@@ -0,0 +1,40 @@
+import { Comparable } from './serialized-type';
+import { BinaryParser } from '../serdes/binary-parser';
+/**
+ * Base class defining how to encode and decode hashes
+ */
+declare class Hash extends Comparable<Hash | string> {
+    static readonly width: number;
+    constructor(bytes: Uint8Array);
+    /**
+     * Construct a Hash object from an existing Hash object or a hex-string
+     *
+     * @param value A hash object or hex-string of a hash
+     */
+    static from<T extends Hash | string>(value: T): Hash;
+    /**
+     * Read a Hash object from a BinaryParser
+     *
+     * @param parser BinaryParser to read the hash from
+     * @param hint length of the bytes to read, optional
+     */
+    static fromParser(parser: BinaryParser, hint?: number): Hash;
+    /**
+     * Overloaded operator for comparing two hash objects
+     *
+     * @param other The Hash to compare this to
+     */
+    compareTo(other: Hash): number;
+    /**
+     * @returns the hex-string representation of this Hash
+     */
+    toString(): string;
+    /**
+     * Returns four bits at the specified depth within a hash
+     *
+     * @param depth The depth of the four bits
+     * @returns The number represented by the four bits
+     */
+    nibblet(depth: number): number;
+}
+export { Hash };

package/dist/src/types/hash.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Hash = void 0;
+const serialized_type_1 = require("./serialized-type");
+const utils_1 = require("@xrplf/isomorphic/utils");
+const utils_2 = require("../utils");
+/**
+ * Base class defining how to encode and decode hashes
+ */
+class Hash extends serialized_type_1.Comparable {
+    constructor(bytes) {
+        super(bytes);
+        if (this.bytes.length !== this.constructor.width) {
+            throw new Error(`Invalid Hash length ${this.bytes.byteLength}`);
+        }
+    }
+    /**
+     * Construct a Hash object from an existing Hash object or a hex-string
+     *
+     * @param value A hash object or hex-string of a hash
+     */
+    static from(value) {
+        if (value instanceof this) {
+            return value;
+        }
+        if (typeof value === 'string') {
+            return new this((0, utils_1.hexToBytes)(value));
+        }
+        throw new Error('Cannot construct Hash from given value');
+    }
+    /**
+     * Read a Hash object from a BinaryParser
+     *
+     * @param parser BinaryParser to read the hash from
+     * @param hint length of the bytes to read, optional
+     */
+    static fromParser(parser, hint) {
+        return new this(parser.read(hint !== null && hint !== void 0 ? hint : this.width));
+    }
+    /**
+     * Overloaded operator for comparing two hash objects
+     *
+     * @param other The Hash to compare this to
+     */
+    compareTo(other) {
+        return (0, utils_2.compare)(this.bytes, this.constructor.from(other).bytes);
+    }
+    /**
+     * @returns the hex-string representation of this Hash
+     */
+    toString() {
+        return this.toHex();
+    }
+    /**
+     * Returns four bits at the specified depth within a hash
+     *
+     * @param depth The depth of the four bits
+     * @returns The number represented by the four bits
+     */
+    nibblet(depth) {
+        const byteIx = depth > 0 ? (depth / 2) | 0 : 0;
+        let b = this.bytes[byteIx];
+        if (depth % 2 === 0) {
+            b = (b & 0xf0) >>> 4;
+        }
+        else {
+            b = b & 0x0f;
+        }
+        return b;
+    }
+}
+exports.Hash = Hash;
+//# sourceMappingURL=hash.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hash.js","sourceRoot":"","sources":["../../../src/types/hash.ts"],"names":[],"mappings":";;;AAAA,uDAA8C;AAE9C,mDAAoD;AACpD,oCAAkC;AAElC;;GAEG;AACH,MAAM,IAAK,SAAQ,4BAAyB;IAG1C,YAAY,KAAiB;QAC3B,KAAK,CAAC,KAAK,CAAC,CAAA;QACZ,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAM,IAAI,CAAC,WAA2B,CAAC,KAAK,EAAE;YACjE,MAAM,IAAI,KAAK,CAAC,uBAAuB,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAA;SAChE;IACH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAA0B,KAAQ;QAC3C,IAAI,KAAK,YAAY,IAAI,EAAE;YACzB,OAAO,KAAK,CAAA;SACb;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,IAAI,CAAC,IAAA,kBAAU,EAAC,KAAK,CAAC,CAAC,CAAA;SACnC;QAED,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;IAC3D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB,EAAE,IAAa;QACnD,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;IAClD,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,KAAW;QACnB,OAAO,IAAA,eAAO,EACZ,IAAI,CAAC,KAAK,EACT,IAAI,CAAC,WAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CACpD,CAAA;IACH,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,KAAa;QACnB,MAAM,MAAM,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC9C,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAC1B,IAAI,KAAK,GAAG,CAAC,KAAK,CAAC,EAAE;YACnB,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;SACrB;aAAM;YACL,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;SACb;QACD,OAAO,CAAC,CAAA;IACV,CAAC;CACF;AAEQ,oBAAI"}

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

@@ -0,0 +1,18 @@
+import { AccountID } from './account-id';
+import { Amount } from './amount';
+import { Blob } from './blob';
+import { Currency } from './currency';
+import { Hash128 } from './hash-128';
+import { Hash160 } from './hash-160';
+import { Hash256 } from './hash-256';
+import { PathSet } from './path-set';
+import { STArray } from './st-array';
+import { STObject } from './st-object';
+import { UInt16 } from './uint-16';
+import { UInt32 } from './uint-32';
+import { UInt64 } from './uint-64';
+import { UInt8 } from './uint-8';
+import { Vector256 } from './vector-256';
+import { type SerializedType } from './serialized-type';
+declare const coreTypes: Record<string, typeof SerializedType>;
+export { coreTypes, AccountID, Amount, Blob, Currency, Hash128, Hash160, Hash256, PathSet, STArray, STObject, UInt8, UInt16, UInt32, UInt64, Vector256, };

package/dist/src/types/index.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Vector256 = exports.UInt64 = exports.UInt32 = exports.UInt16 = exports.UInt8 = exports.STObject = exports.STArray = exports.PathSet = exports.Hash256 = exports.Hash160 = exports.Hash128 = exports.Currency = exports.Blob = exports.Amount = exports.AccountID = exports.coreTypes = void 0;
+const account_id_1 = require("./account-id");
+Object.defineProperty(exports, "AccountID", { enumerable: true, get: function () { return account_id_1.AccountID; } });
+const amount_1 = require("./amount");
+Object.defineProperty(exports, "Amount", { enumerable: true, get: function () { return amount_1.Amount; } });
+const blob_1 = require("./blob");
+Object.defineProperty(exports, "Blob", { enumerable: true, get: function () { return blob_1.Blob; } });
+const currency_1 = require("./currency");
+Object.defineProperty(exports, "Currency", { enumerable: true, get: function () { return currency_1.Currency; } });
+const hash_128_1 = require("./hash-128");
+Object.defineProperty(exports, "Hash128", { enumerable: true, get: function () { return hash_128_1.Hash128; } });
+const hash_160_1 = require("./hash-160");
+Object.defineProperty(exports, "Hash160", { enumerable: true, get: function () { return hash_160_1.Hash160; } });
+const hash_256_1 = require("./hash-256");
+Object.defineProperty(exports, "Hash256", { enumerable: true, get: function () { return hash_256_1.Hash256; } });
+const issue_1 = require("./issue");
+const path_set_1 = require("./path-set");
+Object.defineProperty(exports, "PathSet", { enumerable: true, get: function () { return path_set_1.PathSet; } });
+const st_array_1 = require("./st-array");
+Object.defineProperty(exports, "STArray", { enumerable: true, get: function () { return st_array_1.STArray; } });
+const st_object_1 = require("./st-object");
+Object.defineProperty(exports, "STObject", { enumerable: true, get: function () { return st_object_1.STObject; } });
+const uint_16_1 = require("./uint-16");
+Object.defineProperty(exports, "UInt16", { enumerable: true, get: function () { return uint_16_1.UInt16; } });
+const uint_32_1 = require("./uint-32");
+Object.defineProperty(exports, "UInt32", { enumerable: true, get: function () { return uint_32_1.UInt32; } });
+const uint_64_1 = require("./uint-64");
+Object.defineProperty(exports, "UInt64", { enumerable: true, get: function () { return uint_64_1.UInt64; } });
+const uint_8_1 = require("./uint-8");
+Object.defineProperty(exports, "UInt8", { enumerable: true, get: function () { return uint_8_1.UInt8; } });
+const vector_256_1 = require("./vector-256");
+Object.defineProperty(exports, "Vector256", { enumerable: true, get: function () { return vector_256_1.Vector256; } });
+const xchain_bridge_1 = require("./xchain-bridge");
+const enums_1 = require("../enums");
+const coreTypes = {
+    AccountID: account_id_1.AccountID,
+    Amount: amount_1.Amount,
+    Blob: blob_1.Blob,
+    Currency: currency_1.Currency,
+    Hash128: hash_128_1.Hash128,
+    Hash160: hash_160_1.Hash160,
+    Hash256: hash_256_1.Hash256,
+    Issue: issue_1.Issue,
+    PathSet: path_set_1.PathSet,
+    STArray: st_array_1.STArray,
+    STObject: st_object_1.STObject,
+    UInt8: uint_8_1.UInt8,
+    UInt16: uint_16_1.UInt16,
+    UInt32: uint_32_1.UInt32,
+    UInt64: uint_64_1.UInt64,
+    Vector256: vector_256_1.Vector256,
+    XChainBridge: xchain_bridge_1.XChainBridge,
+};
+exports.coreTypes = coreTypes;
+// Ensures that the DEFAULT_DEFINITIONS object connects these types to fields for serializing/deserializing
+// This is done here instead of in enums/index.ts to avoid a circular dependency
+// because some of the above types depend on BinarySerializer which depends on enums/index.ts.
+enums_1.DEFAULT_DEFINITIONS.associateTypes(coreTypes);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";;;AAAA,6CAAwC;AA+CtC,0FA/CO,sBAAS,OA+CP;AA9CX,qCAAiC;AA+C/B,uFA/CO,eAAM,OA+CP;AA9CR,iCAA6B;AA+C3B,qFA/CO,WAAI,OA+CP;AA9CN,yCAAqC;AA+CnC,yFA/CO,mBAAQ,OA+CP;AA9CV,yCAAoC;AA+ClC,wFA/CO,kBAAO,OA+CP;AA9CT,yCAAoC;AA+ClC,wFA/CO,kBAAO,OA+CP;AA9CT,yCAAoC;AA+ClC,wFA/CO,kBAAO,OA+CP;AA9CT,mCAA+B;AAC/B,yCAAoC;AA8ClC,wFA9CO,kBAAO,OA8CP;AA7CT,yCAAoC;AA8ClC,wFA9CO,kBAAO,OA8CP;AA7CT,2CAAsC;AA8CpC,yFA9CO,oBAAQ,OA8CP;AA7CV,uCAAkC;AA+ChC,uFA/CO,gBAAM,OA+CP;AA9CR,uCAAkC;AA+ChC,uFA/CO,gBAAM,OA+CP;AA9CR,uCAAkC;AA+ChC,uFA/CO,gBAAM,OA+CP;AA9CR,qCAAgC;AA2C9B,sFA3CO,cAAK,OA2CP;AA1CP,6CAAwC;AA8CtC,0FA9CO,sBAAS,OA8CP;AA7CX,mDAA8C;AAE9C,oCAA8C;AAE9C,MAAM,SAAS,GAA0C;IACvD,SAAS,EAAT,sBAAS;IACT,MAAM,EAAN,eAAM;IACN,IAAI,EAAJ,WAAI;IACJ,QAAQ,EAAR,mBAAQ;IACR,OAAO,EAAP,kBAAO;IACP,OAAO,EAAP,kBAAO;IACP,OAAO,EAAP,kBAAO;IACP,KAAK,EAAL,aAAK;IACL,OAAO,EAAP,kBAAO;IACP,OAAO,EAAP,kBAAO;IACP,QAAQ,EAAR,oBAAQ;IACR,KAAK,EAAL,cAAK;IACL,MAAM,EAAN,gBAAM;IACN,MAAM,EAAN,gBAAM;IACN,MAAM,EAAN,gBAAM;IACN,SAAS,EAAT,sBAAS;IACT,YAAY,EAAZ,4BAAY;CACb,CAAA;AAQC,8BAAS;AANX,2GAA2G;AAC3G,gFAAgF;AAChF,8FAA8F;AAC9F,2BAAmB,CAAC,cAAc,CAAC,SAAS,CAAC,CAAA"}

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

@@ -0,0 +1,38 @@
+import { BinaryParser } from '../serdes/binary-parser';
+import { JsonObject, SerializedType } from './serialized-type';
+/**
+ * Interface for JSON objects that represent amounts
+ */
+interface IssueObject extends JsonObject {
+    currency: string;
+    issuer?: string;
+}
+/**
+ * Class for serializing/Deserializing Amounts
+ */
+declare class Issue extends SerializedType {
+    static readonly ZERO_ISSUED_CURRENCY: Issue;
+    constructor(bytes: Uint8Array);
+    /**
+     * Construct an amount from an IOU or string amount
+     *
+     * @param value An Amount, object representing an IOU, or a string
+     *     representing an integer amount
+     * @returns An Amount object
+     */
+    static from<T extends Issue | IssueObject>(value: T): Issue;
+    /**
+     * Read an amount from a BinaryParser
+     *
+     * @param parser BinaryParser to read the Amount from
+     * @returns An Amount object
+     */
+    static fromParser(parser: BinaryParser): Issue;
+    /**
+     * Get the JSON representation of this Amount
+     *
+     * @returns the JSON interpretation of this.bytes
+     */
+    toJSON(): IssueObject;
+}
+export { Issue, IssueObject };

package/dist/src/types/issue.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Issue = void 0;
+const utils_1 = require("@xrplf/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");
+/**
+ * Type guard for AmountObject
+ */
+function isIssueObject(arg) {
+    const keys = Object.keys(arg).sort();
+    if (keys.length === 1) {
+        return keys[0] === 'currency';
+    }
+    return keys.length === 2 && keys[0] === 'currency' && keys[1] === 'issuer';
+}
+/**
+ * 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, or a string
+     *     representing an integer amount
+     * @returns An Amount object
+     */
+    static from(value) {
+        if (value instanceof Issue) {
+            return value;
+        }
+        if (isIssueObject(value)) {
+            const currency = currency_1.Currency.from(value.currency).toBytes();
+            if (value.issuer == null) {
+                return new Issue(currency);
+            }
+            const issuer = account_id_1.AccountID.from(value.issuer).toBytes();
+            return new Issue((0, utils_1.concat)([currency, issuer]));
+        }
+        throw new Error('Invalid type to construct an Amount');
+    }
+    /**
+     * Read an amount from a BinaryParser
+     *
+     * @param parser BinaryParser to read the Amount from
+     * @returns An Amount object
+     */
+    static fromParser(parser) {
+        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() {
+        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,mDAAgD;AAChD,2DAAsD;AAEtD,6CAAwC;AACxC,yCAAqC;AACrC,uDAA8D;AAU9D;;GAEG;AACH,SAAS,aAAa,CAAC,GAAG;IACxB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IACpC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QACrB,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,CAAA;KAC9B;IACD,OAAO,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAA;AAC5E,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,MAAM,QAAQ,GAAG,mBAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAA;YACxD,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,EAAE;gBACxB,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAA;aAC3B;YACD,MAAM,MAAM,GAAG,sBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAA;YACrD,OAAO,IAAI,KAAK,CAAC,IAAA,cAAM,EAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAA;SAC7C;QAED,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;IACxD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,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,MAAM,MAAM,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QAChD,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;AAjEI,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 };