ripple-binary-codec 1.7.1 → 1.9.0

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;AAAA,6CAAwC;AA2CtC,0FA3CO,sBAAS,OA2CP;AA1CX,qCAAiC;AA2C/B,uFA3CO,eAAM,OA2CP;AA1CR,iCAA6B;AA2C3B,qFA3CO,WAAI,OA2CP;AA1CN,yCAAqC;AA2CnC,yFA3CO,mBAAQ,OA2CP;AA1CV,yCAAoC;AA2ClC,wFA3CO,kBAAO,OA2CP;AA1CT,yCAAoC;AA2ClC,wFA3CO,kBAAO,OA2CP;AA1CT,yCAAoC;AA2ClC,wFA3CO,kBAAO,OA2CP;AA1CT,yCAAoC;AA2ClC,wFA3CO,kBAAO,OA2CP;AA1CT,yCAAoC;AA2ClC,wFA3CO,kBAAO,OA2CP;AA1CT,2CAAsC;AA2CpC,yFA3CO,oBAAQ,OA2CP;AA1CV,uCAAkC;AA4ChC,uFA5CO,gBAAM,OA4CP;AA3CR,uCAAkC;AA4ChC,uFA5CO,gBAAM,OA4CP;AA3CR,uCAAkC;AA4ChC,uFA5CO,gBAAM,OA4CP;AA3CR,qCAAgC;AAwC9B,sFAxCO,cAAK,OAwCP;AAvCP,6CAAwC;AA2CtC,0FA3CO,sBAAS,OA2CP;AAzCX,oCAA8C;AAE9C,MAAM,SAAS,GAA0C;IACvD,SAAS,EAAT,sBAAS;IACT,MAAM,EAAN,eAAM;IACN,IAAI,EAAJ,WAAI;IACJ,QAAQ,EAAR,mBAAQ;IACR,OAAO,EAAP,kBAAO;IACP,OAAO,EAAP,kBAAO;IACP,OAAO,EAAP,kBAAO;IACP,OAAO,EAAP,kBAAO;IACP,OAAO,EAAP,kBAAO;IACP,QAAQ,EAAR,oBAAQ;IACR,KAAK,EAAL,cAAK;IACL,MAAM,EAAN,gBAAM;IACN,MAAM,EAAN,gBAAM;IACN,MAAM,EAAN,gBAAM;IACN,SAAS,EAAT,sBAAS;CACV,CAAA;AAQC,8BAAS;AANX,2GAA2G;AAC3G,gFAAgF;AAChF,8FAA8F;AAC9F,2BAAmB,CAAC,cAAc,CAAC,SAAS,CAAC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;AAAA,6CAAwC;AA6CtC,0FA7CO,sBAAS,OA6CP;AA5CX,qCAAiC;AA6C/B,uFA7CO,eAAM,OA6CP;AA5CR,iCAA6B;AA6C3B,qFA7CO,WAAI,OA6CP;AA5CN,yCAAqC;AA6CnC,yFA7CO,mBAAQ,OA6CP;AA5CV,yCAAoC;AA6ClC,wFA7CO,kBAAO,OA6CP;AA5CT,yCAAoC;AA6ClC,wFA7CO,kBAAO,OA6CP;AA5CT,yCAAoC;AA6ClC,wFA7CO,kBAAO,OA6CP;AA5CT,mCAA+B;AAC/B,yCAAoC;AA4ClC,wFA5CO,kBAAO,OA4CP;AA3CT,yCAAoC;AA4ClC,wFA5CO,kBAAO,OA4CP;AA3CT,2CAAsC;AA4CpC,yFA5CO,oBAAQ,OA4CP;AA3CV,uCAAkC;AA6ChC,uFA7CO,gBAAM,OA6CP;AA5CR,uCAAkC;AA6ChC,uFA7CO,gBAAM,OA6CP;AA5CR,uCAAkC;AA6ChC,uFA7CO,gBAAM,OA6CP;AA5CR,qCAAgC;AAyC9B,sFAzCO,cAAK,OAyCP;AAxCP,6CAAwC;AA4CtC,0FA5CO,sBAAS,OA4CP;AA1CX,oCAA8C;AAE9C,MAAM,SAAS,GAA0C;IACvD,SAAS,EAAT,sBAAS;IACT,MAAM,EAAN,eAAM;IACN,IAAI,EAAJ,WAAI;IACJ,QAAQ,EAAR,mBAAQ;IACR,OAAO,EAAP,kBAAO;IACP,OAAO,EAAP,kBAAO;IACP,OAAO,EAAP,kBAAO;IACP,KAAK,EAAL,aAAK;IACL,OAAO,EAAP,kBAAO;IACP,OAAO,EAAP,kBAAO;IACP,QAAQ,EAAR,oBAAQ;IACR,KAAK,EAAL,cAAK;IACL,MAAM,EAAN,gBAAM;IACN,MAAM,EAAN,gBAAM;IACN,MAAM,EAAN,gBAAM;IACN,SAAS,EAAT,sBAAS;CACV,CAAA;AAQC,8BAAS;AANX,2GAA2G;AAC3G,gFAAgF;AAChF,8FAA8F;AAC9F,2BAAmB,CAAC,cAAc,CAAC,SAAS,CAAC,CAAA"}

package/dist/types/issue.d.ts

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

package/dist/types/issue.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Issue = void 0;
+const binary_parser_1 = require("../serdes/binary-parser");
+const account_id_1 = require("./account-id");
+const currency_1 = require("./currency");
+const serialized_type_1 = require("./serialized-type");
+const buffer_1 = require("buffer/");
+/**
+ * Type guard for AmountObject
+ */
+function isIssueObject(arg) {
+    const keys = Object.keys(arg).sort();
+    if (keys.length === 1) {
+        return keys[0] === 'currency';
+    }
+    return keys.length === 2 && keys[0] === 'currency' && keys[1] === 'issuer';
+}
+/**
+ * Class for serializing/Deserializing Amounts
+ */
+class Issue extends serialized_type_1.SerializedType {
+    constructor(bytes) {
+        super(bytes !== null && bytes !== void 0 ? bytes : Issue.ZERO_ISSUED_CURRENCY.bytes);
+    }
+    /**
+     * Construct an amount from an IOU or string amount
+     *
+     * @param value An Amount, object representing an IOU, or a string
+     *     representing an integer amount
+     * @returns An Amount object
+     */
+    static from(value) {
+        if (value instanceof Issue) {
+            return value;
+        }
+        if (isIssueObject(value)) {
+            const currency = currency_1.Currency.from(value.currency).toBytes();
+            if (value.issuer == null) {
+                return new Issue(currency);
+            }
+            const issuer = account_id_1.AccountID.from(value.issuer).toBytes();
+            return new Issue(buffer_1.Buffer.concat([currency, issuer]));
+        }
+        throw new Error('Invalid type to construct an Amount');
+    }
+    /**
+     * Read an amount from a BinaryParser
+     *
+     * @param parser BinaryParser to read the Amount from
+     * @returns An Amount object
+     */
+    static fromParser(parser) {
+        const currency = parser.read(20);
+        if (new currency_1.Currency(currency).toJSON() === 'XRP') {
+            return new Issue(currency);
+        }
+        const currencyAndIssuer = [currency, parser.read(20)];
+        return new Issue(buffer_1.Buffer.concat(currencyAndIssuer));
+    }
+    /**
+     * Get the JSON representation of this Amount
+     *
+     * @returns the JSON interpretation of this.bytes
+     */
+    toJSON() {
+        const parser = new binary_parser_1.BinaryParser(this.toString());
+        const currency = currency_1.Currency.fromParser(parser);
+        if (currency.toJSON() === 'XRP') {
+            return { currency: currency.toJSON() };
+        }
+        const issuer = account_id_1.AccountID.fromParser(parser);
+        return {
+            currency: currency.toJSON(),
+            issuer: issuer.toJSON(),
+        };
+    }
+}
+exports.Issue = Issue;
+Issue.ZERO_ISSUED_CURRENCY = new Issue(buffer_1.Buffer.alloc(20));
+//# sourceMappingURL=issue.js.map

package/dist/types/issue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"issue.js","sourceRoot":"","sources":["../../src/types/issue.ts"],"names":[],"mappings":";;;AAAA,2DAAsD;AAEtD,6CAAwC;AACxC,yCAAqC;AACrC,uDAA8D;AAC9D,oCAAgC;AAUhC;;GAEG;AACH,SAAS,aAAa,CAAC,GAAG;IACxB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IACpC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QACrB,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,CAAA;KAC9B;IACD,OAAO,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAA;AAC5E,CAAC;AAED;;GAEG;AACH,MAAM,KAAM,SAAQ,gCAAc;IAGhC,YAAY,KAAa;QACvB,KAAK,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAA;IAClD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAgC,KAAQ;QACjD,IAAI,KAAK,YAAY,KAAK,EAAE;YAC1B,OAAO,KAAK,CAAA;SACb;QAED,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE;YACxB,MAAM,QAAQ,GAAG,mBAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAA;YACxD,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,EAAE;gBACxB,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAA;aAC3B;YACD,MAAM,MAAM,GAAG,sBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAA;YACrD,OAAO,IAAI,KAAK,CAAC,eAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAA;SACpD;QAED,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;IACxD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAChC,IAAI,IAAI,mBAAQ,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,KAAK,KAAK,EAAE;YAC7C,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAA;SAC3B;QACD,MAAM,iBAAiB,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;QACrD,OAAO,IAAI,KAAK,CAAC,eAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAA;IACpD,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,MAAM,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QAChD,MAAM,QAAQ,GAAG,mBAAQ,CAAC,UAAU,CAAC,MAAM,CAAa,CAAA;QACxD,IAAI,QAAQ,CAAC,MAAM,EAAE,KAAK,KAAK,EAAE;YAC/B,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAA;SACvC;QACD,MAAM,MAAM,GAAG,sBAAS,CAAC,UAAU,CAAC,MAAM,CAAc,CAAA;QAExD,OAAO;YACL,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE;YAC3B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;SACxB,CAAA;IACH,CAAC;;AAGM,sBAAK;AAjEI,0BAAoB,GAAU,IAAI,KAAK,CAAC,eAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAA"}

package/dist/types/xchain-bridge.d.ts

@@ -0,0 +1,45 @@
+import { BinaryParser } from '../serdes/binary-parser';
+import { JsonObject, SerializedType } from './serialized-type';
+import { Buffer } from 'buffer/';
+import { IssueObject } from './issue';
+/**
+ * Interface for JSON objects that represent cross-chain bridges
+ */
+interface XChainBridgeObject extends JsonObject {
+    LockingChainDoor: string;
+    LockingChainIssue: IssueObject | string;
+    IssuingChainDoor: string;
+    IssuingChainIssue: IssueObject | string;
+}
+/**
+ * Class for serializing/deserializing XChainBridges
+ */
+declare class XChainBridge extends SerializedType {
+    static readonly ZERO_XCHAIN_BRIDGE: XChainBridge;
+    static readonly TYPE_ORDER: {
+        name: string;
+        type: typeof SerializedType;
+    }[];
+    constructor(bytes: Buffer);
+    /**
+     * Construct a cross-chain bridge from a JSON
+     *
+     * @param value XChainBridge or JSON to parse into a XChainBridge
+     * @returns A XChainBridge object
+     */
+    static from<T extends XChainBridge | XChainBridgeObject>(value: T): XChainBridge;
+    /**
+     * Read a XChainBridge from a BinaryParser
+     *
+     * @param parser BinaryParser to read the XChainBridge from
+     * @returns A XChainBridge object
+     */
+    static fromParser(parser: BinaryParser): XChainBridge;
+    /**
+     * Get the JSON representation of this XChainBridge
+     *
+     * @returns the JSON interpretation of this.bytes
+     */
+    toJSON(): XChainBridgeObject;
+}
+export { XChainBridge, XChainBridgeObject };

package/dist/types/xchain-bridge.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XChainBridge = void 0;
+const binary_parser_1 = require("../serdes/binary-parser");
+const account_id_1 = require("./account-id");
+const serialized_type_1 = require("./serialized-type");
+const buffer_1 = require("buffer/");
+const issue_1 = require("./issue");
+/**
+ * Type guard for XChainBridgeObject
+ */
+function isXChainBridgeObject(arg) {
+    const keys = Object.keys(arg).sort();
+    return (keys.length === 4 &&
+        keys[0] === 'IssuingChainDoor' &&
+        keys[1] === 'IssuingChainIssue' &&
+        keys[2] === 'LockingChainDoor' &&
+        keys[3] === 'LockingChainIssue');
+}
+/**
+ * Class for serializing/deserializing XChainBridges
+ */
+class XChainBridge extends serialized_type_1.SerializedType {
+    constructor(bytes) {
+        super(bytes !== null && bytes !== void 0 ? bytes : XChainBridge.ZERO_XCHAIN_BRIDGE.bytes);
+    }
+    /**
+     * Construct a cross-chain bridge from a JSON
+     *
+     * @param value XChainBridge or JSON to parse into a XChainBridge
+     * @returns A XChainBridge object
+     */
+    static from(value) {
+        if (value instanceof XChainBridge) {
+            return value;
+        }
+        if (isXChainBridgeObject(value)) {
+            const bytes = [];
+            this.TYPE_ORDER.forEach((item) => {
+                const { name, type } = item;
+                if (type === account_id_1.AccountID) {
+                    bytes.push(buffer_1.Buffer.from([0x14]));
+                }
+                const object = type.from(value[name]);
+                bytes.push(object.toBytes());
+            });
+            return new XChainBridge(buffer_1.Buffer.concat(bytes));
+        }
+        throw new Error('Invalid type to construct a XChainBridge');
+    }
+    /**
+     * Read a XChainBridge from a BinaryParser
+     *
+     * @param parser BinaryParser to read the XChainBridge from
+     * @returns A XChainBridge object
+     */
+    static fromParser(parser) {
+        const bytes = [];
+        this.TYPE_ORDER.forEach((item) => {
+            const { type } = item;
+            if (type === account_id_1.AccountID) {
+                parser.skip(1);
+                bytes.push(buffer_1.Buffer.from([0x14]));
+            }
+            const object = type.fromParser(parser);
+            bytes.push(object.toBytes());
+        });
+        return new XChainBridge(buffer_1.Buffer.concat(bytes));
+    }
+    /**
+     * Get the JSON representation of this XChainBridge
+     *
+     * @returns the JSON interpretation of this.bytes
+     */
+    toJSON() {
+        const parser = new binary_parser_1.BinaryParser(this.toString());
+        const json = {};
+        XChainBridge.TYPE_ORDER.forEach((item) => {
+            const { name, type } = item;
+            if (type === account_id_1.AccountID) {
+                parser.skip(1);
+            }
+            const object = type.fromParser(parser).toJSON();
+            json[name] = object;
+        });
+        return json;
+    }
+}
+exports.XChainBridge = XChainBridge;
+XChainBridge.ZERO_XCHAIN_BRIDGE = new XChainBridge(buffer_1.Buffer.concat([
+    buffer_1.Buffer.from([0x14]),
+    buffer_1.Buffer.alloc(40),
+    buffer_1.Buffer.from([0x14]),
+    buffer_1.Buffer.alloc(40),
+]));
+XChainBridge.TYPE_ORDER = [
+    { name: 'LockingChainDoor', type: account_id_1.AccountID },
+    { name: 'LockingChainIssue', type: issue_1.Issue },
+    { name: 'IssuingChainDoor', type: account_id_1.AccountID },
+    { name: 'IssuingChainIssue', type: issue_1.Issue },
+];
+//# sourceMappingURL=xchain-bridge.js.map

package/dist/types/xchain-bridge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xchain-bridge.js","sourceRoot":"","sources":["../../src/types/xchain-bridge.ts"],"names":[],"mappings":";;;AAAA,2DAAsD;AAEtD,6CAAwC;AACxC,uDAA8D;AAC9D,oCAAgC;AAChC,mCAA4C;AAY5C;;GAEG;AACH,SAAS,oBAAoB,CAAC,GAAG;IAC/B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IACpC,OAAO,CACL,IAAI,CAAC,MAAM,KAAK,CAAC;QACjB,IAAI,CAAC,CAAC,CAAC,KAAK,kBAAkB;QAC9B,IAAI,CAAC,CAAC,CAAC,KAAK,mBAAmB;QAC/B,IAAI,CAAC,CAAC,CAAC,KAAK,kBAAkB;QAC9B,IAAI,CAAC,CAAC,CAAC,KAAK,mBAAmB,CAChC,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,YAAa,SAAQ,gCAAc;IAkBvC,YAAY,KAAa;QACvB,KAAK,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,YAAY,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAA;IACvD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CACT,KAAQ;QAER,IAAI,KAAK,YAAY,YAAY,EAAE;YACjC,OAAO,KAAK,CAAA;SACb;QAED,IAAI,oBAAoB,CAAC,KAAK,CAAC,EAAE;YAC/B,MAAM,KAAK,GAAkB,EAAE,CAAA;YAC/B,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC/B,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;gBAC3B,IAAI,IAAI,KAAK,sBAAS,EAAE;oBACtB,KAAK,CAAC,IAAI,CAAC,eAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;iBAChC;gBACD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;gBACrC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;YAC9B,CAAC,CAAC,CAAA;YACF,OAAO,IAAI,YAAY,CAAC,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;SAC9C;QAED,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,MAAM,KAAK,GAAkB,EAAE,CAAA;QAE/B,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/B,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;YACrB,IAAI,IAAI,KAAK,sBAAS,EAAE;gBACtB,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBACd,KAAK,CAAC,IAAI,CAAC,eAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;aAChC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;YACtC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;QAC9B,CAAC,CAAC,CAAA;QAEF,OAAO,IAAI,YAAY,CAAC,eAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAC/C,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,MAAM,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QAChD,MAAM,IAAI,GAAG,EAAE,CAAA;QACf,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACvC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;YAC3B,IAAI,IAAI,KAAK,sBAAS,EAAE;gBACtB,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;aACf;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAA;YAC/C,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,CAAA;QACrB,CAAC,CAAC,CAAA;QACF,OAAO,IAA0B,CAAA;IACnC,CAAC;;AAGM,oCAAY;AA5FH,+BAAkB,GAAiB,IAAI,YAAY,CACjE,eAAM,CAAC,MAAM,CAAC;IACZ,eAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;IACnB,eAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IAChB,eAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;IACnB,eAAM,CAAC,KAAK,CAAC,EAAE,CAAC;CACjB,CAAC,CACH,CAAA;AAEe,uBAAU,GACxB;IACE,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,sBAAS,EAAE;IAC7C,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,aAAK,EAAE;IAC1C,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,sBAAS,EAAE;IAC7C,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,aAAK,EAAE;CAC3C,CAAA"}

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "ripple-binary-codec",
-  "version": "1.7.1",
+  "version": "1.9.0",
   "description": "XRP Ledger binary codec",
   "files": [
     "dist/*",
-    "bin/*",
-    "test/*"
+    "src/*"
   ],
   "main": "dist/",
   "directories": {
@@ -40,5 +39,5 @@
   "engines": {
     "node": ">= 10"
   },
-  "gitHead": "5ec6729c614f6f25328f939c9a039a9fdfb6e9b1"
+  "gitHead": "37fbc03584f4671317576a97ad2cdb3f6c1e1bed"
 }

package/src/README.md

@@ -0,0 +1,3 @@
+# ripple-binary-codec
+
+Serialize and deserialize transactions according to the XRP Ledger protocol. 

package/src/binary.ts

@@ -0,0 +1,188 @@
+/* eslint-disable func-style */
+
+import { coreTypes } from './types'
+import { BinaryParser } from './serdes/binary-parser'
+import { AccountID } from './types/account-id'
+import { HashPrefix } from './hash-prefixes'
+import { BinarySerializer, BytesList } from './serdes/binary-serializer'
+import { sha512Half, transactionID } from './hashes'
+import {
+  type XrplDefinitionsBase,
+  DEFAULT_DEFINITIONS,
+  type FieldInstance,
+} from './enums'
+import { STObject } from './types/st-object'
+import { JsonObject } from './types/serialized-type'
+import { Buffer } from 'buffer/'
+import bigInt = require('big-integer')
+
+/**
+ * Construct a BinaryParser
+ *
+ * @param bytes hex-string 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 A BinaryParser
+ */
+const makeParser = (
+  bytes: string,
+  definitions?: XrplDefinitionsBase,
+): BinaryParser => new BinaryParser(bytes, definitions)
+
+/**
+ * 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: BinaryParser,
+  definitions: XrplDefinitionsBase = DEFAULT_DEFINITIONS,
+): JsonObject =>
+  (parser.readType(coreTypes.STObject) as STObject).toJSON(definitions)
+
+/**
+ * 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: string,
+  definitions?: XrplDefinitionsBase,
+): JsonObject => readJSON(makeParser(bytes, definitions), definitions)
+
+/**
+ * Interface for passing parameters to SerializeObject
+ *
+ * @field set signingFieldOnly to true if you want to serialize only signing fields
+ */
+interface OptionObject {
+  prefix?: Buffer
+  suffix?: Buffer
+  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 Buffer containing the serialized object
+ */
+function serializeObject(object: JsonObject, opts: OptionObject = {}): Buffer {
+  const { prefix, suffix, signingFieldsOnly = false, definitions } = opts
+  const bytesList = new BytesList()
+
+  if (prefix) {
+    bytesList.put(prefix)
+  }
+
+  const filter = signingFieldsOnly
+    ? (f: FieldInstance): boolean => f.isSigningField
+    : undefined
+  ;(coreTypes.STObject as typeof STObject)
+    .from(object, filter, definitions)
+    .toBytesSink(bytesList)
+
+  if (suffix) {
+    bytesList.put(suffix)
+  }
+
+  return bytesList.toBytes()
+}
+
+/**
+ * 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 Buffer with the serialized object
+ */
+function signingData(
+  transaction: JsonObject,
+  prefix: Buffer = HashPrefix.transactionSig,
+  opts: { definitions?: XrplDefinitionsBase } = {},
+): Buffer {
+  return serializeObject(transaction, {
+    prefix,
+    signingFieldsOnly: true,
+    definitions: opts.definitions,
+  })
+}
+
+/**
+ * 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
+ */
+function signingClaimData(claim: ClaimObject): Buffer {
+  const num = bigInt(String(claim.amount))
+  const prefix = HashPrefix.paymentChannelClaim
+  const channel = coreTypes.Hash256.from(claim.channel).toBytes()
+  const amount = coreTypes.UInt64.from(num).toBytes()
+
+  const bytesList = new BytesList()
+
+  bytesList.put(prefix)
+  bytesList.put(channel)
+  bytesList.put(amount)
+  return bytesList.toBytes()
+}
+
+/**
+ * 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: JsonObject,
+  signingAccount: string | AccountID,
+  opts: { definitions: XrplDefinitionsBase } = {
+    definitions: DEFAULT_DEFINITIONS,
+  },
+): Buffer {
+  const prefix = HashPrefix.transactionMultiSig
+  const suffix = coreTypes.AccountID.from(signingAccount).toBytes()
+  return serializeObject(transaction, {
+    prefix,
+    suffix,
+    signingFieldsOnly: true,
+    definitions: opts.definitions,
+  })
+}
+
+export {
+  BinaryParser,
+  BinarySerializer,
+  BytesList,
+  ClaimObject,
+  makeParser,
+  serializeObject,
+  readJSON,
+  multiSigningData,
+  signingData,
+  signingClaimData,
+  binaryToJSON,
+  sha512Half,
+  transactionID,
+}

package/src/coretypes.ts

@@ -0,0 +1,31 @@
+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,
+}