ripple-binary-codec 1.0.4-beta.1 → 1.0.4-mpt-beta

package/dist/shamap.js

@@ -1,161 +1,139 @@
 "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.ShaMapLeaf = exports.ShaMapNode = exports.ShaMap = void 0;
-var assert_1 = require("assert");
-var types_1 = require("./types");
-var hash_prefixes_1 = require("./hash-prefixes");
-var hashes_1 = require("./hashes");
-var buffer_1 = require("buffer/");
+const types_1 = require("./types");
+const hash_prefixes_1 = require("./hash-prefixes");
+const hashes_1 = require("./hashes");
 /**
  * Abstract class describing a SHAMapNode
  */
-var ShaMapNode = /** @class */ (function () {
-    function ShaMapNode() {
-    }
-    return ShaMapNode;
-}());
+class ShaMapNode {
+}
 exports.ShaMapNode = ShaMapNode;
 /**
  * Class describing a Leaf of SHAMap
  */
-var ShaMapLeaf = /** @class */ (function (_super) {
-    __extends(ShaMapLeaf, _super);
-    function ShaMapLeaf(index, item) {
-        var _this = _super.call(this) || this;
-        _this.index = index;
-        _this.item = item;
-        return _this;
+class ShaMapLeaf extends ShaMapNode {
+    constructor(index, item) {
+        super();
+        this.index = index;
+        this.item = item;
     }
     /**
      * @returns true as ShaMapLeaf is a leaf node
      */
-    ShaMapLeaf.prototype.isLeaf = function () {
+    isLeaf() {
         return true;
-    };
+    }
     /**
      * @returns false as ShaMapLeaf is not an inner node
      */
-    ShaMapLeaf.prototype.isInner = function () {
+    isInner() {
         return false;
-    };
+    }
     /**
      * Get the prefix of the this.item
      *
-     * @returns The hash prefix, unless this.item is undefined, then it returns an empty Buffer
+     * @returns The hash prefix, unless this.item is undefined, then it returns an empty Uint8Array
      */
-    ShaMapLeaf.prototype.hashPrefix = function () {
-        return this.item === undefined ? buffer_1.Buffer.alloc(0) : this.item.hashPrefix();
-    };
+    hashPrefix() {
+        return this.item === undefined ? new Uint8Array(0) : this.item.hashPrefix();
+    }
     /**
      * Hash the bytes representation of this
      *
      * @returns hash of this.item concatenated with this.index
      */
-    ShaMapLeaf.prototype.hash = function () {
-        var hash = hashes_1.Sha512Half.put(this.hashPrefix());
+    hash() {
+        const hash = hashes_1.Sha512Half.put(this.hashPrefix());
         this.toBytesSink(hash);
         return hash.finish();
-    };
+    }
     /**
      * Write the bytes representation of this to a BytesList
      * @param list BytesList to write bytes to
      */
-    ShaMapLeaf.prototype.toBytesSink = function (list) {
+    toBytesSink(list) {
         if (this.item !== undefined) {
             this.item.toBytesSink(list);
         }
         this.index.toBytesSink(list);
-    };
-    return ShaMapLeaf;
-}(ShaMapNode));
+    }
+}
 exports.ShaMapLeaf = ShaMapLeaf;
 /**
  * Class defining an Inner Node of a SHAMap
  */
-var ShaMapInner = /** @class */ (function (_super) {
-    __extends(ShaMapInner, _super);
-    function ShaMapInner(depth) {
-        if (depth === void 0) { depth = 0; }
-        var _this = _super.call(this) || this;
-        _this.depth = depth;
-        _this.slotBits = 0;
-        _this.branches = Array(16);
-        return _this;
+class ShaMapInner extends ShaMapNode {
+    constructor(depth = 0) {
+        super();
+        this.depth = depth;
+        this.slotBits = 0;
+        this.branches = Array(16);
     }
     /**
      * @returns true as ShaMapInner is an inner node
      */
-    ShaMapInner.prototype.isInner = function () {
+    isInner() {
         return true;
-    };
+    }
     /**
      * @returns false as ShaMapInner is not a leaf node
      */
-    ShaMapInner.prototype.isLeaf = function () {
+    isLeaf() {
         return false;
-    };
+    }
     /**
      * Get the hash prefix for this node
      *
      * @returns hash prefix describing an inner node
      */
-    ShaMapInner.prototype.hashPrefix = function () {
+    hashPrefix() {
         return hash_prefixes_1.HashPrefix.innerNode;
-    };
+    }
     /**
      * Set a branch of this node to be another node
      *
      * @param slot Slot to add branch to this.branches
      * @param branch Branch to add
      */
-    ShaMapInner.prototype.setBranch = function (slot, branch) {
+    setBranch(slot, branch) {
         this.slotBits = this.slotBits | (1 << slot);
         this.branches[slot] = branch;
-    };
+    }
     /**
      * @returns true if node is empty
      */
-    ShaMapInner.prototype.empty = function () {
+    empty() {
         return this.slotBits === 0;
-    };
+    }
     /**
      * Compute the hash of this node
      *
      * @returns The hash of this node
      */
-    ShaMapInner.prototype.hash = function () {
+    hash() {
         if (this.empty()) {
             return types_1.coreTypes.Hash256.ZERO_256;
         }
-        var hash = hashes_1.Sha512Half.put(this.hashPrefix());
+        const hash = hashes_1.Sha512Half.put(this.hashPrefix());
         this.toBytesSink(hash);
         return hash.finish();
-    };
+    }
     /**
      * Writes the bytes representation of this node to a BytesList
      *
      * @param list BytesList to write bytes to
      */
-    ShaMapInner.prototype.toBytesSink = function (list) {
-        for (var i = 0; i < this.branches.length; i++) {
-            var branch = this.branches[i];
-            var hash = branch ? branch.hash() : types_1.coreTypes.Hash256.ZERO_256;
+    toBytesSink(list) {
+        for (let i = 0; i < this.branches.length; i++) {
+            const branch = this.branches[i];
+            const hash = branch
+                ? branch.hash()
+                : types_1.coreTypes.Hash256.ZERO_256;
             hash.toBytesSink(list);
         }
-    };
+    }
     /**
      * Add item to the SHAMap
      *
@@ -163,34 +141,32 @@ var ShaMapInner = /** @class */ (function (_super) {
      * @param item Item to insert in the map
      * @param leaf Leaf node to insert when branch doesn't exist
      */
-    ShaMapInner.prototype.addItem = function (index, item, leaf) {
-        assert_1.strict(index !== undefined);
-        var nibble = index.nibblet(this.depth);
-        var existing = this.branches[nibble];
-        if (existing === undefined) {
-            this.setBranch(nibble, leaf || new ShaMapLeaf(index, item));
-        }
-        else if (existing instanceof ShaMapLeaf) {
-            var newInner = new ShaMapInner(this.depth + 1);
-            newInner.addItem(existing.index, undefined, existing);
-            newInner.addItem(index, item, leaf);
-            this.setBranch(nibble, newInner);
-        }
-        else if (existing instanceof ShaMapInner) {
-            existing.addItem(index, item, leaf);
+    addItem(index, item, leaf) {
+        if (index === undefined) {
+            throw new Error();
         }
-        else {
-            throw new Error("invalid ShaMap.addItem call");
+        if (index !== undefined) {
+            const nibble = index.nibblet(this.depth);
+            const existing = this.branches[nibble];
+            if (existing === undefined) {
+                this.setBranch(nibble, leaf || new ShaMapLeaf(index, item));
+            }
+            else if (existing instanceof ShaMapLeaf) {
+                const newInner = new ShaMapInner(this.depth + 1);
+                newInner.addItem(existing.index, undefined, existing);
+                newInner.addItem(index, item, leaf);
+                this.setBranch(nibble, newInner);
+            }
+            else if (existing instanceof ShaMapInner) {
+                existing.addItem(index, item, leaf);
+            }
+            else {
+                throw new Error('invalid ShaMap.addItem call');
+            }
         }
-    };
-    return ShaMapInner;
-}(ShaMapNode));
-var ShaMap = /** @class */ (function (_super) {
-    __extends(ShaMap, _super);
-    function ShaMap() {
-        return _super !== null && _super.apply(this, arguments) || this;
     }
-    return ShaMap;
-}(ShaMapInner));
+}
+class ShaMap extends ShaMapInner {
+}
 exports.ShaMap = ShaMap;
 //# sourceMappingURL=shamap.js.map

package/dist/shamap.js.map

@@ -1 +1 @@
-{"version":3,"file":"shamap.js","sourceRoot":"","sources":["../src/shamap.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iCAA0C;AAC1C,iCAAoC;AACpC,iDAA6C;AAC7C,mCAAsC;AAGtC,kCAAiC;AAEjC;;GAEG;AACH;IAAA;IAMA,CAAC;IAAD,iBAAC;AAAD,CAAC,AAND,IAMC;AAoKgB,gCAAU;AAlK3B;;GAEG;AACH;IAAyB,8BAAU;IACjC,oBAAmB,KAAc,EAAS,IAAiB;QAA3D,YACE,iBAAO,SACR;QAFkB,WAAK,GAAL,KAAK,CAAS;QAAS,UAAI,GAAJ,IAAI,CAAa;;IAE3D,CAAC;IAED;;OAEG;IACH,2BAAM,GAAN;QACE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,4BAAO,GAAP;QACE,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,+BAAU,GAAV;QACE,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,eAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,yBAAI,GAAJ;QACE,IAAM,IAAI,GAAG,mBAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QAC/C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,gCAAW,GAAX,UAAY,IAAe;QACzB,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;YAC3B,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;SAC7B;QACD,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IACH,iBAAC;AAAD,CAAC,AAjDD,CAAyB,UAAU,GAiDlC;AA8G4B,gCAAU;AA5GvC;;GAEG;AACH;IAA0B,+BAAU;IAIlC,qBAAoB,KAAiB;QAAjB,sBAAA,EAAA,SAAiB;QAArC,YACE,iBAAO,SACR;QAFmB,WAAK,GAAL,KAAK,CAAY;QAH7B,cAAQ,GAAG,CAAC,CAAC;QACb,cAAQ,GAAsB,KAAK,CAAC,EAAE,CAAC,CAAC;;IAIhD,CAAC;IAED;;OAEG;IACH,6BAAO,GAAP;QACE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,4BAAM,GAAN;QACE,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,gCAAU,GAAV;QACE,OAAO,0BAAU,CAAC,SAAS,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,+BAAS,GAAT,UAAU,IAAY,EAAE,MAAkB;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,2BAAK,GAAL;QACE,OAAO,IAAI,CAAC,QAAQ,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACH,0BAAI,GAAJ;QACE,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE;YAChB,OAAO,iBAAS,CAAC,OAAO,CAAC,QAAQ,CAAC;SACnC;QACD,IAAM,IAAI,GAAG,mBAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QAC/C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,iCAAW,GAAX,UAAY,IAAe;QACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC7C,IAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAChC,IAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,iBAAS,CAAC,OAAO,CAAC,QAAQ,CAAC;YACjE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;SACxB;IACH,CAAC;IAED;;;;;;OAMG;IACH,6BAAO,GAAP,UAAQ,KAAe,EAAE,IAAiB,EAAE,IAAiB;QAC3D,eAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;QAC5B,IAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzC,IAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAEvC,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,IAAI,IAAI,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;SAC7D;aAAM,IAAI,QAAQ,YAAY,UAAU,EAAE;YACzC,IAAM,QAAQ,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;YACjD,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;YACtD,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACpC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;SAClC;aAAM,IAAI,QAAQ,YAAY,WAAW,EAAE;YAC1C,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;SACrC;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;SAChD;IACH,CAAC;IACH,kBAAC;AAAD,CAAC,AArGD,CAA0B,UAAU,GAqGnC;AAED;IAAqB,0BAAW;IAAhC;;IAAkC,CAAC;IAAD,aAAC;AAAD,CAAC,AAAnC,CAAqB,WAAW,GAAG;AAE1B,wBAAM"}
+{"version":3,"file":"shamap.js","sourceRoot":"","sources":["../src/shamap.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,mDAA4C;AAC5C,qCAAqC;AAIrC;;GAEG;AACH,MAAe,UAAU;CAMxB;AA0KgB,gCAAU;AAxK3B;;GAEG;AACH,MAAM,UAAW,SAAQ,UAAU;IACjC,YAAmB,KAAc,EAAS,IAAiB;QACzD,KAAK,EAAE,CAAA;QADU,UAAK,GAAL,KAAK,CAAS;QAAS,SAAI,GAAJ,IAAI,CAAa;IAE3D,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAA;IAC7E,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,MAAM,IAAI,GAAG,mBAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;QAC9C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;QACtB,OAAO,IAAI,CAAC,MAAM,EAAE,CAAA;IACtB,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,IAAe;QACzB,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;YAC3B,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;SAC5B;QACD,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IAC9B,CAAC;CACF;AAoH4B,gCAAU;AAlHvC;;GAEG;AACH,MAAM,WAAY,SAAQ,UAAU;IAIlC,YAAoB,QAAgB,CAAC;QACnC,KAAK,EAAE,CAAA;QADW,UAAK,GAAL,KAAK,CAAY;QAH7B,aAAQ,GAAG,CAAC,CAAA;QACZ,aAAQ,GAAsB,KAAK,CAAC,EAAE,CAAC,CAAA;IAI/C,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,OAAO,0BAAU,CAAC,SAAS,CAAA;IAC7B,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,IAAY,EAAE,MAAkB;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAA;QAC3C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,MAAM,CAAA;IAC9B,CAAC;IAED;;OAEG;IACH,KAAK;QACH,OAAO,IAAI,CAAC,QAAQ,KAAK,CAAC,CAAA;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE;YAChB,OAAQ,iBAAS,CAAC,OAA0B,CAAC,QAAQ,CAAA;SACtD;QACD,MAAM,IAAI,GAAG,mBAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;QAC9C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;QACtB,OAAO,IAAI,CAAC,MAAM,EAAE,CAAA;IACtB,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,IAAe;QACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;YAC/B,MAAM,IAAI,GAAG,MAAM;gBACjB,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE;gBACf,CAAC,CAAE,iBAAS,CAAC,OAA0B,CAAC,QAAQ,CAAA;YAClD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;SACvB;IACH,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,KAAe,EAAE,IAAiB,EAAE,IAAiB;QAC3D,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;YAEtC,IAAI,QAAQ,KAAK,SAAS,EAAE;gBAC1B,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,IAAI,IAAI,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;aAC5D;iBAAM,IAAI,QAAQ,YAAY,UAAU,EAAE;gBACzC,MAAM,QAAQ,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;gBAChD,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;gBACrD,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;gBACnC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;aACjC;iBAAM,IAAI,QAAQ,YAAY,WAAW,EAAE;gBAC1C,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;aACpC;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;aAC/C;SACF;IACH,CAAC;CACF;AAED,MAAM,MAAO,SAAQ,WAAW;CAAG;AAE1B,wBAAM"}

package/dist/src/binary.d.ts

@@ -0,0 +1,90 @@
+import { BinaryParser } from './serdes/binary-parser';
+import { AccountID } from './types/account-id';
+import { BinarySerializer, BytesList } from './serdes/binary-serializer';
+import { sha512Half, transactionID } from './hashes';
+import { type XrplDefinitionsBase } from './enums';
+import { JsonObject } from './types/serialized-type';
+/**
+ * Construct a BinaryParser
+ *
+ * @param bytes hex-string or Uint8Array to construct BinaryParser from
+ * @param definitions rippled definitions used to parse the values of transaction types and such.
+ *                          Can be customized for sidechains and amendments.
+ * @returns BinaryParser
+ */
+declare const makeParser: (bytes: string | Uint8Array, definitions?: XrplDefinitionsBase) => BinaryParser;
+/**
+ * Parse BinaryParser into JSON
+ *
+ * @param parser BinaryParser object
+ * @param definitions rippled definitions used to parse the values of transaction types and such.
+ *                          Can be customized for sidechains and amendments.
+ * @returns JSON for the bytes in the BinaryParser
+ */
+declare const readJSON: (parser: BinaryParser, definitions?: XrplDefinitionsBase) => JsonObject;
+/**
+ * Parse a hex-string into its JSON interpretation
+ *
+ * @param bytes hex-string to parse into JSON
+ * @param definitions rippled definitions used to parse the values of transaction types and such.
+ *                          Can be customized for sidechains and amendments.
+ * @returns JSON
+ */
+declare const binaryToJSON: (bytes: string, definitions?: XrplDefinitionsBase) => JsonObject;
+/**
+ * Interface for passing parameters to SerializeObject
+ *
+ * @field set signingFieldOnly to true if you want to serialize only signing fields
+ */
+interface OptionObject {
+    prefix?: Uint8Array;
+    suffix?: Uint8Array;
+    signingFieldsOnly?: boolean;
+    definitions?: XrplDefinitionsBase;
+}
+/**
+ * Function to serialize JSON object representing a transaction
+ *
+ * @param object JSON object to serialize
+ * @param opts options for serializing, including optional prefix, suffix, signingFieldOnly, and definitions
+ * @returns A Uint8Array containing the serialized object
+ */
+declare function serializeObject(object: JsonObject, opts?: OptionObject): Uint8Array;
+/**
+ * Serialize an object for signing
+ *
+ * @param transaction Transaction to serialize
+ * @param prefix Prefix bytes to put before the serialized object
+ * @param opts.definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
+ * @returns A Uint8Array with the serialized object
+ */
+declare function signingData(transaction: JsonObject, prefix?: Uint8Array, opts?: {
+    definitions?: XrplDefinitionsBase;
+}): Uint8Array;
+/**
+ * Interface describing fields required for a Claim
+ */
+interface ClaimObject extends JsonObject {
+    channel: string;
+    amount: string | number;
+}
+/**
+ * Serialize a signingClaim
+ *
+ * @param claim A claim object to serialize
+ * @param opts.definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
+ * @returns the serialized object with appropriate prefix
+ */
+declare function signingClaimData(claim: ClaimObject): Uint8Array;
+/**
+ * Serialize a transaction object for multiSigning
+ *
+ * @param transaction transaction to serialize
+ * @param signingAccount Account to sign the transaction with
+ * @param opts.definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
+ * @returns serialized transaction with appropriate prefix and suffix
+ */
+declare function multiSigningData(transaction: JsonObject, signingAccount: string | AccountID, opts?: {
+    definitions: XrplDefinitionsBase;
+}): Uint8Array;
+export { BinaryParser, BinarySerializer, BytesList, ClaimObject, makeParser, serializeObject, readJSON, multiSigningData, signingData, signingClaimData, binaryToJSON, sha512Half, transactionID, };

package/dist/src/binary.js

@@ -0,0 +1,128 @@
+"use strict";
+/* eslint-disable func-style */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transactionID = exports.sha512Half = exports.binaryToJSON = exports.signingClaimData = exports.signingData = exports.multiSigningData = exports.readJSON = exports.serializeObject = exports.makeParser = exports.BytesList = exports.BinarySerializer = exports.BinaryParser = void 0;
+const utils_1 = require("@xrplf/isomorphic/utils");
+const types_1 = require("./types");
+const binary_parser_1 = require("./serdes/binary-parser");
+Object.defineProperty(exports, "BinaryParser", { enumerable: true, get: function () { return binary_parser_1.BinaryParser; } });
+const hash_prefixes_1 = require("./hash-prefixes");
+const binary_serializer_1 = require("./serdes/binary-serializer");
+Object.defineProperty(exports, "BinarySerializer", { enumerable: true, get: function () { return binary_serializer_1.BinarySerializer; } });
+Object.defineProperty(exports, "BytesList", { enumerable: true, get: function () { return binary_serializer_1.BytesList; } });
+const hashes_1 = require("./hashes");
+Object.defineProperty(exports, "sha512Half", { enumerable: true, get: function () { return hashes_1.sha512Half; } });
+Object.defineProperty(exports, "transactionID", { enumerable: true, get: function () { return hashes_1.transactionID; } });
+const enums_1 = require("./enums");
+/**
+ * Construct a BinaryParser
+ *
+ * @param bytes hex-string or Uint8Array to construct BinaryParser from
+ * @param definitions rippled definitions used to parse the values of transaction types and such.
+ *                          Can be customized for sidechains and amendments.
+ * @returns BinaryParser
+ */
+const makeParser = (bytes, definitions) => new binary_parser_1.BinaryParser(bytes instanceof Uint8Array ? (0, utils_1.bytesToHex)(bytes) : bytes, definitions);
+exports.makeParser = makeParser;
+/**
+ * Parse BinaryParser into JSON
+ *
+ * @param parser BinaryParser object
+ * @param definitions rippled definitions used to parse the values of transaction types and such.
+ *                          Can be customized for sidechains and amendments.
+ * @returns JSON for the bytes in the BinaryParser
+ */
+const readJSON = (parser, definitions = enums_1.DEFAULT_DEFINITIONS) => parser.readType(types_1.coreTypes.STObject).toJSON(definitions);
+exports.readJSON = readJSON;
+/**
+ * Parse a hex-string into its JSON interpretation
+ *
+ * @param bytes hex-string to parse into JSON
+ * @param definitions rippled definitions used to parse the values of transaction types and such.
+ *                          Can be customized for sidechains and amendments.
+ * @returns JSON
+ */
+const binaryToJSON = (bytes, definitions) => readJSON(makeParser(bytes, definitions), definitions);
+exports.binaryToJSON = binaryToJSON;
+/**
+ * Function to serialize JSON object representing a transaction
+ *
+ * @param object JSON object to serialize
+ * @param opts options for serializing, including optional prefix, suffix, signingFieldOnly, and definitions
+ * @returns A Uint8Array containing the serialized object
+ */
+function serializeObject(object, opts = {}) {
+    const { prefix, suffix, signingFieldsOnly = false, definitions } = opts;
+    const bytesList = new binary_serializer_1.BytesList();
+    if (prefix) {
+        bytesList.put(prefix);
+    }
+    const filter = signingFieldsOnly
+        ? (f) => f.isSigningField
+        : undefined;
+    types_1.coreTypes.STObject
+        .from(object, filter, definitions)
+        .toBytesSink(bytesList);
+    if (suffix) {
+        bytesList.put(suffix);
+    }
+    return bytesList.toBytes();
+}
+exports.serializeObject = serializeObject;
+/**
+ * Serialize an object for signing
+ *
+ * @param transaction Transaction to serialize
+ * @param prefix Prefix bytes to put before the serialized object
+ * @param opts.definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
+ * @returns A Uint8Array with the serialized object
+ */
+function signingData(transaction, prefix = hash_prefixes_1.HashPrefix.transactionSig, opts = {}) {
+    return serializeObject(transaction, {
+        prefix,
+        signingFieldsOnly: true,
+        definitions: opts.definitions,
+    });
+}
+exports.signingData = signingData;
+/**
+ * Serialize a signingClaim
+ *
+ * @param claim A claim object to serialize
+ * @param opts.definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
+ * @returns the serialized object with appropriate prefix
+ */
+function signingClaimData(claim) {
+    const num = BigInt(String(claim.amount));
+    const prefix = hash_prefixes_1.HashPrefix.paymentChannelClaim;
+    const channel = types_1.coreTypes.Hash256.from(claim.channel).toBytes();
+    const amount = types_1.coreTypes.UInt64.from(num).toBytes();
+    const bytesList = new binary_serializer_1.BytesList();
+    bytesList.put(prefix);
+    bytesList.put(channel);
+    bytesList.put(amount);
+    return bytesList.toBytes();
+}
+exports.signingClaimData = signingClaimData;
+/**
+ * Serialize a transaction object for multiSigning
+ *
+ * @param transaction transaction to serialize
+ * @param signingAccount Account to sign the transaction with
+ * @param opts.definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
+ * @returns serialized transaction with appropriate prefix and suffix
+ */
+function multiSigningData(transaction, signingAccount, opts = {
+    definitions: enums_1.DEFAULT_DEFINITIONS,
+}) {
+    const prefix = hash_prefixes_1.HashPrefix.transactionMultiSig;
+    const suffix = types_1.coreTypes.AccountID.from(signingAccount).toBytes();
+    return serializeObject(transaction, {
+        prefix,
+        suffix,
+        signingFieldsOnly: true,
+        definitions: opts.definitions,
+    });
+}
+exports.multiSigningData = multiSigningData;
+//# sourceMappingURL=binary.js.map

package/dist/src/binary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binary.js","sourceRoot":"","sources":["../../src/binary.ts"],"names":[],"mappings":";AAAA,+BAA+B;;;AAE/B,mDAAoD;AACpD,mCAAmC;AACnC,0DAAqD;AAgLnD,6FAhLO,4BAAY,OAgLP;AA9Kd,mDAA4C;AAC5C,kEAAwE;AA8KtE,iGA9KO,oCAAgB,OA8KP;AAChB,0FA/KyB,6BAAS,OA+KzB;AA9KX,qCAAoD;AAuLlD,2FAvLO,mBAAU,OAuLP;AACV,8FAxLmB,sBAAa,OAwLnB;AAvLf,mCAIgB;AAIhB;;;;;;;GAOG;AACH,MAAM,UAAU,GAAG,CACjB,KAA0B,EAC1B,WAAiC,EACnB,EAAE,CAChB,IAAI,4BAAY,CACd,KAAK,YAAY,UAAU,CAAC,CAAC,CAAC,IAAA,kBAAU,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,EACvD,WAAW,CACZ,CAAA;AAwJD,gCAAU;AAtJZ;;;;;;;GAOG;AACH,MAAM,QAAQ,GAAG,CACf,MAAoB,EACpB,cAAmC,2BAAmB,EAC1C,EAAE,CACb,MAAM,CAAC,QAAQ,CAAC,iBAAS,CAAC,QAAQ,CAAc,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;AA4IrE,4BAAQ;AA1IV;;;;;;;GAOG;AACH,MAAM,YAAY,GAAG,CACnB,KAAa,EACb,WAAiC,EACrB,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,WAAW,CAAC,CAAA;AAmIpE,oCAAY;AArHd;;;;;;GAMG;AACH,SAAS,eAAe,CACtB,MAAkB,EAClB,OAAqB,EAAE;IAEvB,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,GAAG,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAA;IACvE,MAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAA;IAEjC,IAAI,MAAM,EAAE;QACV,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;KACtB;IAED,MAAM,MAAM,GAAG,iBAAiB;QAC9B,CAAC,CAAC,CAAC,CAAgB,EAAW,EAAE,CAAC,CAAC,CAAC,cAAc;QACjD,CAAC,CAAC,SAAS,CACZ;IAAC,iBAAS,CAAC,QAA4B;SACrC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC;SACjC,WAAW,CAAC,SAAS,CAAC,CAAA;IAEzB,IAAI,MAAM,EAAE;QACV,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;KACtB;IAED,OAAO,SAAS,CAAC,OAAO,EAAE,CAAA;AAC5B,CAAC;AAkFC,0CAAe;AAhFjB;;;;;;;GAOG;AACH,SAAS,WAAW,CAClB,WAAuB,EACvB,SAAqB,0BAAU,CAAC,cAAc,EAC9C,OAA8C,EAAE;IAEhD,OAAO,eAAe,CAAC,WAAW,EAAE;QAClC,MAAM;QACN,iBAAiB,EAAE,IAAI;QACvB,WAAW,EAAE,IAAI,CAAC,WAAW;KAC9B,CAAC,CAAA;AACJ,CAAC;AAiEC,kCAAW;AAvDb;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,KAAkB;IAC1C,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;IACxC,MAAM,MAAM,GAAG,0BAAU,CAAC,mBAAmB,CAAA;IAC7C,MAAM,OAAO,GAAG,iBAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAA;IAC/D,MAAM,MAAM,GAAG,iBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAA;IAEnD,MAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAA;IAEjC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACrB,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IACtB,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACrB,OAAO,SAAS,CAAC,OAAO,EAAE,CAAA;AAC5B,CAAC;AAqCC,4CAAgB;AAnClB;;;;;;;GAOG;AACH,SAAS,gBAAgB,CACvB,WAAuB,EACvB,cAAkC,EAClC,OAA6C;IAC3C,WAAW,EAAE,2BAAmB;CACjC;IAED,MAAM,MAAM,GAAG,0BAAU,CAAC,mBAAmB,CAAA;IAC7C,MAAM,MAAM,GAAG,iBAAS,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,EAAE,CAAA;IACjE,OAAO,eAAe,CAAC,WAAW,EAAE;QAClC,MAAM;QACN,MAAM;QACN,iBAAiB,EAAE,IAAI;QACvB,WAAW,EAAE,IAAI,CAAC,WAAW;KAC9B,CAAC,CAAA;AACJ,CAAC;AAUC,4CAAgB"}

package/dist/src/coretypes.d.ts

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

package/dist/src/coretypes.js

@@ -0,0 +1,48 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.types = exports.ShaMap = exports.HashPrefix = exports.quality = exports.TransactionResult = exports.Type = exports.LedgerEntryType = exports.TransactionType = exports.Field = exports.DEFAULT_DEFINITIONS = exports.ledgerHashes = exports.binary = exports.hashes = void 0;
+const enums_1 = require("./enums");
+Object.defineProperty(exports, "DEFAULT_DEFINITIONS", { enumerable: true, get: function () { return enums_1.DEFAULT_DEFINITIONS; } });
+Object.defineProperty(exports, "Field", { enumerable: true, get: function () { return enums_1.Field; } });
+Object.defineProperty(exports, "TransactionType", { enumerable: true, get: function () { return enums_1.TransactionType; } });
+Object.defineProperty(exports, "LedgerEntryType", { enumerable: true, get: function () { return enums_1.LedgerEntryType; } });
+Object.defineProperty(exports, "Type", { enumerable: true, get: function () { return enums_1.Type; } });
+Object.defineProperty(exports, "TransactionResult", { enumerable: true, get: function () { return enums_1.TransactionResult; } });
+const types = __importStar(require("./types"));
+exports.types = types;
+const binary = __importStar(require("./binary"));
+exports.binary = binary;
+const shamap_1 = require("./shamap");
+Object.defineProperty(exports, "ShaMap", { enumerable: true, get: function () { return shamap_1.ShaMap; } });
+const ledgerHashes = __importStar(require("./ledger-hashes"));
+exports.ledgerHashes = ledgerHashes;
+const hashes = __importStar(require("./hashes"));
+exports.hashes = hashes;
+const quality_1 = require("./quality");
+Object.defineProperty(exports, "quality", { enumerable: true, get: function () { return quality_1.quality; } });
+const hash_prefixes_1 = require("./hash-prefixes");
+Object.defineProperty(exports, "HashPrefix", { enumerable: true, get: function () { return hash_prefixes_1.HashPrefix; } });
+//# sourceMappingURL=coretypes.js.map

package/dist/src/coretypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coretypes.js","sourceRoot":"","sources":["../../src/coretypes.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAOgB;AAad,oGAnBA,2BAAmB,OAmBA;AACnB,sFAnBA,aAAK,OAmBA;AACL,gGAnBA,uBAAe,OAmBA;AACf,gGAnBA,uBAAe,OAmBA;AACf,qFAnBA,YAAI,OAmBA;AACJ,kGAnBA,yBAAiB,OAmBA;AAjBnB,+CAAgC;AAqB9B,sBAAK;AApBP,iDAAkC;AAShC,wBAAM;AARR,qCAAiC;AAkB/B,uFAlBO,eAAM,OAkBP;AAjBR,8DAA+C;AAQ7C,oCAAY;AAPd,iDAAkC;AAKhC,wBAAM;AAJR,uCAAmC;AAajC,wFAbO,iBAAO,OAaP;AAZT,mDAA4C;AAa1C,2FAbO,0BAAU,OAaP"}

package/dist/src/enums/bytes.d.ts

@@ -0,0 +1,25 @@
+import { BytesList, BinaryParser } from '../binary';
+export declare class Bytes {
+    readonly name: string;
+    readonly ordinal: number;
+    readonly ordinalWidth: number;
+    readonly bytes: Uint8Array;
+    constructor(name: string, ordinal: number, ordinalWidth: number);
+    toJSON(): string;
+    toBytesSink(sink: BytesList): void;
+    toBytes(): Uint8Array;
+}
+export declare class BytesLookup {
+    readonly ordinalWidth: number;
+    constructor(types: Record<string, number>, ordinalWidth: number);
+    /**
+     * Add a new name value pair to the BytesLookup.
+     *
+     * @param name - A human readable name for the field.
+     * @param value - The numeric value for the field.
+     * @throws if the name or value already exist in the lookup because it's unclear how to decode.
+     */
+    add(name: string, value: number): void;
+    from(value: Bytes | string): Bytes;
+    fromParser(parser: BinaryParser): Bytes;
+}