ripple-binary-codec 1.6.0 → 1.7.0

package/dist/enums/definitions.json

@@ -321,6 +321,16 @@
                 "type": "UInt16"
             }
         ],
+        [
+            "NetworkID",
+            {
+                "nth": 1,
+                "isVLEncoded": false,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "UInt32"
+            }
+        ],
         [
             "Flags",
             {
@@ -2176,6 +2186,9 @@
         "telCAN_NOT_QUEUE_BLOCKED": -389,
         "telCAN_NOT_QUEUE_FEE": -388,
         "telCAN_NOT_QUEUE_FULL": -387,
+        "telWRONG_NETWORK": -386,
+        "telREQUIRES_NETWORK_ID": -385,
+        "telNETWORK_ID_MAKES_TX_NON_CANONICAL": -384,
         "temMALFORMED": -299,
         "temBAD_AMOUNT": -298,
         "temBAD_CURRENCY": -297,

package/dist/enums/src/enums/definitions.json

@@ -321,6 +321,16 @@
         "type": "UInt16"
       }
     ],
+    [
+      "NetworkID",
+      {
+        "nth": 1,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "UInt32"
+      }
+    ],
     [
       "Flags",
       {
@@ -2176,6 +2186,9 @@
     "telCAN_NOT_QUEUE_BLOCKED": -389,
     "telCAN_NOT_QUEUE_FEE": -388,
     "telCAN_NOT_QUEUE_FULL": -387,
+    "telWRONG_NETWORK": -386,
+    "telREQUIRES_NETWORK_ID": -385,
+    "telNETWORK_ID_MAKES_TX_NON_CANONICAL": -384,
 
     "temMALFORMED": -299,
     "temBAD_AMOUNT": -298,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ripple-binary-codec",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "XRP Ledger binary codec",
   "files": [
     "dist/*",
@@ -40,5 +40,5 @@
   "engines": {
     "node": ">= 10"
   },
-  "gitHead": "3791c6292cee7e6d6ff46a17fcd26aae2d323439"
+  "gitHead": "c523a7c80b43a6e0faa5ec2a54b27c21b722497e"
 }

package/dist/types/issue.d.ts

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

@@ -1,81 +0,0 @@
-"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

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

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

@@ -1,102 +0,0 @@
-"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

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