ripple-binary-codec 0.2.7 → 1.0.0-mpt-beta

package/dist/serdes/binary-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binary-parser.js","sourceRoot":"","sources":["../../src/serdes/binary-parser.ts"],"names":[],"mappings":";;;AAAA,oCAIiB;AAEjB,mDAAoD;AAEpD;;GAEG;AACH,MAAM,YAAY;IAIhB;;;;;;OAMG;IACH,YACE,QAAgB,EAChB,cAAmC,2BAAmB;QAEtD,IAAI,CAAC,KAAK,GAAG,IAAA,kBAAU,EAAC,QAAQ,CAAC,CAAA;QACjC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,KAAK,CAAC,EAAE;YAC/B,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,CAAS;QACZ,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;YAC7B,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAClC,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,CAAS;QACZ,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;YAC7B,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACpC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACZ,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,CAAS;QACjB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAA;SAC7B;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAA;IAC1D,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;IAC1B,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;IAC1B,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;IAC1B,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAA;IAC9B,CAAC;IAED,GAAG,CAAC,SAAkB;QACpB,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAA;QACpC,OAAO,MAAM,KAAK,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,MAAM,IAAI,SAAS,CAAC,CAAA;IACzE,CAAC;IAED;;;;OAIG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC,CAAA;IACnD,CAAC;IAED;;;;OAIG;IACH,wBAAwB;QACtB,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;QAC3B,IAAI,EAAE,IAAI,GAAG,EAAE;YACb,OAAO,EAAE,CAAA;SACV;aAAM,IAAI,EAAE,IAAI,GAAG,EAAE;YACpB,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YAC3B,OAAO,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,CAAA;SACnC;aAAM,IAAI,EAAE,IAAI,GAAG,EAAE;YACpB,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YAC3B,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YAC3B,OAAO,KAAK,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,GAAG,KAAK,GAAG,EAAE,GAAG,GAAG,GAAG,EAAE,CAAA;SAClD;QACD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;IACtD,CAAC;IAED;;;;OAIG;IACH,gBAAgB;QACd,IAAI,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;QAC3B,IAAI,GAAG,GAAG,IAAI,GAAG,EAAE,CAAA;QACnB,IAAI,KAAK,CAAC,CAAA;QAEV,IAAI,IAAI,KAAK,CAAC,EAAE;YACd,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YACvB,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,GAAG,EAAE,EAAE;gBAC3B,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;aACpE;SACF;QAED,IAAI,GAAG,KAAK,CAAC,EAAE;YACb,GAAG,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YACtB,IAAI,GAAG,KAAK,CAAC,IAAI,GAAG,GAAG,EAAE,EAAE;gBACzB,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;aACrE;SACF;QAED,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,GAAG,GAAG,CAAA;IAC3B,CAAC;IAED;;;;OAIG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC9E,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,IAA2B;QAClC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;IAC9B,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,KAAoB;QAC/B,OAAO,KAAK,CAAC,cAAc,CAAA;IAC7B,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,KAAoB;QACjC,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;QACrC,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,IAAI,KAAK,CAAC,iBAAiB,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAA;SACpE;QACD,MAAM,QAAQ,GAAG,KAAK,CAAC,uBAAuB;YAC5C,CAAC,CAAC,IAAI,CAAC,wBAAwB,EAAE;YACjC,CAAC,CAAC,SAAS,CAAA;QACb,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QAC7C,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,MAAM,IAAI,KAAK,CACb,mBAAmB,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,iBAAiB,CACnE,CAAA;SACF;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;OAIG;IACH,iBAAiB;QACf,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;QAC9B,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAA;IAC5C,CAAC;CACF;AAEQ,oCAAY"}

package/dist/serdes/binary-serializer.d.ts

@@ -0,0 +1,81 @@
+import { FieldInstance } from '../enums';
+import { type SerializedType } from '../types/serialized-type';
+/**
+ * Bytes list is a collection of Uint8Array objects
+ */
+declare class BytesList {
+    private bytesArray;
+    /**
+     * Get the total number of bytes in the BytesList
+     *
+     * @return the number of bytes
+     */
+    getLength(): number;
+    /**
+     * Put bytes in the BytesList
+     *
+     * @param bytesArg A Uint8Array
+     * @return this BytesList
+     */
+    put(bytesArg: Uint8Array): BytesList;
+    /**
+     * Write this BytesList to the back of another bytes list
+     *
+     *  @param list The BytesList to write to
+     */
+    toBytesSink(list: BytesList): void;
+    toBytes(): Uint8Array;
+    toHex(): string;
+}
+/**
+ * BinarySerializer is used to write fields and values to Uint8Arrays
+ */
+declare class BinarySerializer {
+    private sink;
+    constructor(sink: BytesList);
+    /**
+     * Write a value to this BinarySerializer
+     *
+     * @param value a SerializedType value
+     */
+    write(value: SerializedType): void;
+    /**
+     * Write bytes to this BinarySerializer
+     *
+     * @param bytes the bytes to write
+     */
+    put(bytes: Uint8Array): void;
+    /**
+     * Write a value of a given type to this BinarySerializer
+     *
+     * @param type the type to write
+     * @param value a value of that type
+     */
+    writeType(type: typeof SerializedType, value: SerializedType): void;
+    /**
+     * Write BytesList to this BinarySerializer
+     *
+     * @param bl BytesList to write to BinarySerializer
+     */
+    writeBytesList(bl: BytesList): void;
+    /**
+     * Calculate the header of Variable Length encoded bytes
+     *
+     * @param length the length of the bytes
+     */
+    private encodeVariableLength;
+    /**
+     * Write field and value to BinarySerializer
+     *
+     * @param field field to write to BinarySerializer
+     * @param value value to write to BinarySerializer
+     */
+    writeFieldAndValue(field: FieldInstance, value: SerializedType, isUnlModifyWorkaround?: boolean): void;
+    /**
+     * Write a variable length encoded value to the BinarySerializer
+     *
+     * @param value length encoded value to write to BytesList
+     */
+    writeLengthEncoded(value: SerializedType, isUnlModifyWorkaround?: boolean): void;
+}
+export { BytesList, BinarySerializer };

package/dist/serdes/binary-serializer.js

@@ -0,0 +1,149 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BinarySerializer = exports.BytesList = void 0;
+const utils_1 = require("@xrplf/isomorphic/utils");
+/**
+ * Bytes list is a collection of Uint8Array objects
+ */
+class BytesList {
+    constructor() {
+        this.bytesArray = [];
+    }
+    /**
+     * Get the total number of bytes in the BytesList
+     *
+     * @return the number of bytes
+     */
+    getLength() {
+        return (0, utils_1.concat)(this.bytesArray).byteLength;
+    }
+    /**
+     * Put bytes in the BytesList
+     *
+     * @param bytesArg A Uint8Array
+     * @return this BytesList
+     */
+    put(bytesArg) {
+        const bytes = Uint8Array.from(bytesArg); // Temporary, to catch instances of Uint8Array being passed in
+        this.bytesArray.push(bytes);
+        return this;
+    }
+    /**
+     * Write this BytesList to the back of another bytes list
+     *
+     *  @param list The BytesList to write to
+     */
+    toBytesSink(list) {
+        list.put(this.toBytes());
+    }
+    toBytes() {
+        return (0, utils_1.concat)(this.bytesArray);
+    }
+    toHex() {
+        return (0, utils_1.bytesToHex)(this.toBytes());
+    }
+}
+exports.BytesList = BytesList;
+/**
+ * BinarySerializer is used to write fields and values to Uint8Arrays
+ */
+class BinarySerializer {
+    constructor(sink) {
+        this.sink = new BytesList();
+        this.sink = sink;
+    }
+    /**
+     * Write a value to this BinarySerializer
+     *
+     * @param value a SerializedType value
+     */
+    write(value) {
+        value.toBytesSink(this.sink);
+    }
+    /**
+     * Write bytes to this BinarySerializer
+     *
+     * @param bytes the bytes to write
+     */
+    put(bytes) {
+        this.sink.put(bytes);
+    }
+    /**
+     * Write a value of a given type to this BinarySerializer
+     *
+     * @param type the type to write
+     * @param value a value of that type
+     */
+    writeType(type, value) {
+        this.write(type.from(value));
+    }
+    /**
+     * Write BytesList to this BinarySerializer
+     *
+     * @param bl BytesList to write to BinarySerializer
+     */
+    writeBytesList(bl) {
+        bl.toBytesSink(this.sink);
+    }
+    /**
+     * Calculate the header of Variable Length encoded bytes
+     *
+     * @param length the length of the bytes
+     */
+    encodeVariableLength(length) {
+        const lenBytes = new Uint8Array(3);
+        if (length <= 192) {
+            lenBytes[0] = length;
+            return lenBytes.slice(0, 1);
+        }
+        else if (length <= 12480) {
+            length -= 193;
+            lenBytes[0] = 193 + (length >>> 8);
+            lenBytes[1] = length & 0xff;
+            return lenBytes.slice(0, 2);
+        }
+        else if (length <= 918744) {
+            length -= 12481;
+            lenBytes[0] = 241 + (length >>> 16);
+            lenBytes[1] = (length >> 8) & 0xff;
+            lenBytes[2] = length & 0xff;
+            return lenBytes.slice(0, 3);
+        }
+        throw new Error('Overflow error');
+    }
+    /**
+     * Write field and value to BinarySerializer
+     *
+     * @param field field to write to BinarySerializer
+     * @param value value to write to BinarySerializer
+     */
+    writeFieldAndValue(field, value, isUnlModifyWorkaround = false) {
+        const associatedValue = field.associatedType.from(value);
+        if (associatedValue.toBytesSink === undefined || field.name === undefined) {
+            throw new Error();
+        }
+        this.sink.put(field.header);
+        if (field.isVariableLengthEncoded) {
+            this.writeLengthEncoded(associatedValue, isUnlModifyWorkaround);
+        }
+        else {
+            associatedValue.toBytesSink(this.sink);
+        }
+    }
+    /**
+     * Write a variable length encoded value to the BinarySerializer
+     *
+     * @param value length encoded value to write to BytesList
+     */
+    writeLengthEncoded(value, isUnlModifyWorkaround = false) {
+        const bytes = new BytesList();
+        if (!isUnlModifyWorkaround) {
+            // this part doesn't happen for the Account field in a UNLModify transaction
+            value.toBytesSink(bytes);
+        }
+        this.put(this.encodeVariableLength(bytes.getLength()));
+        this.writeBytesList(bytes);
+    }
+}
+exports.BinarySerializer = BinarySerializer;
+//# sourceMappingURL=binary-serializer.js.map

package/dist/serdes/binary-serializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binary-serializer.js","sourceRoot":"","sources":["../../src/serdes/binary-serializer.ts"],"names":[],"mappings":";;;AAEA,mDAA4D;AAE5D;;GAEG;AACH,MAAM,SAAS;IAAf;QACU,eAAU,GAAsB,EAAE,CAAA;IAuC5C,CAAC;IArCC;;;;OAIG;IACI,SAAS;QACd,OAAO,IAAA,cAAM,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC,UAAU,CAAA;IAC3C,CAAC;IAED;;;;;OAKG;IACI,GAAG,CAAC,QAAoB;QAC7B,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA,CAAC,8DAA8D;QACtG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC3B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,IAAe;QAChC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;IAC1B,CAAC;IAEM,OAAO;QACZ,OAAO,IAAA,cAAM,EAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IAChC,CAAC;IAED,KAAK;QACH,OAAO,IAAA,kBAAU,EAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;IACnC,CAAC;CACF;AAsHQ,8BAAS;AApHlB;;GAEG;AACH,MAAM,gBAAgB;IAGpB,YAAY,IAAe;QAFnB,SAAI,GAAc,IAAI,SAAS,EAAE,CAAA;QAGvC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAqB;QACzB,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC9B,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,KAAiB;QACnB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACtB,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,IAA2B,EAAE,KAAqB;QAC1D,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;IAC9B,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,EAAa;QAC1B,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;IAED;;;;OAIG;IACK,oBAAoB,CAAC,MAAc;QACzC,MAAM,QAAQ,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;QAClC,IAAI,MAAM,IAAI,GAAG,EAAE;YACjB,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAAA;YACpB,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;SAC5B;aAAM,IAAI,MAAM,IAAI,KAAK,EAAE;YAC1B,MAAM,IAAI,GAAG,CAAA;YACb,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;YAClC,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,IAAI,CAAA;YAC3B,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;SAC5B;aAAM,IAAI,MAAM,IAAI,MAAM,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAA;YACf,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,MAAM,KAAK,EAAE,CAAC,CAAA;YACnC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,IAAI,CAAA;YAClC,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,IAAI,CAAA;YAC3B,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;SAC5B;QACD,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAA;IACnC,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAChB,KAAoB,EACpB,KAAqB,EACrB,qBAAqB,GAAG,KAAK;QAE7B,MAAM,eAAe,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACxD,IAAI,eAAe,CAAC,WAAW,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE;YACzE,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QAED,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAE3B,IAAI,KAAK,CAAC,uBAAuB,EAAE;YACjC,IAAI,CAAC,kBAAkB,CAAC,eAAe,EAAE,qBAAqB,CAAC,CAAA;SAChE;aAAM;YACL,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;SACvC;IACH,CAAC;IAED;;;;OAIG;IACI,kBAAkB,CACvB,KAAqB,EACrB,qBAAqB,GAAG,KAAK;QAE7B,MAAM,KAAK,GAAG,IAAI,SAAS,EAAE,CAAA;QAC7B,IAAI,CAAC,qBAAqB,EAAE;YAC1B,4EAA4E;YAC5E,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;SACzB;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAA;QACtD,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;IAC5B,CAAC;CACF;AAEmB,4CAAgB"}

package/dist/shamap.d.ts

@@ -0,0 +1,102 @@
+import { Hash256 } from './types/hash-256';
+import { BytesList } from './serdes/binary-serializer';
+/**
+ * Abstract class describing a SHAMapNode
+ */
+declare abstract class ShaMapNode {
+    abstract hashPrefix(): Uint8Array;
+    abstract isLeaf(): boolean;
+    abstract isInner(): boolean;
+    abstract toBytesSink(list: BytesList): void;
+    abstract hash(): Hash256;
+}
+/**
+ * Class describing a Leaf of SHAMap
+ */
+declare class ShaMapLeaf extends ShaMapNode {
+    index: Hash256;
+    item?: ShaMapNode | undefined;
+    constructor(index: Hash256, item?: ShaMapNode | undefined);
+    /**
+     * @returns true as ShaMapLeaf is a leaf node
+     */
+    isLeaf(): boolean;
+    /**
+     * @returns false as ShaMapLeaf is not an inner node
+     */
+    isInner(): boolean;
+    /**
+     * Get the prefix of the this.item
+     *
+     * @returns The hash prefix, unless this.item is undefined, then it returns an empty Uint8Array
+     */
+    hashPrefix(): Uint8Array;
+    /**
+     * Hash the bytes representation of this
+     *
+     * @returns hash of this.item concatenated with this.index
+     */
+    hash(): Hash256;
+    /**
+     * Write the bytes representation of this to a BytesList
+     * @param list BytesList to write bytes to
+     */
+    toBytesSink(list: BytesList): void;
+}
+/**
+ * Class defining an Inner Node of a SHAMap
+ */
+declare class ShaMapInner extends ShaMapNode {
+    private depth;
+    private slotBits;
+    private branches;
+    constructor(depth?: number);
+    /**
+     * @returns true as ShaMapInner is an inner node
+     */
+    isInner(): boolean;
+    /**
+     * @returns false as ShaMapInner is not a leaf node
+     */
+    isLeaf(): boolean;
+    /**
+     * Get the hash prefix for this node
+     *
+     * @returns hash prefix describing an inner node
+     */
+    hashPrefix(): Uint8Array;
+    /**
+     * Set a branch of this node to be another node
+     *
+     * @param slot Slot to add branch to this.branches
+     * @param branch Branch to add
+     */
+    setBranch(slot: number, branch: ShaMapNode): void;
+    /**
+     * @returns true if node is empty
+     */
+    empty(): boolean;
+    /**
+     * Compute the hash of this node
+     *
+     * @returns The hash of this node
+     */
+    hash(): Hash256;
+    /**
+     * Writes the bytes representation of this node to a BytesList
+     *
+     * @param list BytesList to write bytes to
+     */
+    toBytesSink(list: BytesList): void;
+    /**
+     * Add item to the SHAMap
+     *
+     * @param index Hash of the index of the item being inserted
+     * @param item Item to insert in the map
+     * @param leaf Leaf node to insert when branch doesn't exist
+     */
+    addItem(index?: Hash256, item?: ShaMapNode, leaf?: ShaMapLeaf): void;
+}
+declare class ShaMap extends ShaMapInner {
+}
+export { ShaMap, ShaMapNode, ShaMapLeaf };

package/dist/shamap.js

@@ -0,0 +1,172 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShaMapLeaf = exports.ShaMapNode = exports.ShaMap = void 0;
+const types_1 = require("./types");
+const hash_prefixes_1 = require("./hash-prefixes");
+const hashes_1 = require("./hashes");
+/**
+ * Abstract class describing a SHAMapNode
+ */
+class ShaMapNode {
+}
+exports.ShaMapNode = ShaMapNode;
+/**
+ * Class describing a Leaf of SHAMap
+ */
+class ShaMapLeaf extends ShaMapNode {
+    constructor(index, item) {
+        super();
+        this.index = index;
+        this.item = item;
+    }
+    /**
+     * @returns true as ShaMapLeaf is a leaf node
+     */
+    isLeaf() {
+        return true;
+    }
+    /**
+     * @returns false as ShaMapLeaf is not an inner node
+     */
+    isInner() {
+        return false;
+    }
+    /**
+     * Get the prefix of the this.item
+     *
+     * @returns The hash prefix, unless this.item is undefined, then it returns an empty Uint8Array
+     */
+    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
+     */
+    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
+     */
+    toBytesSink(list) {
+        if (this.item !== undefined) {
+            this.item.toBytesSink(list);
+        }
+        this.index.toBytesSink(list);
+    }
+}
+exports.ShaMapLeaf = ShaMapLeaf;
+/**
+ * Class defining an Inner Node of a SHAMap
+ */
+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
+     */
+    isInner() {
+        return true;
+    }
+    /**
+     * @returns false as ShaMapInner is not a leaf node
+     */
+    isLeaf() {
+        return false;
+    }
+    /**
+     * Get the hash prefix for this node
+     *
+     * @returns hash prefix describing an inner node
+     */
+    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
+     */
+    setBranch(slot, branch) {
+        this.slotBits = this.slotBits | (1 << slot);
+        this.branches[slot] = branch;
+    }
+    /**
+     * @returns true if node is empty
+     */
+    empty() {
+        return this.slotBits === 0;
+    }
+    /**
+     * Compute the hash of this node
+     *
+     * @returns The hash of this node
+     */
+    hash() {
+        if (this.empty()) {
+            return types_1.coreTypes.Hash256.ZERO_256;
+        }
+        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
+     */
+    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
+     *
+     * @param index Hash of the index of the item being inserted
+     * @param item Item to insert in the map
+     * @param leaf Leaf node to insert when branch doesn't exist
+     */
+    addItem(index, item, leaf) {
+        if (index === undefined) {
+            throw new Error();
+        }
+        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');
+            }
+        }
+    }
+}
+class ShaMap extends ShaMapInner {
+}
+exports.ShaMap = ShaMap;
+//# sourceMappingURL=shamap.js.map

package/dist/shamap.js.map

@@ -0,0 +1 @@
+{"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, };