@transia/ripple-binary-codec 1.4.4-alpha.0

package/dist/serdes/binary-parser.js

@@ -0,0 +1,210 @@
+"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.BinaryParser = void 0;
+const assert = __importStar(require("assert"));
+const enums_1 = require("../enums");
+const buffer_1 = require("buffer/");
+/**
+ * BinaryParser is used to compute fields and values from a HexString
+ */
+class BinaryParser {
+    /**
+     * Initialize bytes to a hex string
+     *
+     * @param hexBytes a hex string
+     * @param definitions Rippled definitions used to parse the values of transaction types and such.
+     *                          Can be customized for sidechains and amendments.
+     */
+    constructor(hexBytes, definitions = enums_1.DEFAULT_DEFINITIONS) {
+        this.bytes = buffer_1.Buffer.from(hexBytes, 'hex');
+        this.definitions = definitions;
+    }
+    /**
+     * Peek the first byte of the BinaryParser
+     *
+     * @returns The first byte of the BinaryParser
+     */
+    peek() {
+        assert.ok(this.bytes.byteLength !== 0);
+        return this.bytes[0];
+    }
+    /**
+     * Consume the first n bytes of the BinaryParser
+     *
+     * @param n the number of bytes to skip
+     */
+    skip(n) {
+        assert.ok(n <= this.bytes.byteLength);
+        this.bytes = this.bytes.slice(n);
+    }
+    /**
+     * read the first n bytes from the BinaryParser
+     *
+     * @param n The number of bytes to read
+     * @return The bytes
+     */
+    read(n) {
+        assert.ok(n <= this.bytes.byteLength);
+        const slice = this.bytes.slice(0, n);
+        this.skip(n);
+        return slice;
+    }
+    /**
+     * Read an integer of given size
+     *
+     * @param n The number of bytes to read
+     * @return The number represented by those bytes
+     */
+    readUIntN(n) {
+        assert.ok(0 < n && n <= 4, 'invalid n');
+        return this.read(n).reduce((a, b) => (a << 8) | b) >>> 0;
+    }
+    readUInt8() {
+        return this.readUIntN(1);
+    }
+    readUInt16() {
+        return this.readUIntN(2);
+    }
+    readUInt32() {
+        return this.readUIntN(4);
+    }
+    size() {
+        return this.bytes.byteLength;
+    }
+    end(customEnd) {
+        const length = this.bytes.byteLength;
+        return length === 0 || (customEnd !== undefined && length <= customEnd);
+    }
+    /**
+     * Reads variable length encoded bytes
+     *
+     * @return The variable length bytes
+     */
+    readVariableLength() {
+        return this.read(this.readVariableLengthLength());
+    }
+    /**
+     * Reads the length of the variable length encoded bytes
+     *
+     * @return The length of the variable length encoded bytes
+     */
+    readVariableLengthLength() {
+        const b1 = this.readUInt8();
+        if (b1 <= 192) {
+            return b1;
+        }
+        else if (b1 <= 240) {
+            const b2 = this.readUInt8();
+            return 193 + (b1 - 193) * 256 + b2;
+        }
+        else if (b1 <= 254) {
+            const b2 = this.readUInt8();
+            const b3 = this.readUInt8();
+            return 12481 + (b1 - 241) * 65536 + b2 * 256 + b3;
+        }
+        throw new Error('Invalid variable length indicator');
+    }
+    /**
+     * Reads the field ordinal from the BinaryParser
+     *
+     * @return Field ordinal
+     */
+    readFieldOrdinal() {
+        let type = this.readUInt8();
+        let nth = type & 15;
+        type >>= 4;
+        if (type === 0) {
+            type = this.readUInt8();
+            if (type === 0 || type < 16) {
+                throw new Error('Cannot read FieldOrdinal, type_code out of range');
+            }
+        }
+        if (nth === 0) {
+            nth = this.readUInt8();
+            if (nth === 0 || nth < 16) {
+                throw new Error('Cannot read FieldOrdinal, field_code out of range');
+            }
+        }
+        return (type << 16) | nth;
+    }
+    /**
+     * Read the field from the BinaryParser
+     *
+     * @return The field represented by the bytes at the head of the BinaryParser
+     */
+    readField() {
+        return this.definitions.field.fromString(this.readFieldOrdinal().toString());
+    }
+    /**
+     * Read a given type from the BinaryParser
+     *
+     * @param type The type that you want to read from the BinaryParser
+     * @return The instance of that type read from the BinaryParser
+     */
+    readType(type) {
+        return type.fromParser(this);
+    }
+    /**
+     * Get the type associated with a given field
+     *
+     * @param field The field that you wan to get the type of
+     * @return The type associated with the given field
+     */
+    typeForField(field) {
+        return field.associatedType;
+    }
+    /**
+     * Read value of the type specified by field from the BinaryParser
+     *
+     * @param field The field that you want to get the associated value for
+     * @return The value associated with the given field
+     */
+    readFieldValue(field) {
+        const type = this.typeForField(field);
+        if (!type) {
+            throw new Error(`unsupported: (${field.name}, ${field.type.name})`);
+        }
+        const sizeHint = field.isVariableLengthEncoded
+            ? this.readVariableLengthLength()
+            : undefined;
+        const value = type.fromParser(this, sizeHint);
+        if (value === undefined) {
+            throw new Error(`fromParser for (${field.name}, ${field.type.name}) -> undefined `);
+        }
+        return value;
+    }
+    /**
+     * Get the next field and value from the BinaryParser
+     *
+     * @return The field and value
+     */
+    readFieldAndValue() {
+        const field = this.readField();
+        return [field, this.readFieldValue(field)];
+    }
+}
+exports.BinaryParser = BinaryParser;
+//# sourceMappingURL=binary-parser.js.map

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,+CAAgC;AAChC,oCAIiB;AAEjB,oCAAgC;AAEhC;;GAEG;AACH,MAAM,YAAY;IAIhB;;;;;;OAMG;IACH,YACE,QAAgB,EAChB,cAAmC,2BAAmB;QAEtD,IAAI,CAAC,KAAK,GAAG,eAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;QACzC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,KAAK,CAAC,CAAC,CAAA;QACtC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,CAAS;QACZ,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QACrC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAClC,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,CAAS;QACZ,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QAErC,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,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,CAAA;QACvC,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,82 @@
+import { FieldInstance } from '../enums';
+import { type SerializedType } from '../types/serialized-type';
+import { Buffer } from 'buffer/';
+/**
+ * Bytes list is a collection of buffer 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 Buffer
+     * @return this BytesList
+     */
+    put(bytesArg: Buffer): BytesList;
+    /**
+     * Write this BytesList to the back of another bytes list
+     *
+     *  @param list The BytesList to write to
+     */
+    toBytesSink(list: BytesList): void;
+    toBytes(): Buffer;
+    toHex(): string;
+}
+/**
+ * BinarySerializer is used to write fields and values to buffers
+ */
+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: Buffer): 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,172 @@
+"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.BinarySerializer = exports.BytesList = void 0;
+const assert = __importStar(require("assert"));
+const buffer_1 = require("buffer/");
+/**
+ * Bytes list is a collection of buffer objects
+ */
+class BytesList {
+    constructor() {
+        this.bytesArray = [];
+    }
+    /**
+     * Get the total number of bytes in the BytesList
+     *
+     * @return the number of bytes
+     */
+    getLength() {
+        return buffer_1.Buffer.concat(this.bytesArray).byteLength;
+    }
+    /**
+     * Put bytes in the BytesList
+     *
+     * @param bytesArg A Buffer
+     * @return this BytesList
+     */
+    put(bytesArg) {
+        const bytes = buffer_1.Buffer.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 buffer_1.Buffer.concat(this.bytesArray);
+    }
+    toHex() {
+        return this.toBytes().toString('hex').toUpperCase();
+    }
+}
+exports.BytesList = BytesList;
+/**
+ * BinarySerializer is used to write fields and values to buffers
+ */
+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 = buffer_1.Buffer.alloc(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);
+        assert.ok(associatedValue.toBytesSink !== undefined);
+        assert.ok(field.name !== undefined);
+        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":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAgC;AAGhC,oCAAgC;AAEhC;;GAEG;AACH,MAAM,SAAS;IAAf;QACU,eAAU,GAAkB,EAAE,CAAA;IAuCxC,CAAC;IArCC;;;;OAIG;IACI,SAAS;QACd,OAAO,eAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,UAAU,CAAA;IAClD,CAAC;IAED;;;;;OAKG;IACI,GAAG,CAAC,QAAgB;QACzB,MAAM,KAAK,GAAG,eAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA,CAAC,8DAA8D;QAClG,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,eAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACvC,CAAC;IAED,KAAK;QACH,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAA;IACrD,CAAC;CACF;AAqHQ,8BAAS;AAnHlB;;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,KAAa;QACf,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,eAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAChC,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,MAAM,CAAC,EAAE,CAAC,eAAe,CAAC,WAAW,KAAK,SAAS,CAAC,CAAA;QACpD,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAA;QAEnC,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,103 @@
+import { Hash256 } from './types/hash-256';
+import { BytesList } from './serdes/binary-serializer';
+import { Buffer } from 'buffer/';
+/**
+ * Abstract class describing a SHAMapNode
+ */
+declare abstract class ShaMapNode {
+    abstract hashPrefix(): Buffer;
+    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 Buffer
+     */
+    hashPrefix(): Buffer;
+    /**
+     * 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(): Buffer;
+    /**
+     * 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 };