ripple-binary-codec 1.1.3 → 1.2.0-beta.1

package/dist/types/PathSet/Hop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Hop.js","sourceRoot":"","sources":["../../../src/types/PathSet/Hop.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,4EAA4E;AAC5E,kCAAgC;AAEhC,0DAAoD;AACpD,4CAAqC;AACrC,wCAAkC;AAClC,oDAA8D;AAE9D;;GAEG;AACH,IAAM,YAAY,GAAG,IAAI,CAAA;AACzB,IAAM,aAAa,GAAG,IAAI,CAAA;AAC1B,IAAM,WAAW,GAAG,IAAI,CAAA;AAWxB;;GAEG;AACH;IAAiC,uBAAc;IAA/C;;IA8FA,CAAC;IA7FC;;;;;OAKG;IACW,QAAI,GAAlB,UAAmB,KAAsB;QACvC,IAAI,KAAK,YAAY,GAAG,EAAE;YACxB,OAAO,KAAK,CAAA;SACb;QAED,IAAM,KAAK,GAAa,CAAC,eAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAE1C,IAAI,KAAK,CAAC,OAAO,EAAE;YACjB,KAAK,CAAC,IAAI,CAAC,oBAAS,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,kBAAQ,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,oBAAS,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;IACW,cAAU,GAAxB,UAAyB,MAAoB;QAC3C,IAAM,IAAI,GAAG,MAAM,CAAC,SAAS,EAAE,CAAA;QAC/B,IAAM,KAAK,GAAa,CAAC,eAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAE7C,IAAI,IAAI,GAAG,YAAY,EAAE;YACvB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAS,CAAC,KAAK,CAAC,CAAC,CAAA;SACzC;QAED,IAAI,IAAI,GAAG,aAAa,EAAE;YACxB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;SACxC;QAED,IAAI,IAAI,GAAG,WAAW,EAAE;YACtB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAS,CAAC,KAAK,CAAC,CAAC,CAAA;SACzC;QAED,OAAO,IAAI,GAAG,CAAC,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IACtC,CAAC;IAED;;;;OAIG;IACI,oBAAM,GAAb;QACE,IAAM,SAAS,GAAG,IAAI,sBAAY,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;QAC9D,IAAM,IAAI,GAAG,SAAS,CAAC,SAAS,EAAE,CAAA;QAClC,IAAM,MAAM,GAAc,EAAE,CAAA;QAE5B;;4CAEoC;QACpC,IAAI,IAAI,GAAG,YAAY,EAAE;YACvB,MAAM,CAAC,OAAO,GAAG,oBAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,EAAY,CAAA;SACpE;QAED,IAAI,IAAI,GAAG,aAAa,EAAE;YACxB,MAAM,CAAC,QAAQ,GAAG,kBAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,EAAY,CAAA;SACpE;QAED,IAAI,IAAI,GAAG,WAAW,EAAE;YACtB,MAAM,CAAC,MAAM,GAAG,oBAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,EAAY,CAAA;SACnE;QACD,iEAAiE;QAEjE,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;OAIG;IACI,kBAAI,GAAX;QACE,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACtB,CAAC;IACH,UAAC;AAAD,CAAC,AA9FD,CAAiC,wBAAc,GA8F9C"}

package/dist/types/PathSet/Path.d.ts

@@ -0,0 +1,33 @@
+import BinaryParser from '../../serdes/BinaryParser';
+import SerializedType from '../SerializedType';
+import { HopObject } from './Hop';
+/**
+ * Constants for separating Paths in a PathSet.
+ */
+export declare const PATHSET_END_BYTE = 0;
+export declare const PATH_SEPARATOR_BYTE = 255;
+/**
+ * Class for serializing/deserializing Paths.
+ */
+export default class Path extends 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: Path | HopObject[]): Path;
+    /**
+     * 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: BinaryParser): Path;
+    /**
+     * Get the JSON representation of this Path.
+     *
+     * @returns An Array of HopObject constructed from this.bytes.
+     */
+    toJSON(): HopObject[];
+}

package/dist/types/PathSet/Path.js

@@ -0,0 +1,83 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PATH_SEPARATOR_BYTE = exports.PATHSET_END_BYTE = void 0;
+var buffer_1 = require("buffer/");
+var BinaryParser_1 = require("../../serdes/BinaryParser");
+var SerializedType_1 = require("../SerializedType");
+var Hop_1 = require("./Hop");
+/**
+ * Constants for separating Paths in a PathSet.
+ */
+exports.PATHSET_END_BYTE = 0x00;
+exports.PATH_SEPARATOR_BYTE = 0xff;
+/**
+ * Class for serializing/deserializing Paths.
+ */
+var Path = /** @class */ (function (_super) {
+    __extends(Path, _super);
+    function Path() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Construct a Path from an array of Hops.
+     *
+     * @param value - Path or array of HopObjects to construct a Path.
+     * @returns The Path.
+     */
+    Path.from = function (value) {
+        if (value instanceof Path) {
+            return value;
+        }
+        var bytes = [];
+        value.forEach(function (hop) {
+            bytes.push(Hop_1.default.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.
+     */
+    Path.fromParser = function (parser) {
+        var bytes = [];
+        while (!parser.end()) {
+            bytes.push(Hop_1.default.fromParser(parser).toBytes());
+            if (parser.peek() === exports.PATHSET_END_BYTE ||
+                parser.peek() === exports.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.
+     */
+    Path.prototype.toJSON = function () {
+        var json = [];
+        var pathParser = new BinaryParser_1.default(this.toString());
+        while (!pathParser.end()) {
+            json.push(Hop_1.default.fromParser(pathParser).toJSON());
+        }
+        return json;
+    };
+    return Path;
+}(SerializedType_1.default));
+exports.default = Path;
+//# sourceMappingURL=Path.js.map

package/dist/types/PathSet/Path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Path.js","sourceRoot":"","sources":["../../../src/types/PathSet/Path.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kCAAgC;AAEhC,0DAAoD;AACpD,oDAA8C;AAE9C,6BAAsC;AAEtC;;GAEG;AACU,QAAA,gBAAgB,GAAG,IAAI,CAAA;AACvB,QAAA,mBAAmB,GAAG,IAAI,CAAA;AAEvC;;GAEG;AACH;IAAkC,wBAAc;IAAhD;;IAwDA,CAAC;IAvDC;;;;;OAKG;IACW,SAAI,GAAlB,UAAmB,KAAyB;QAC1C,IAAI,KAAK,YAAY,IAAI,EAAE;YACzB,OAAO,KAAK,CAAA;SACb;QAED,IAAM,KAAK,GAAa,EAAE,CAAA;QAC1B,KAAK,CAAC,OAAO,CAAC,UAAC,GAAc;YAC3B,KAAK,CAAC,IAAI,CAAC,aAAG,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;IACW,eAAU,GAAxB,UAAyB,MAAoB;QAC3C,IAAM,KAAK,GAAa,EAAE,CAAA;QAC1B,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE;YACpB,KAAK,CAAC,IAAI,CAAC,aAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;YAE5C,IACE,MAAM,CAAC,IAAI,EAAE,KAAK,wBAAgB;gBAClC,MAAM,CAAC,IAAI,EAAE,KAAK,2BAAmB,EACrC;gBACA,MAAK;aACN;SACF;QACD,OAAO,IAAI,IAAI,CAAC,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IACvC,CAAC;IAED;;;;OAIG;IACI,qBAAM,GAAb;QACE,IAAM,IAAI,GAAgB,EAAE,CAAA;QAC5B,IAAM,UAAU,GAAG,IAAI,sBAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QAEpD,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE;YACxB,IAAI,CAAC,IAAI,CAAC,aAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC,CAAA;SAC/C;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IACH,WAAC;AAAD,CAAC,AAxDD,CAAkC,wBAAc,GAwD/C"}

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

@@ -0,0 +1,29 @@
+import BinaryParser from '../../serdes/BinaryParser';
+import SerializedType from '../SerializedType';
+import { HopObject } from './Hop';
+/**
+ * Deserialize and Serialize the PathSet type.
+ */
+export default 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.
+     * @throws Error.
+     */
+    static from<T extends PathSet | 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(): HopObject[][];
+}

package/dist/types/PathSet/index.js

@@ -0,0 +1,98 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+var buffer_1 = require("buffer/");
+var BinaryParser_1 = require("../../serdes/BinaryParser");
+var SerializedType_1 = require("../SerializedType");
+var Path_1 = require("./Path");
+function isHopObject(arg) {
+    var _a, _b, _c;
+    /* eslint-disable @typescript-eslint/consistent-type-assertions --
+     * TODO is there any way to write this without a type assertion? */
+    return (((_a = arg) === null || _a === void 0 ? void 0 : _a.issuer) !== undefined ||
+        ((_b = arg) === null || _b === void 0 ? void 0 : _b.account) !== undefined ||
+        ((_c = arg) === null || _c === void 0 ? void 0 : _c.currency) !== undefined);
+    /* eslint-enable @typescript-eslint/consistent-type-assertions */
+}
+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])));
+}
+/**
+ * Deserialize and Serialize the PathSet type.
+ */
+var PathSet = /** @class */ (function (_super) {
+    __extends(PathSet, _super);
+    function PathSet() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * 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.
+     * @throws Error.
+     */
+    PathSet.from = function (value) {
+        if (value instanceof PathSet) {
+            return value;
+        }
+        if (isPathSet(value)) {
+            var bytes_1 = [];
+            value.forEach(function (path) {
+                bytes_1.push(Path_1.default.from(path).toBytes());
+                bytes_1.push(buffer_1.Buffer.from([Path_1.PATH_SEPARATOR_BYTE]));
+            });
+            bytes_1[bytes_1.length - 1] = buffer_1.Buffer.from([Path_1.PATHSET_END_BYTE]);
+            return new PathSet(buffer_1.Buffer.concat(bytes_1));
+        }
+        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.
+     */
+    PathSet.fromParser = function (parser) {
+        var bytes = [];
+        while (!parser.end()) {
+            bytes.push(Path_1.default.fromParser(parser).toBytes());
+            bytes.push(parser.read(1));
+            if (bytes[bytes.length - 1][0] === Path_1.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.
+     */
+    PathSet.prototype.toJSON = function () {
+        var json = [];
+        var pathParser = new BinaryParser_1.default(this.toString());
+        while (!pathParser.end()) {
+            json.push(Path_1.default.fromParser(pathParser).toJSON());
+            pathParser.skip(1);
+        }
+        return json;
+    };
+    return PathSet;
+}(SerializedType_1.default));
+exports.default = PathSet;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/PathSet/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,kCAAgC;AAEhC,0DAAoD;AACpD,oDAA8C;AAG9C,+BAAoE;AAEpE,SAAS,WAAW,CAAC,GAAG;;IACtB;uEACmE;IACnE,OAAO,CACL,OAAC,GAAiB,0CAAE,MAAM,MAAK,SAAS;QACxC,OAAC,GAAiB,0CAAE,OAAO,MAAK,SAAS;QACzC,OAAC,GAAiB,0CAAE,QAAQ,MAAK,SAAS,CAC3C,CAAA;IACD,iEAAiE;AACnE,CAAC;AAED,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;IAAqC,2BAAc;IAAnD;;IAkEA,CAAC;IAjEC;;;;;;OAMG;IACW,YAAI,GAAlB,UAAsD,KAAQ;QAC5D,IAAI,KAAK,YAAY,OAAO,EAAE;YAC5B,OAAO,KAAK,CAAA;SACb;QAED,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;YACpB,IAAM,OAAK,GAAa,EAAE,CAAA;YAE1B,KAAK,CAAC,OAAO,CAAC,UAAC,IAAiB;gBAC9B,OAAK,CAAC,IAAI,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;gBACrC,OAAK,CAAC,IAAI,CAAC,eAAM,CAAC,IAAI,CAAC,CAAC,0BAAmB,CAAC,CAAC,CAAC,CAAA;YAChD,CAAC,CAAC,CAAA;YAEF,OAAK,CAAC,OAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,eAAM,CAAC,IAAI,CAAC,CAAC,uBAAgB,CAAC,CAAC,CAAA;YAEzD,OAAO,IAAI,OAAO,CAAC,eAAM,CAAC,MAAM,CAAC,OAAK,CAAC,CAAC,CAAA;SACzC;QAED,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;IAC9D,CAAC;IAED;;;;;OAKG;IACW,kBAAU,GAAxB,UAAyB,MAAoB;QAC3C,IAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE;YACpB,KAAK,CAAC,IAAI,CAAC,cAAI,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,KAAK,uBAAgB,EAAE;gBACnD,MAAK;aACN;SACF;QAED,OAAO,IAAI,OAAO,CAAC,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAC1C,CAAC;IAED;;;;OAIG;IACI,wBAAM,GAAb;QACE,IAAM,IAAI,GAAkB,EAAE,CAAA;QAC9B,IAAM,UAAU,GAAG,IAAI,sBAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QAEpD,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE;YACxB,IAAI,CAAC,IAAI,CAAC,cAAI,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;IACH,cAAC;AAAD,CAAC,AAlED,CAAqC,wBAAc,GAkElD"}

package/dist/types/SerializedType.d.ts

@@ -0,0 +1,47 @@
+import * as bigInt from 'big-integer';
+import { Buffer } from 'buffer/';
+import type BinaryParser from '../serdes/BinaryParser';
+import BytesList from '../serdes/BytesList';
+export declare type JSON = string | number | boolean | null | undefined | JSON[] | JsonObject;
+export interface JsonObject {
+    [key: string]: JSON;
+}
+/**
+ * The base class for all binary-codec types.
+ */
+export default 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;
+    /**
+     * Return the HexString representation of this type.
+     *
+     * @returns HexString representation of this.bytes.
+     */
+    toString(): string;
+}

package/dist/types/SerializedType.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var buffer_1 = require("buffer/");
+var BytesList_1 = require("../serdes/BytesList");
+/**
+ * The base class for all binary-codec types.
+ */
+var SerializedType = /** @class */ (function () {
+    function SerializedType(bytes) {
+        this.bytes = buffer_1.Buffer.alloc(0);
+        this.bytes = bytes !== null && bytes !== void 0 ? bytes : buffer_1.Buffer.alloc(0);
+    }
+    SerializedType.fromParser = function (parser, hint) {
+        throw new Error('fromParser not implemented');
+        return this.fromParser(parser, hint);
+    };
+    SerializedType.from = function (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.
+     */
+    SerializedType.prototype.toBytesSink = function (list) {
+        list.put(this.bytes);
+    };
+    /**
+     * Get the hex representation of a SerializedType's bytes.
+     *
+     * @returns Hex String of this.bytes.
+     */
+    SerializedType.prototype.toHex = function () {
+        return this.toBytes().toString('hex').toUpperCase();
+    };
+    /**
+     * Get the bytes representation of a SerializedType.
+     *
+     * @returns A buffer of the bytes.
+     */
+    SerializedType.prototype.toBytes = function () {
+        if (this.bytes) {
+            return this.bytes;
+        }
+        var bytes = new BytesList_1.default();
+        this.toBytesSink(bytes);
+        return bytes.toBytes();
+    };
+    /**
+     * Return the JSON representation of a SerializedType.
+     *
+     * @returns Any type, if not overloaded returns hexString representation of bytes.
+     */
+    SerializedType.prototype.toJSON = function () {
+        return this.toHex();
+    };
+    /**
+     * Return the HexString representation of this type.
+     *
+     * @returns HexString representation of this.bytes.
+     */
+    SerializedType.prototype.toString = function () {
+        return this.toHex();
+    };
+    return SerializedType;
+}());
+exports.default = SerializedType;
+//# sourceMappingURL=SerializedType.js.map

package/dist/types/SerializedType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SerializedType.js","sourceRoot":"","sources":["../../src/types/SerializedType.ts"],"names":[],"mappings":";;AACA,kCAAgC;AAGhC,iDAA2C;AAe3C;;GAEG;AACH;IAGE,wBAAmB,KAAa;QAFb,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;IAEa,yBAAU,GAAxB,UACE,MAAoB,EACpB,IAAa;QAEb,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;QAC7C,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACtC,CAAC;IAEa,mBAAI,GAAlB,UACE,KAAgD;QAEhD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACzB,CAAC;IAED;;;;OAIG;IACI,oCAAW,GAAlB,UAAmB,IAAe;QAChC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACtB,CAAC;IAED;;;;OAIG;IACI,8BAAK,GAAZ;QACE,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAA;IACrD,CAAC;IAED;;;;OAIG;IACI,gCAAO,GAAd;QACE,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,OAAO,IAAI,CAAC,KAAK,CAAA;SAClB;QACD,IAAM,KAAK,GAAG,IAAI,mBAAS,EAAE,CAAA;QAC7B,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;QACvB,OAAO,KAAK,CAAC,OAAO,EAAE,CAAA;IACxB,CAAC;IAED;;;;OAIG;IACI,+BAAM,GAAb;QACE,OAAO,IAAI,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;IAED;;;;OAIG;IACI,iCAAQ,GAAf;QACE,OAAO,IAAI,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;IACH,qBAAC;AAAD,CAAC,AAvED,IAuEC"}

package/dist/types/currency.d.ts

@@ -5,21 +5,14 @@ import { Buffer } from "buffer/";
  */
 declare class Currency extends Hash160 {
     static readonly XRP: Currency;
-    private readonly _iso?;
-    private readonly _isNative;
+    private readonly _iso;
     constructor(byteBuf: Buffer);
-    /**
-     * Tells if this currency is native
-     *
-     * @returns true if native, false if not
-     */
-    isNative(): boolean;
     /**
      * Return the ISO code of this currency
      *
-     * @returns ISO code if it exists, else undefined
+     * @returns ISO code if it exists, else null
      */
-    iso(): string | undefined;
+    iso(): string | null;
     /**
      * Constructs a Currency object
      *

package/dist/types/currency.js

@@ -33,7 +33,17 @@ function isoToBytes(iso) {
  * Tests if ISO is a valid iso code
  */
 function isIsoCode(iso) {
-    return iso.length === 3;
+    return ISO_REGEX.test(iso);
+}
+function isoCodeFromHex(code) {
+    var iso = code.toString();
+    if (iso === "XRP") {
+        throw new Error("Disallowed currency code: to indicate the currency XRP you must use 20 bytes of 0s");
+    }
+    if (isIsoCode(iso)) {
+        return iso;
+    }
+    return null;
 }
 /**
  * Tests if hex is a valid hex-string
@@ -45,7 +55,7 @@ function isHex(hex) {
  * Tests if a string is a valid representation of a currency
  */
 function isStringRepresentation(input) {
-    return isIsoCode(input) || isHex(input);
+    return input.length === 3 || isHex(input);
 }
 /**
  * Tests if a Buffer is a valid representation of a currency
@@ -77,33 +87,22 @@ var Currency = /** @class */ (function (_super) {
     __extends(Currency, _super);
     function Currency(byteBuf) {
         var _this = _super.call(this, byteBuf !== null && byteBuf !== void 0 ? byteBuf : Currency.XRP.bytes) || this;
-        var onlyISO = true;
-        var bytes = _this.bytes;
         var code = _this.bytes.slice(12, 15);
-        var iso = code.toString();
-        for (var i = bytes.length - 1; i >= 0; i--) {
-            if (bytes[i] !== 0 && !(i === 12 || i === 13 || i === 14)) {
-                onlyISO = false;
-                break;
-            }
+        if (_this.bytes[0] !== 0) {
+            _this._iso = null;
+        }
+        else if (code.toString("hex") === "000000") {
+            _this._iso = "XRP";
+        }
+        else {
+            _this._iso = isoCodeFromHex(code);
         }
-        var lossLessISO = onlyISO && iso !== "XRP" && ISO_REGEX.test(iso);
-        _this._isNative = onlyISO && code.toString("hex") === "000000";
-        _this._iso = _this._isNative ? "XRP" : lossLessISO ? iso : undefined;
         return _this;
     }
-    /**
-     * Tells if this currency is native
-     *
-     * @returns true if native, false if not
-     */
-    Currency.prototype.isNative = function () {
-        return this._isNative;
-    };
     /**
      * Return the ISO code of this currency
      *
-     * @returns ISO code if it exists, else undefined
+     * @returns ISO code if it exists, else null
      */
     Currency.prototype.iso = function () {
         return this._iso;
@@ -129,7 +128,7 @@ var Currency = /** @class */ (function (_super) {
      */
     Currency.prototype.toJSON = function () {
         var iso = this.iso();
-        if (iso !== undefined) {
+        if (iso !== null) {
             return iso;
         }
         return this.bytes.toString("hex").toUpperCase();

package/dist/types/currency.js.map

@@ -1 +1 @@
-{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../src/types/currency.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uCAAqC;AACrC,kCAAiC;AAEjC,IAAM,SAAS,GAAG,eAAe,CAAC;AAClC,IAAM,SAAS,GAAG,gBAAgB,CAAC;AAEnC;;GAEG;AACH,SAAS,UAAU,CAAC,GAAW;IAC7B,IAAM,KAAK,GAAG,eAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC/B,IAAI,GAAG,KAAK,KAAK,EAAE;QACjB,IAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAf,CAAe,CAAC,CAAC;QAC3D,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;KACzB;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,SAAS,SAAS,CAAC,GAAW;IAC5B,OAAO,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,SAAS,KAAK,CAAC,GAAW;IACxB,OAAO,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7B,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,KAAa;IAC3C,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;AAC1C,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CAAC,KAAa;IACjC,OAAO,KAAK,CAAC,UAAU,KAAK,EAAE,CAAC;AACjC,CAAC;AAED;;GAEG;AACH,SAAS,qBAAqB,CAAC,KAAsB;IACnD,OAAO,KAAK,YAAY,eAAM;QAC5B,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC;QACrB,CAAC,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;AACpC,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB,CAAC,KAAa;IAC5C,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,0CAAwC,KAAO,CAAC,CAAC;KAClE;IACD,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,eAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC5E,CAAC;AAED;;GAEG;AACH;IAAuB,4BAAO;IAK5B,kBAAY,OAAe;QAA3B,YACE,kBAAM,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,SAkBrC;QAhBC,IAAI,OAAO,GAAG,IAAI,CAAC;QAEnB,IAAM,KAAK,GAAG,KAAI,CAAC,KAAK,CAAC;QACzB,IAAM,IAAI,GAAG,KAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,IAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAE5B,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;YAC1C,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE;gBACzD,OAAO,GAAG,KAAK,CAAC;gBAChB,MAAM;aACP;SACF;QAED,IAAM,WAAW,GAAG,OAAO,IAAI,GAAG,KAAK,KAAK,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpE,KAAI,CAAC,SAAS,GAAG,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC;QAC9D,KAAI,CAAC,IAAI,GAAG,KAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;;IACrE,CAAC;IAED;;;;OAIG;IACH,2BAAQ,GAAR;QACE,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,sBAAG,GAAH;QACE,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,aAAI,GAAX,UAAwC,KAAQ;QAC9C,IAAI,KAAK,YAAY,QAAQ,EAAE;YAC7B,OAAO,KAAK,CAAC;SACd;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,QAAQ,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC,CAAC;SACrD;QAED,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACH,yBAAM,GAAN;QACE,IAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,GAAG,KAAK,SAAS,EAAE;YACrB,OAAO,GAAG,CAAC;SACZ;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;IAClD,CAAC;IAvEe,YAAG,GAAG,IAAI,QAAQ,CAAC,eAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAwEvD,eAAC;CAAA,AAzED,CAAuB,kBAAO,GAyE7B;AAEQ,4BAAQ"}
+{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../src/types/currency.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uCAAqC;AACrC,kCAAiC;AAEjC,IAAM,SAAS,GAAG,eAAe,CAAC;AAClC,IAAM,SAAS,GAAG,gBAAgB,CAAC;AAEnC;;GAEG;AACH,SAAS,UAAU,CAAC,GAAW;IAC7B,IAAM,KAAK,GAAG,eAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC/B,IAAI,GAAG,KAAK,KAAK,EAAE;QACjB,IAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAf,CAAe,CAAC,CAAC;QAC3D,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;KACzB;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,SAAS,SAAS,CAAC,GAAW;IAC5B,OAAO,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7B,CAAC;AAED,SAAS,cAAc,CAAC,IAAY;IAClC,IAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC5B,IAAI,GAAG,KAAK,KAAK,EAAE;QACjB,MAAM,IAAI,KAAK,CACb,oFAAoF,CACrF,CAAC;KACH;IACD,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;QAClB,OAAO,GAAG,CAAC;KACZ;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,SAAS,KAAK,CAAC,GAAW;IACxB,OAAO,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7B,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,KAAa;IAC3C,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;AAC5C,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CAAC,KAAa;IACjC,OAAO,KAAK,CAAC,UAAU,KAAK,EAAE,CAAC;AACjC,CAAC;AAED;;GAEG;AACH,SAAS,qBAAqB,CAAC,KAAsB;IACnD,OAAO,KAAK,YAAY,eAAM;QAC5B,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC;QACrB,CAAC,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;AACpC,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB,CAAC,KAAa;IAC5C,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,0CAAwC,KAAO,CAAC,CAAC;KAClE;IACD,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,eAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC5E,CAAC;AAED;;GAEG;AACH;IAAuB,4BAAO;IAI5B,kBAAY,OAAe;QAA3B,YACE,kBAAM,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,SAUrC;QATC,IAAM,IAAI,GAAG,KAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAEtC,IAAI,KAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;YACvB,KAAI,CAAC,IAAI,GAAG,IAAI,CAAC;SAClB;aAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE;YAC5C,KAAI,CAAC,IAAI,GAAG,KAAK,CAAC;SACnB;aAAM;YACL,KAAI,CAAC,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;SAClC;;IACH,CAAC;IAED;;;;OAIG;IACH,sBAAG,GAAH;QACE,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,aAAI,GAAX,UAAwC,KAAQ;QAC9C,IAAI,KAAK,YAAY,QAAQ,EAAE;YAC7B,OAAO,KAAK,CAAC;SACd;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,QAAQ,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC,CAAC;SACrD;QAED,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACH,yBAAM,GAAN;QACE,IAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,GAAG,KAAK,IAAI,EAAE;YAChB,OAAO,GAAG,CAAC;SACZ;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;IAClD,CAAC;IArDe,YAAG,GAAG,IAAI,QAAQ,CAAC,eAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAsDvD,eAAC;CAAA,AAvDD,CAAuB,kBAAO,GAuD7B;AAEQ,4BAAQ"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ripple-binary-codec",
-  "version": "1.1.3",
+  "version": "1.2.0-beta.1",
   "description": "XRP Ledger binary codec",
   "files": [
     "dist/*",
@@ -13,13 +13,14 @@
   },
   "dependencies": {
     "assert": "^2.0.0",
-    "buffer": "5.6.0",
     "big-integer": "^1.6.48",
+    "buffer": "5.6.0",
     "create-hash": "^1.2.0",
     "decimal.js": "^10.2.0",
     "ripple-address-codec": "^4.1.1"
   },
   "devDependencies": {
+    "@types/create-hash": "^1.2.2",
     "@types/jest": "^26.0.7",
     "@types/node": "^14.0.10",
     "@typescript-eslint/eslint-plugin": "^3.2.0",
@@ -55,6 +56,6 @@
   },
   "engines": {
     "node": ">=10.22.0",
-    "yarn": "^1.22.4"
+    "npm": ">=7.0.0"
   }
 }

package/test/binary-parser.test.js

@@ -313,7 +313,7 @@ function pathSetBinaryTests() {
      0000585E1F3BD02A15D6185F8BB9B57CC60DEDDB37C13157180C769B66D942EE
      69E6DCC940CA48D82337AD000000000000000000000000425443000000000057
      180C769B66D942EE69E6DCC940CA48D82337AD10000000000000000000000000
-     58525000000000003000000000000000000000000055534400000000000A20B3
+     00000000000000003000000000000000000000000055534400000000000A20B3
      C85F482532A9578DBB3950B85CA06594D100`
   );
 
@@ -371,7 +371,7 @@ function pathSetBinaryTests() {
         currency: "BTC",
         issuer: "r3AWbdp2jQLXLywJypdoNwVSvr81xs3uhn",
       },
-      { currency: "0000000000000000000000005852500000000000" },
+      { currency: "XRP" },
       {
         currency: "USD",
         issuer: "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",