ripple-binary-codec 1.6.0-beta.0 → 1.7.0

package/dist/enums/utils-renumber.js

@@ -2,7 +2,7 @@
 /**
  * Quick script to re-number values
  */
-var input = {
+const input = {
     temBAD_SEND_XRP_PATHS: -283,
     temBAD_SEQUENCE: -282,
     temBAD_SIGNATURE: -281,
@@ -93,35 +93,35 @@ var input = {
     tecHAS_OBLIGATIONS: 151,
     tecTOO_SOON: 152,
 };
-var startingFromTemBADSENDXRPPATHS = -284;
-var startingFromTefFAILURE = -199;
-var startingFromTerRETRY = -99;
-var tesSUCCESS = 0;
-var startingFromTecCLAIM = 100;
-var startingFromTecDIRFULL = 121;
-var previousKey = 'tem';
-Object.keys(input).forEach(function (key) {
+let startingFromTemBADSENDXRPPATHS = -284;
+let startingFromTefFAILURE = -199;
+let startingFromTerRETRY = -99;
+const tesSUCCESS = 0;
+let startingFromTecCLAIM = 100;
+const startingFromTecDIRFULL = 121;
+let previousKey = 'tem';
+Object.keys(input).forEach((key) => {
     if (key.substring(0, 3) !== previousKey.substring(0, 3)) {
         console.log();
         previousKey = key;
     }
     if (key.substring(0, 3) === 'tem') {
-        console.log("    \"".concat(key, "\": ").concat(startingFromTemBADSENDXRPPATHS++, ","));
+        console.log(`    "${key}": ${startingFromTemBADSENDXRPPATHS++},`);
     }
     else if (key.substring(0, 3) === 'tef') {
-        console.log("    \"".concat(key, "\": ").concat(startingFromTefFAILURE++, ","));
+        console.log(`    "${key}": ${startingFromTefFAILURE++},`);
     }
     else if (key.substring(0, 3) === 'ter') {
-        console.log("    \"".concat(key, "\": ").concat(startingFromTerRETRY++, ","));
+        console.log(`    "${key}": ${startingFromTerRETRY++},`);
     }
     else if (key.substring(0, 3) === 'tes') {
-        console.log("    \"".concat(key, "\": ").concat(tesSUCCESS, ","));
+        console.log(`    "${key}": ${tesSUCCESS},`);
     }
     else if (key.substring(0, 3) === 'tec') {
         if (key === 'tecDIR_FULL') {
             startingFromTecCLAIM = startingFromTecDIRFULL;
         }
-        console.log("    \"".concat(key, "\": ").concat(startingFromTecCLAIM++, ","));
+        console.log(`    "${key}": ${startingFromTecCLAIM++},`);
     }
 });
 //# sourceMappingURL=utils-renumber.js.map

package/dist/enums/utils-renumber.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils-renumber.js","sourceRoot":"","sources":["../../src/enums/utils-renumber.ts"],"names":[],"mappings":";AAAA;;GAEG;AAEH,IAAM,KAAK,GAAG;IACZ,qBAAqB,EAAE,CAAC,GAAG;IAC3B,eAAe,EAAE,CAAC,GAAG;IACrB,gBAAgB,EAAE,CAAC,GAAG;IACtB,kBAAkB,EAAE,CAAC,GAAG;IACxB,oBAAoB,EAAE,CAAC,GAAG;IAC1B,aAAa,EAAE,CAAC,GAAG;IACnB,aAAa,EAAE,CAAC,GAAG;IACnB,UAAU,EAAE,CAAC,GAAG;IAChB,eAAe,EAAE,CAAC,GAAG;IACrB,YAAY,EAAE,CAAC,GAAG;IAClB,eAAe,EAAE,CAAC,GAAG;IACrB,WAAW,EAAE,CAAC,GAAG;IACjB,aAAa,EAAE,CAAC,GAAG;IACnB,aAAa,EAAE,CAAC,GAAG;IACnB,aAAa,EAAE,CAAC,GAAG;IACnB,gBAAgB,EAAE,CAAC,GAAG;IACtB,qBAAqB,EAAE,CAAC,GAAG;IAC3B,sBAAsB,EAAE,CAAC,GAAG;IAE5B,YAAY,EAAE,CAAC,GAAG;IAClB,UAAU,EAAE,CAAC,GAAG;IAEhB,UAAU,EAAE,CAAC,GAAG;IAChB,UAAU,EAAE,CAAC,GAAG;IAChB,eAAe,EAAE,CAAC,GAAG;IACrB,WAAW,EAAE,CAAC,GAAG;IACjB,aAAa,EAAE,CAAC,GAAG;IACnB,UAAU,EAAE,CAAC,GAAG;IAChB,YAAY,EAAE,CAAC,GAAG;IAClB,WAAW,EAAE,CAAC,GAAG;IACjB,mBAAmB,EAAE,CAAC,GAAG;IACzB,WAAW,EAAE,CAAC,GAAG;IACjB,cAAc,EAAE,CAAC,GAAG;IACpB,kBAAkB,EAAE,CAAC,GAAG;IACxB,aAAa,EAAE,CAAC,GAAG;IACnB,gBAAgB,EAAE,CAAC,GAAG;IACtB,aAAa,EAAE,CAAC,GAAG;IACnB,oBAAoB,EAAE,CAAC,GAAG;IAC1B,kBAAkB,EAAE,CAAC,GAAG;IACxB,mBAAmB,EAAE,CAAC,GAAG;IACzB,UAAU,EAAE,CAAC,GAAG;IAEhB,QAAQ,EAAE,CAAC,EAAE;IACb,cAAc,EAAE,CAAC,EAAE;IACnB,cAAc,EAAE,CAAC,EAAE;IACnB,aAAa,EAAE,CAAC,EAAE;IAClB,UAAU,EAAE,CAAC,EAAE;IACf,UAAU,EAAE,CAAC,EAAE;IACf,SAAS,EAAE,CAAC,EAAE;IACd,UAAU,EAAE,CAAC,EAAE;IACf,OAAO,EAAE,CAAC,EAAE;IACZ,YAAY,EAAE,CAAC,EAAE;IACjB,SAAS,EAAE,CAAC,EAAE;IAEd,UAAU,EAAE,CAAC;IAEb,QAAQ,EAAE,GAAG;IACb,eAAe,EAAE,GAAG;IACpB,eAAe,EAAE,GAAG;IACpB,iBAAiB,EAAE,GAAG;IACtB,mBAAmB,EAAE,GAAG;IACxB,oBAAoB,EAAE,GAAG;IACzB,WAAW,EAAE,GAAG;IAChB,qBAAqB,EAAE,GAAG;IAC1B,sBAAsB,EAAE,GAAG;IAC3B,SAAS,EAAE,GAAG;IACd,mBAAmB,EAAE,GAAG;IACxB,wBAAwB,EAAE,GAAG;IAC7B,oBAAoB,EAAE,GAAG;IACzB,WAAW,EAAE,GAAG;IAChB,WAAW,EAAE,GAAG;IAChB,qBAAqB,EAAE,GAAG;IAC1B,iBAAiB,EAAE,GAAG;IACtB,SAAS,EAAE,GAAG;IACd,YAAY,EAAE,GAAG;IACjB,UAAU,EAAE,GAAG;IACf,UAAU,EAAE,GAAG;IACf,aAAa,EAAE,GAAG;IAClB,SAAS,EAAE,GAAG;IACd,YAAY,EAAE,GAAG;IACjB,gBAAgB,EAAE,GAAG;IACrB,WAAW,EAAE,GAAG;IAChB,uBAAuB,EAAE,GAAG;IAC5B,kBAAkB,EAAE,GAAG;IACvB,iBAAiB,EAAE,GAAG;IACtB,WAAW,EAAE,GAAG;IAChB,WAAW,EAAE,GAAG;IAChB,wBAAwB,EAAE,GAAG;IAC7B,mBAAmB,EAAE,GAAG;IACxB,UAAU,EAAE,GAAG;IACf,YAAY,EAAE,GAAG;IACjB,SAAS,EAAE,GAAG;IACd,kBAAkB,EAAE,GAAG;IACvB,WAAW,EAAE,GAAG;CACjB,CAAA;AAED,IAAI,8BAA8B,GAAG,CAAC,GAAG,CAAA;AAEzC,IAAI,sBAAsB,GAAG,CAAC,GAAG,CAAA;AAEjC,IAAI,oBAAoB,GAAG,CAAC,EAAE,CAAA;AAE9B,IAAM,UAAU,GAAG,CAAC,CAAA;AAEpB,IAAI,oBAAoB,GAAG,GAAG,CAAA;AAE9B,IAAM,sBAAsB,GAAG,GAAG,CAAA;AAElC,IAAI,WAAW,GAAG,KAAK,CAAA;AACvB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAC,GAAG;IAC7B,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;QACvD,OAAO,CAAC,GAAG,EAAE,CAAA;QACb,WAAW,GAAG,GAAG,CAAA;KAClB;IACD,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE;QACjC,OAAO,CAAC,GAAG,CAAC,gBAAQ,GAAG,iBAAM,8BAA8B,EAAE,MAAG,CAAC,CAAA;KAClE;SAAM,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE;QACxC,OAAO,CAAC,GAAG,CAAC,gBAAQ,GAAG,iBAAM,sBAAsB,EAAE,MAAG,CAAC,CAAA;KAC1D;SAAM,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE;QACxC,OAAO,CAAC,GAAG,CAAC,gBAAQ,GAAG,iBAAM,oBAAoB,EAAE,MAAG,CAAC,CAAA;KACxD;SAAM,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE;QACxC,OAAO,CAAC,GAAG,CAAC,gBAAQ,GAAG,iBAAM,UAAU,MAAG,CAAC,CAAA;KAC5C;SAAM,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE;QACxC,IAAI,GAAG,KAAK,aAAa,EAAE;YACzB,oBAAoB,GAAG,sBAAsB,CAAA;SAC9C;QACD,OAAO,CAAC,GAAG,CAAC,gBAAQ,GAAG,iBAAM,oBAAoB,EAAE,MAAG,CAAC,CAAA;KACxD;AACH,CAAC,CAAC,CAAA"}
+{"version":3,"file":"utils-renumber.js","sourceRoot":"","sources":["../../src/enums/utils-renumber.ts"],"names":[],"mappings":";AAAA;;GAEG;AAEH,MAAM,KAAK,GAAG;IACZ,qBAAqB,EAAE,CAAC,GAAG;IAC3B,eAAe,EAAE,CAAC,GAAG;IACrB,gBAAgB,EAAE,CAAC,GAAG;IACtB,kBAAkB,EAAE,CAAC,GAAG;IACxB,oBAAoB,EAAE,CAAC,GAAG;IAC1B,aAAa,EAAE,CAAC,GAAG;IACnB,aAAa,EAAE,CAAC,GAAG;IACnB,UAAU,EAAE,CAAC,GAAG;IAChB,eAAe,EAAE,CAAC,GAAG;IACrB,YAAY,EAAE,CAAC,GAAG;IAClB,eAAe,EAAE,CAAC,GAAG;IACrB,WAAW,EAAE,CAAC,GAAG;IACjB,aAAa,EAAE,CAAC,GAAG;IACnB,aAAa,EAAE,CAAC,GAAG;IACnB,aAAa,EAAE,CAAC,GAAG;IACnB,gBAAgB,EAAE,CAAC,GAAG;IACtB,qBAAqB,EAAE,CAAC,GAAG;IAC3B,sBAAsB,EAAE,CAAC,GAAG;IAE5B,YAAY,EAAE,CAAC,GAAG;IAClB,UAAU,EAAE,CAAC,GAAG;IAEhB,UAAU,EAAE,CAAC,GAAG;IAChB,UAAU,EAAE,CAAC,GAAG;IAChB,eAAe,EAAE,CAAC,GAAG;IACrB,WAAW,EAAE,CAAC,GAAG;IACjB,aAAa,EAAE,CAAC,GAAG;IACnB,UAAU,EAAE,CAAC,GAAG;IAChB,YAAY,EAAE,CAAC,GAAG;IAClB,WAAW,EAAE,CAAC,GAAG;IACjB,mBAAmB,EAAE,CAAC,GAAG;IACzB,WAAW,EAAE,CAAC,GAAG;IACjB,cAAc,EAAE,CAAC,GAAG;IACpB,kBAAkB,EAAE,CAAC,GAAG;IACxB,aAAa,EAAE,CAAC,GAAG;IACnB,gBAAgB,EAAE,CAAC,GAAG;IACtB,aAAa,EAAE,CAAC,GAAG;IACnB,oBAAoB,EAAE,CAAC,GAAG;IAC1B,kBAAkB,EAAE,CAAC,GAAG;IACxB,mBAAmB,EAAE,CAAC,GAAG;IACzB,UAAU,EAAE,CAAC,GAAG;IAEhB,QAAQ,EAAE,CAAC,EAAE;IACb,cAAc,EAAE,CAAC,EAAE;IACnB,cAAc,EAAE,CAAC,EAAE;IACnB,aAAa,EAAE,CAAC,EAAE;IAClB,UAAU,EAAE,CAAC,EAAE;IACf,UAAU,EAAE,CAAC,EAAE;IACf,SAAS,EAAE,CAAC,EAAE;IACd,UAAU,EAAE,CAAC,EAAE;IACf,OAAO,EAAE,CAAC,EAAE;IACZ,YAAY,EAAE,CAAC,EAAE;IACjB,SAAS,EAAE,CAAC,EAAE;IAEd,UAAU,EAAE,CAAC;IAEb,QAAQ,EAAE,GAAG;IACb,eAAe,EAAE,GAAG;IACpB,eAAe,EAAE,GAAG;IACpB,iBAAiB,EAAE,GAAG;IACtB,mBAAmB,EAAE,GAAG;IACxB,oBAAoB,EAAE,GAAG;IACzB,WAAW,EAAE,GAAG;IAChB,qBAAqB,EAAE,GAAG;IAC1B,sBAAsB,EAAE,GAAG;IAC3B,SAAS,EAAE,GAAG;IACd,mBAAmB,EAAE,GAAG;IACxB,wBAAwB,EAAE,GAAG;IAC7B,oBAAoB,EAAE,GAAG;IACzB,WAAW,EAAE,GAAG;IAChB,WAAW,EAAE,GAAG;IAChB,qBAAqB,EAAE,GAAG;IAC1B,iBAAiB,EAAE,GAAG;IACtB,SAAS,EAAE,GAAG;IACd,YAAY,EAAE,GAAG;IACjB,UAAU,EAAE,GAAG;IACf,UAAU,EAAE,GAAG;IACf,aAAa,EAAE,GAAG;IAClB,SAAS,EAAE,GAAG;IACd,YAAY,EAAE,GAAG;IACjB,gBAAgB,EAAE,GAAG;IACrB,WAAW,EAAE,GAAG;IAChB,uBAAuB,EAAE,GAAG;IAC5B,kBAAkB,EAAE,GAAG;IACvB,iBAAiB,EAAE,GAAG;IACtB,WAAW,EAAE,GAAG;IAChB,WAAW,EAAE,GAAG;IAChB,wBAAwB,EAAE,GAAG;IAC7B,mBAAmB,EAAE,GAAG;IACxB,UAAU,EAAE,GAAG;IACf,YAAY,EAAE,GAAG;IACjB,SAAS,EAAE,GAAG;IACd,kBAAkB,EAAE,GAAG;IACvB,WAAW,EAAE,GAAG;CACjB,CAAA;AAED,IAAI,8BAA8B,GAAG,CAAC,GAAG,CAAA;AAEzC,IAAI,sBAAsB,GAAG,CAAC,GAAG,CAAA;AAEjC,IAAI,oBAAoB,GAAG,CAAC,EAAE,CAAA;AAE9B,MAAM,UAAU,GAAG,CAAC,CAAA;AAEpB,IAAI,oBAAoB,GAAG,GAAG,CAAA;AAE9B,MAAM,sBAAsB,GAAG,GAAG,CAAA;AAElC,IAAI,WAAW,GAAG,KAAK,CAAA;AACvB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;IACjC,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;QACvD,OAAO,CAAC,GAAG,EAAE,CAAA;QACb,WAAW,GAAG,GAAG,CAAA;KAClB;IACD,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE;QACjC,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,MAAM,8BAA8B,EAAE,GAAG,CAAC,CAAA;KAClE;SAAM,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE;QACxC,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,MAAM,sBAAsB,EAAE,GAAG,CAAC,CAAA;KAC1D;SAAM,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE;QACxC,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,MAAM,oBAAoB,EAAE,GAAG,CAAC,CAAA;KACxD;SAAM,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE;QACxC,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,MAAM,UAAU,GAAG,CAAC,CAAA;KAC5C;SAAM,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE;QACxC,IAAI,GAAG,KAAK,aAAa,EAAE;YACzB,oBAAoB,GAAG,sBAAsB,CAAA;SAC9C;QACD,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,MAAM,oBAAoB,EAAE,GAAG,CAAC,CAAA;KACxD;AACH,CAAC,CAAC,CAAA"}

package/dist/enums/xrpl-definitions-base.d.ts

@@ -0,0 +1,44 @@
+import { SerializedType } from '../types/serialized-type';
+import { Bytes, BytesLookup } from './bytes';
+import { FieldInfo, FieldLookup, FieldInstance } from './field';
+interface DefinitionsData {
+    TYPES: Record<string, number>;
+    LEDGER_ENTRY_TYPES: Record<string, number>;
+    FIELDS: (string | FieldInfo)[][];
+    TRANSACTION_RESULTS: Record<string, number>;
+    TRANSACTION_TYPES: Record<string, number>;
+}
+/**
+ * Stores the various types and fields for rippled to be used to encode/decode information later on.
+ * XrplDefinitions should be instantiated instead of this class.
+ */
+declare class XrplDefinitionsBase {
+    field: FieldLookup;
+    ledgerEntryType: BytesLookup;
+    type: BytesLookup;
+    transactionResult: BytesLookup;
+    transactionType: BytesLookup;
+    transactionNames: string[];
+    dataTypes: Record<string, typeof SerializedType>;
+    /**
+     * Present rippled types in a typed and updatable format.
+     * For an example of the input format see `definitions.json`
+     * To generate a new definitions file from rippled source code, use this tool: https://github.com/RichardAH/xrpl-codec-gen
+     *
+     * See the definitions.test.js file for examples of how to create your own updated definitions.json.
+     *
+     * @param enums - A json encoding of the core types, transaction types, transaction results, transaction names, and fields.
+     * @param types - A list of type objects with the same name as the fields defined.
+     *              You can use the coreTypes object if you are not adding new types.
+     */
+    constructor(enums: DefinitionsData, types: Record<string, typeof SerializedType>);
+    /**
+     * Associates each Field to a corresponding class that TypeScript can recognize.
+     *
+     * @param types a list of type objects with the same name as the fields defined.
+     *              Defaults to xrpl.js's core type definitions.
+     */
+    associateTypes(types: Record<string, typeof SerializedType>): void;
+    getAssociatedTypes(): Record<string, typeof SerializedType>;
+}
+export { DefinitionsData, XrplDefinitionsBase, FieldLookup, FieldInfo, FieldInstance, Bytes, BytesLookup, };

package/dist/enums/xrpl-definitions-base.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BytesLookup = exports.Bytes = exports.FieldLookup = exports.XrplDefinitionsBase = void 0;
+const bytes_1 = require("./bytes");
+Object.defineProperty(exports, "Bytes", { enumerable: true, get: function () { return bytes_1.Bytes; } });
+Object.defineProperty(exports, "BytesLookup", { enumerable: true, get: function () { return bytes_1.BytesLookup; } });
+const field_1 = require("./field");
+Object.defineProperty(exports, "FieldLookup", { enumerable: true, get: function () { return field_1.FieldLookup; } });
+const constants_1 = require("./constants");
+/**
+ * Stores the various types and fields for rippled to be used to encode/decode information later on.
+ * XrplDefinitions should be instantiated instead of this class.
+ */
+class XrplDefinitionsBase {
+    /**
+     * Present rippled types in a typed and updatable format.
+     * For an example of the input format see `definitions.json`
+     * To generate a new definitions file from rippled source code, use this tool: https://github.com/RichardAH/xrpl-codec-gen
+     *
+     * See the definitions.test.js file for examples of how to create your own updated definitions.json.
+     *
+     * @param enums - A json encoding of the core types, transaction types, transaction results, transaction names, and fields.
+     * @param types - A list of type objects with the same name as the fields defined.
+     *              You can use the coreTypes object if you are not adding new types.
+     */
+    constructor(enums, types) {
+        this.type = new bytes_1.BytesLookup(enums.TYPES, constants_1.TYPE_WIDTH);
+        this.ledgerEntryType = new bytes_1.BytesLookup(enums.LEDGER_ENTRY_TYPES, constants_1.LEDGER_ENTRY_WIDTH);
+        this.transactionType = new bytes_1.BytesLookup(enums.TRANSACTION_TYPES, constants_1.TRANSACTION_TYPE_WIDTH);
+        this.transactionResult = new bytes_1.BytesLookup(enums.TRANSACTION_RESULTS, constants_1.TRANSACTION_RESULT_WIDTH);
+        this.field = new field_1.FieldLookup(enums.FIELDS, enums.TYPES);
+        this.transactionNames = Object.entries(enums.TRANSACTION_TYPES)
+            .filter(([_key, value]) => value >= 0)
+            .map(([key, _value]) => key);
+        this.dataTypes = {}; // Filled in via associateTypes
+        this.associateTypes(types);
+    }
+    /**
+     * Associates each Field to a corresponding class that TypeScript can recognize.
+     *
+     * @param types a list of type objects with the same name as the fields defined.
+     *              Defaults to xrpl.js's core type definitions.
+     */
+    associateTypes(types) {
+        // Overwrite any existing type definitions with the given types
+        this.dataTypes = Object.assign({}, this.dataTypes, types);
+        Object.values(this.field).forEach((field) => {
+            field.associatedType = this.dataTypes[field.type.name];
+        });
+        this.field['TransactionType'].associatedType = this.transactionType;
+        this.field['TransactionResult'].associatedType = this.transactionResult;
+        this.field['LedgerEntryType'].associatedType = this.ledgerEntryType;
+    }
+    getAssociatedTypes() {
+        return this.dataTypes;
+    }
+}
+exports.XrplDefinitionsBase = XrplDefinitionsBase;
+//# sourceMappingURL=xrpl-definitions-base.js.map

package/dist/enums/xrpl-definitions-base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xrpl-definitions-base.js","sourceRoot":"","sources":["../../src/enums/xrpl-definitions-base.ts"],"names":[],"mappings":";;;AACA,mCAA4C;AA2G1C,sFA3GO,aAAK,OA2GP;AACL,4FA5Gc,mBAAW,OA4Gd;AA3Gb,mCAA+D;AAuG7D,4FAvGkB,mBAAW,OAuGlB;AAtGb,2CAKoB;AAUpB;;;GAGG;AACH,MAAM,mBAAmB;IAgBvB;;;;;;;;;;OAUG;IACH,YACE,KAAsB,EACtB,KAA4C;QAE5C,IAAI,CAAC,IAAI,GAAG,IAAI,mBAAW,CAAC,KAAK,CAAC,KAAK,EAAE,sBAAU,CAAC,CAAA;QACpD,IAAI,CAAC,eAAe,GAAG,IAAI,mBAAW,CACpC,KAAK,CAAC,kBAAkB,EACxB,8BAAkB,CACnB,CAAA;QACD,IAAI,CAAC,eAAe,GAAG,IAAI,mBAAW,CACpC,KAAK,CAAC,iBAAiB,EACvB,kCAAsB,CACvB,CAAA;QACD,IAAI,CAAC,iBAAiB,GAAG,IAAI,mBAAW,CACtC,KAAK,CAAC,mBAAmB,EACzB,oCAAwB,CACzB,CAAA;QACD,IAAI,CAAC,KAAK,GAAG,IAAI,mBAAW,CAC1B,KAAK,CAAC,MAAoC,EAC1C,KAAK,CAAC,KAAK,CACZ,CAAA;QACD,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC;aAC5D,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC;aACrC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAA;QAE9B,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA,CAAC,+BAA+B;QACnD,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;IAC5B,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,KAA4C;QAChE,+DAA+D;QAC/D,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QAEzD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC1C,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACxD,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,cAAc,GAAG,IAAI,CAAC,eAAe,CAAA;QACnE,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAA;QACvE,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,cAAc,GAAG,IAAI,CAAC,eAAe,CAAA;IACrE,CAAC;IAEM,kBAAkB;QACvB,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;CACF;AAIC,kDAAmB"}

package/dist/enums/xrpl-definitions.d.ts

@@ -0,0 +1,21 @@
+import { type DefinitionsData, XrplDefinitionsBase } from './xrpl-definitions-base';
+import { SerializedType } from '../types/serialized-type';
+/**
+ * Stores the various types and fields for rippled to be used to encode/decode information later on.
+ * Should be used instead of XrplDefinitionsBase since this defines default `types` for serializing/deserializing
+ * ledger data.
+ */
+export declare class XrplDefinitions extends XrplDefinitionsBase {
+    /**
+     * Present rippled types in a typed and updatable format.
+     * For an example of the input format see `definitions.json`
+     * To generate a new definitions file from rippled source code, use this tool: https://github.com/RichardAH/xrpl-codec-gen
+     *
+     * See the definitions.test.js file for examples of how to create your own updated definitions.json.
+     *
+     * @param enums - A json encoding of the core types, transaction types, transaction results, transaction names, and fields.
+     * @param additionalTypes - A list of SerializedType objects with the same name as the fields defined.
+     *              These types will be included in addition to the coreTypes used on mainnet.
+     */
+    constructor(enums: DefinitionsData, additionalTypes?: Record<string, typeof SerializedType>);
+}

package/dist/enums/xrpl-definitions.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XrplDefinitions = void 0;
+const xrpl_definitions_base_1 = require("./xrpl-definitions-base");
+const types_1 = require("../types");
+/**
+ * Stores the various types and fields for rippled to be used to encode/decode information later on.
+ * Should be used instead of XrplDefinitionsBase since this defines default `types` for serializing/deserializing
+ * ledger data.
+ */
+class XrplDefinitions extends xrpl_definitions_base_1.XrplDefinitionsBase {
+    /**
+     * Present rippled types in a typed and updatable format.
+     * For an example of the input format see `definitions.json`
+     * To generate a new definitions file from rippled source code, use this tool: https://github.com/RichardAH/xrpl-codec-gen
+     *
+     * See the definitions.test.js file for examples of how to create your own updated definitions.json.
+     *
+     * @param enums - A json encoding of the core types, transaction types, transaction results, transaction names, and fields.
+     * @param additionalTypes - A list of SerializedType objects with the same name as the fields defined.
+     *              These types will be included in addition to the coreTypes used on mainnet.
+     */
+    constructor(enums, additionalTypes) {
+        const types = Object.assign({}, types_1.coreTypes, additionalTypes);
+        super(enums, types);
+    }
+}
+exports.XrplDefinitions = XrplDefinitions;
+//# sourceMappingURL=xrpl-definitions.js.map

package/dist/enums/xrpl-definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xrpl-definitions.js","sourceRoot":"","sources":["../../src/enums/xrpl-definitions.ts"],"names":[],"mappings":";;;AAAA,mEAGgC;AAChC,oCAAoC;AAGpC;;;;GAIG;AACH,MAAa,eAAgB,SAAQ,2CAAmB;IACtD;;;;;;;;;;OAUG;IACH,YACE,KAAsB,EACtB,eAAuD;QAEvD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,iBAAS,EAAE,eAAe,CAAC,CAAA;QAC3D,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;IACrB,CAAC;CACF;AAnBD,0CAmBC"}

package/dist/hash-prefixes.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HashPrefix = void 0;
-var buffer_1 = require("buffer/");
+const buffer_1 = require("buffer/");
 /**
  * Write a 32 bit integer to a Buffer
  *
@@ -9,14 +9,14 @@ var buffer_1 = require("buffer/");
  * @returns a buffer with the bytes representation of uint32
  */
 function bytes(uint32) {
-    var result = buffer_1.Buffer.alloc(4);
+    const result = buffer_1.Buffer.alloc(4);
     result.writeUInt32BE(uint32, 0);
     return result;
 }
 /**
  * Maps HashPrefix names to their byte representation
  */
-var HashPrefix = {
+const HashPrefix = {
     transactionID: bytes(0x54584e00),
     // transaction plus metadata
     transaction: bytes(0x534e4400),

package/dist/hash-prefixes.js.map

@@ -1 +1 @@
-{"version":3,"file":"hash-prefixes.js","sourceRoot":"","sources":["../src/hash-prefixes.ts"],"names":[],"mappings":";;;AAAA,kCAAgC;AAEhC;;;;;GAKG;AACH,SAAS,KAAK,CAAC,MAAc;IAC3B,IAAM,MAAM,GAAG,eAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAC9B,MAAM,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IAC/B,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;GAEG;AACH,IAAM,UAAU,GAA2B;IACzC,aAAa,EAAE,KAAK,CAAC,UAAU,CAAC;IAChC,4BAA4B;IAC5B,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC;IAC9B,gBAAgB;IAChB,iBAAiB,EAAE,KAAK,CAAC,UAAU,CAAC;IACpC,qBAAqB;IACrB,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC;IAC5B,iCAAiC;IACjC,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC;IAC/B,4BAA4B;IAC5B,cAAc,EAAE,KAAK,CAAC,UAAU,CAAC;IACjC,4BAA4B;IAC5B,mBAAmB,EAAE,KAAK,CAAC,UAAU,CAAC;IACtC,yBAAyB;IACzB,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;IAC7B,uBAAuB;IACvB,QAAQ,EAAE,KAAK,CAAC,UAAU,CAAC;IAC3B,wBAAwB;IACxB,mBAAmB,EAAE,KAAK,CAAC,UAAU,CAAC;CACvC,CAAA;AAEQ,gCAAU"}
+{"version":3,"file":"hash-prefixes.js","sourceRoot":"","sources":["../src/hash-prefixes.ts"],"names":[],"mappings":";;;AAAA,oCAAgC;AAEhC;;;;;GAKG;AACH,SAAS,KAAK,CAAC,MAAc;IAC3B,MAAM,MAAM,GAAG,eAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAC9B,MAAM,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IAC/B,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,GAA2B;IACzC,aAAa,EAAE,KAAK,CAAC,UAAU,CAAC;IAChC,4BAA4B;IAC5B,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC;IAC9B,gBAAgB;IAChB,iBAAiB,EAAE,KAAK,CAAC,UAAU,CAAC;IACpC,qBAAqB;IACrB,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC;IAC5B,iCAAiC;IACjC,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC;IAC/B,4BAA4B;IAC5B,cAAc,EAAE,KAAK,CAAC,UAAU,CAAC;IACjC,4BAA4B;IAC5B,mBAAmB,EAAE,KAAK,CAAC,UAAU,CAAC;IACtC,yBAAyB;IACzB,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;IAC7B,uBAAuB;IACvB,QAAQ,EAAE,KAAK,CAAC,UAAU,CAAC;IAC3B,wBAAwB;IACxB,mBAAmB,EAAE,KAAK,CAAC,UAAU,CAAC;CACvC,CAAA;AAEQ,gCAAU"}

package/dist/hashes.js

@@ -1,36 +1,19 @@
 "use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transactionID = exports.sha512Half = exports.Sha512Half = void 0;
-var hash_prefixes_1 = require("./hash-prefixes");
-var createHash = require("create-hash");
-var hash_256_1 = require("./types/hash-256");
-var binary_serializer_1 = require("./serdes/binary-serializer");
-var buffer_1 = require("buffer/");
+const hash_prefixes_1 = require("./hash-prefixes");
+const createHash = require("create-hash");
+const hash_256_1 = require("./types/hash-256");
+const binary_serializer_1 = require("./serdes/binary-serializer");
+const buffer_1 = require("buffer/");
 /**
  * Class for hashing with SHA512
  * @extends BytesList So SerializedTypes can write bytes to a Sha512Half
  */
-var Sha512Half = /** @class */ (function (_super) {
-    __extends(Sha512Half, _super);
-    function Sha512Half() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.hash = createHash('sha512');
-        return _this;
+class Sha512Half extends binary_serializer_1.BytesList {
+    constructor() {
+        super(...arguments);
+        this.hash = createHash('sha512');
     }
     /**
      * Construct a new Sha512Hash and write bytes this.hash
@@ -38,37 +21,36 @@ var Sha512Half = /** @class */ (function (_super) {
      * @param bytes bytes to write to this.hash
      * @returns the new Sha512Hash object
      */
-    Sha512Half.put = function (bytes) {
+    static put(bytes) {
         return new Sha512Half().put(bytes);
-    };
+    }
     /**
      * Write bytes to an existing Sha512Hash
      *
      * @param bytes bytes to write to object
      * @returns the Sha512 object
      */
-    Sha512Half.prototype.put = function (bytes) {
+    put(bytes) {
         this.hash.update(bytes);
         return this;
-    };
+    }
     /**
      * Compute SHA512 hash and slice in half
      *
      * @returns half of a SHA512 hash
      */
-    Sha512Half.prototype.finish256 = function () {
+    finish256() {
         return buffer_1.Buffer.from(this.hash.digest().slice(0, 32));
-    };
+    }
     /**
      * Constructs a Hash256 from the Sha512Half object
      *
      * @returns a Hash256 object
      */
-    Sha512Half.prototype.finish = function () {
+    finish() {
         return new hash_256_1.Hash256(this.finish256());
-    };
-    return Sha512Half;
-}(binary_serializer_1.BytesList));
+    }
+}
 exports.Sha512Half = Sha512Half;
 /**
  * compute SHA512 hash of a list of bytes
@@ -76,13 +58,9 @@ exports.Sha512Half = Sha512Half;
  * @param args zero or more arguments to hash
  * @returns the sha512half hash of the arguments.
  */
-function sha512Half() {
-    var args = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        args[_i] = arguments[_i];
-    }
-    var hash = new Sha512Half();
-    args.forEach(function (a) { return hash.put(a); });
+function sha512Half(...args) {
+    const hash = new Sha512Half();
+    args.forEach((a) => hash.put(a));
     return hash.finish256();
 }
 exports.sha512Half = sha512Half;

package/dist/hashes.js.map

@@ -1 +1 @@
-{"version":3,"file":"hashes.js","sourceRoot":"","sources":["../src/hashes.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,iDAA4C;AAC5C,wCAAyC;AACzC,6CAA0C;AAC1C,gEAAsD;AACtD,kCAAgC;AAEhC;;;GAGG;AACH;IAAyB,8BAAS;IAAlC;QAAA,qEAyCC;QAxCS,UAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAA;;IAwCrC,CAAC;IAtCC;;;;;OAKG;IACI,cAAG,GAAV,UAAW,KAAa;QACtB,OAAO,IAAI,UAAU,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACpC,CAAC;IAED;;;;;OAKG;IACH,wBAAG,GAAH,UAAI,KAAa;QACf,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QACvB,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;OAIG;IACH,8BAAS,GAAT;QACE,OAAO,eAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;IACrD,CAAC;IAED;;;;OAIG;IACH,2BAAM,GAAN;QACE,OAAO,IAAI,kBAAO,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;IACtC,CAAC;IACH,iBAAC;AAAD,CAAC,AAzCD,CAAyB,6BAAS,GAyCjC;AAwBQ,gCAAU;AAtBnB;;;;;GAKG;AACH,SAAS,UAAU;IAAC,cAAiB;SAAjB,UAAiB,EAAjB,qBAAiB,EAAjB,IAAiB;QAAjB,yBAAiB;;IACnC,IAAM,IAAI,GAAG,IAAI,UAAU,EAAE,CAAA;IAC7B,IAAI,CAAC,OAAO,CAAC,UAAC,CAAC,IAAK,OAAA,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAX,CAAW,CAAC,CAAA;IAChC,OAAO,IAAI,CAAC,SAAS,EAAE,CAAA;AACzB,CAAC;AAYoB,gCAAU;AAV/B;;;;;GAKG;AACH,SAAS,aAAa,CAAC,UAAkB;IACvC,OAAO,IAAI,kBAAO,CAAC,UAAU,CAAC,0BAAU,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,CAAA;AACtE,CAAC;AAEgC,sCAAa"}
+{"version":3,"file":"hashes.js","sourceRoot":"","sources":["../src/hashes.ts"],"names":[],"mappings":";;;AAAA,mDAA4C;AAC5C,0CAA0C;AAC1C,+CAA0C;AAC1C,kEAAsD;AACtD,oCAAgC;AAEhC;;;GAGG;AACH,MAAM,UAAW,SAAQ,6BAAS;IAAlC;;QACU,SAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAA;IAwCrC,CAAC;IAtCC;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,KAAa;QACtB,OAAO,IAAI,UAAU,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACpC,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,KAAa;QACf,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QACvB,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;OAIG;IACH,SAAS;QACP,OAAO,eAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;IACrD,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO,IAAI,kBAAO,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;IACtC,CAAC;CACF;AAwBQ,gCAAU;AAtBnB;;;;;GAKG;AACH,SAAS,UAAU,CAAC,GAAG,IAAc;IACnC,MAAM,IAAI,GAAG,IAAI,UAAU,EAAE,CAAA;IAC7B,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IAChC,OAAO,IAAI,CAAC,SAAS,EAAE,CAAA;AACzB,CAAC;AAYoB,gCAAU;AAV/B;;;;;GAKG;AACH,SAAS,aAAa,CAAC,UAAkB;IACvC,OAAO,IAAI,kBAAO,CAAC,UAAU,CAAC,0BAAU,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,CAAA;AACtE,CAAC;AAEgC,sCAAa"}

package/dist/index.d.ts

@@ -1,32 +1,40 @@
 import { decodeLedgerData } from './ledger-hashes';
 import { JsonObject } from './types/serialized-type';
+import { XrplDefinitionsBase, TRANSACTION_TYPES, DEFAULT_DEFINITIONS } from './enums';
+import { XrplDefinitions } from './enums/xrpl-definitions';
+import { coreTypes } from './types';
 /**
  * Decode a transaction
  *
  * @param binary hex-string of the encoded transaction
+ * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
  * @returns the JSON representation of the transaction
  */
-declare function decode(binary: string): JsonObject;
+declare function decode(binary: string, definitions?: XrplDefinitionsBase): JsonObject;
 /**
  * Encode a transaction
  *
  * @param json The JSON representation of a transaction
+ * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
+ *
  * @returns A hex-string of the encoded transaction
  */
-declare function encode(json: object): string;
+declare function encode(json: object, definitions?: XrplDefinitionsBase): string;
 /**
  * Encode a transaction and prepare for signing
  *
  * @param json JSON object representing the transaction
  * @param signer string representing the account to sign the transaction with
+ * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
  * @returns a hex string of the encoded transaction
  */
-declare function encodeForSigning(json: object): string;
+declare function encodeForSigning(json: object, definitions?: XrplDefinitionsBase): string;
 /**
  * Encode a transaction and prepare for signing with a claim
  *
  * @param json JSON object representing the transaction
  * @param signer string representing the account to sign the transaction with
+ * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
  * @returns a hex string of the encoded transaction
  */
 declare function encodeForSigningClaim(json: object): string;
@@ -35,9 +43,10 @@ declare function encodeForSigningClaim(json: object): string;
  *
  * @param json JSON object representing the transaction
  * @param signer string representing the account to sign the transaction with
+ * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
  * @returns a hex string of the encoded transaction
  */
-declare function encodeForMultisigning(json: object, signer: string): string;
+declare function encodeForMultisigning(json: object, signer: string, definitions?: XrplDefinitionsBase): string;
 /**
  * Encode a quality value
  *
@@ -52,15 +61,4 @@ declare function encodeQuality(value: string): string;
  * @returns a string representing the quality
  */
 declare function decodeQuality(value: string): string;
-declare const _default: {
-    decode: typeof decode;
-    encode: typeof encode;
-    encodeForSigning: typeof encodeForSigning;
-    encodeForSigningClaim: typeof encodeForSigningClaim;
-    encodeForMultisigning: typeof encodeForMultisigning;
-    encodeQuality: typeof encodeQuality;
-    decodeQuality: typeof decodeQuality;
-    decodeLedgerData: typeof decodeLedgerData;
-    TRANSACTION_TYPES: string[];
-};
-export = _default;
+export { decode, encode, encodeForSigning, encodeForSigningClaim, encodeForMultisigning, encodeQuality, decodeQuality, decodeLedgerData, TRANSACTION_TYPES, XrplDefinitions, XrplDefinitionsBase, DEFAULT_DEFINITIONS, coreTypes, };

package/dist/index.js

@@ -1,49 +1,92 @@
 "use strict";
-var assert = require("assert");
-var coretypes_1 = require("./coretypes");
-var ledger_hashes_1 = require("./ledger-hashes");
-var enums_1 = require("./enums");
-var signingData = coretypes_1.binary.signingData, signingClaimData = coretypes_1.binary.signingClaimData, multiSigningData = coretypes_1.binary.multiSigningData, binaryToJSON = coretypes_1.binary.binaryToJSON, serializeObject = coretypes_1.binary.serializeObject;
+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.coreTypes = exports.DEFAULT_DEFINITIONS = exports.XrplDefinitionsBase = exports.XrplDefinitions = exports.TRANSACTION_TYPES = exports.decodeLedgerData = exports.decodeQuality = exports.encodeQuality = exports.encodeForMultisigning = exports.encodeForSigningClaim = exports.encodeForSigning = exports.encode = exports.decode = void 0;
+const assert = __importStar(require("assert"));
+const coretypes_1 = require("./coretypes");
+const ledger_hashes_1 = require("./ledger-hashes");
+Object.defineProperty(exports, "decodeLedgerData", { enumerable: true, get: function () { return ledger_hashes_1.decodeLedgerData; } });
+const enums_1 = require("./enums");
+Object.defineProperty(exports, "XrplDefinitionsBase", { enumerable: true, get: function () { return enums_1.XrplDefinitionsBase; } });
+Object.defineProperty(exports, "TRANSACTION_TYPES", { enumerable: true, get: function () { return enums_1.TRANSACTION_TYPES; } });
+Object.defineProperty(exports, "DEFAULT_DEFINITIONS", { enumerable: true, get: function () { return enums_1.DEFAULT_DEFINITIONS; } });
+const xrpl_definitions_1 = require("./enums/xrpl-definitions");
+Object.defineProperty(exports, "XrplDefinitions", { enumerable: true, get: function () { return xrpl_definitions_1.XrplDefinitions; } });
+const types_1 = require("./types");
+Object.defineProperty(exports, "coreTypes", { enumerable: true, get: function () { return types_1.coreTypes; } });
+const { signingData, signingClaimData, multiSigningData, binaryToJSON, serializeObject, } = coretypes_1.binary;
 /**
  * Decode a transaction
  *
  * @param binary hex-string of the encoded transaction
+ * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
  * @returns the JSON representation of the transaction
  */
-function decode(binary) {
+function decode(binary, definitions) {
     assert.ok(typeof binary === 'string', 'binary must be a hex string');
-    return binaryToJSON(binary);
+    return binaryToJSON(binary, definitions);
 }
+exports.decode = decode;
 /**
  * Encode a transaction
  *
  * @param json The JSON representation of a transaction
+ * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
+ *
  * @returns A hex-string of the encoded transaction
  */
-function encode(json) {
+function encode(json, definitions) {
     assert.ok(typeof json === 'object');
-    return serializeObject(json)
+    return serializeObject(json, { definitions })
         .toString('hex')
         .toUpperCase();
 }
+exports.encode = encode;
 /**
  * Encode a transaction and prepare for signing
  *
  * @param json JSON object representing the transaction
  * @param signer string representing the account to sign the transaction with
+ * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
  * @returns a hex string of the encoded transaction
  */
-function encodeForSigning(json) {
+function encodeForSigning(json, definitions) {
     assert.ok(typeof json === 'object');
-    return signingData(json)
+    return signingData(json, coretypes_1.HashPrefix.transactionSig, {
+        definitions,
+    })
         .toString('hex')
         .toUpperCase();
 }
+exports.encodeForSigning = encodeForSigning;
 /**
  * Encode a transaction and prepare for signing with a claim
  *
  * @param json JSON object representing the transaction
  * @param signer string representing the account to sign the transaction with
+ * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
  * @returns a hex string of the encoded transaction
  */
 function encodeForSigningClaim(json) {
@@ -52,20 +95,24 @@ function encodeForSigningClaim(json) {
         .toString('hex')
         .toUpperCase();
 }
+exports.encodeForSigningClaim = encodeForSigningClaim;
 /**
  * Encode a transaction and prepare for multi-signing
  *
  * @param json JSON object representing the transaction
  * @param signer string representing the account to sign the transaction with
+ * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
  * @returns a hex string of the encoded transaction
  */
-function encodeForMultisigning(json, signer) {
+function encodeForMultisigning(json, signer, definitions) {
     assert.ok(typeof json === 'object');
     assert.equal(json['SigningPubKey'], '');
-    return multiSigningData(json, signer)
+    const definitionsOpt = definitions ? { definitions } : undefined;
+    return multiSigningData(json, signer, definitionsOpt)
         .toString('hex')
         .toUpperCase();
 }
+exports.encodeForMultisigning = encodeForMultisigning;
 /**
  * Encode a quality value
  *
@@ -76,6 +123,7 @@ function encodeQuality(value) {
     assert.ok(typeof value === 'string');
     return coretypes_1.quality.encode(value).toString('hex').toUpperCase();
 }
+exports.encodeQuality = encodeQuality;
 /**
  * Decode a quality value
  *
@@ -86,15 +134,5 @@ function decodeQuality(value) {
     assert.ok(typeof value === 'string');
     return coretypes_1.quality.decode(value).toString();
 }
-module.exports = {
-    decode: decode,
-    encode: encode,
-    encodeForSigning: encodeForSigning,
-    encodeForSigningClaim: encodeForSigningClaim,
-    encodeForMultisigning: encodeForMultisigning,
-    encodeQuality: encodeQuality,
-    decodeQuality: decodeQuality,
-    decodeLedgerData: ledger_hashes_1.decodeLedgerData,
-    TRANSACTION_TYPES: enums_1.TRANSACTION_TYPES,
-};
+exports.decodeQuality = decodeQuality;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,+BAAgC;AAChC,yCAA6C;AAC7C,iDAAkD;AAGlD,iCAA2C;AAGzC,IAAA,WAAW,GAKT,kBAAM,YALG,EACX,gBAAgB,GAId,kBAAM,iBAJQ,EAChB,gBAAgB,GAGd,kBAAM,iBAHQ,EAChB,YAAY,GAEV,kBAAM,aAFI,EACZ,eAAe,GACb,kBAAM,gBADO,CACP;AAEV;;;;;GAKG;AACH,SAAS,MAAM,CAAC,MAAc;IAC5B,MAAM,CAAC,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,EAAE,6BAA6B,CAAC,CAAA;IACpE,OAAO,YAAY,CAAC,MAAM,CAAC,CAAA;AAC7B,CAAC;AAED;;;;;GAKG;AACH,SAAS,MAAM,CAAC,IAAY;IAC1B,MAAM,CAAC,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAA;IACnC,OAAO,eAAe,CAAC,IAAkB,CAAC;SACvC,QAAQ,CAAC,KAAK,CAAC;SACf,WAAW,EAAE,CAAA;AAClB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,IAAY;IACpC,MAAM,CAAC,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAA;IACnC,OAAO,WAAW,CAAC,IAAkB,CAAC;SACnC,QAAQ,CAAC,KAAK,CAAC;SACf,WAAW,EAAE,CAAA;AAClB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,qBAAqB,CAAC,IAAY;IACzC,MAAM,CAAC,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAA;IACnC,OAAO,gBAAgB,CAAC,IAAmB,CAAC;SACzC,QAAQ,CAAC,KAAK,CAAC;SACf,WAAW,EAAE,CAAA;AAClB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,qBAAqB,CAAC,IAAY,EAAE,MAAc;IACzD,MAAM,CAAC,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAA;IACnC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,EAAE,CAAC,CAAA;IACvC,OAAO,gBAAgB,CAAC,IAAkB,EAAE,MAAM,CAAC;SAChD,QAAQ,CAAC,KAAK,CAAC;SACf,WAAW,EAAE,CAAA;AAClB,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,KAAa;IAClC,MAAM,CAAC,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAA;IACpC,OAAO,mBAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAA;AAC5D,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,KAAa;IAClC,MAAM,CAAC,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAA;IACpC,OAAO,mBAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAA;AACzC,CAAC;AAED,iBAAS;IACP,MAAM,QAAA;IACN,MAAM,QAAA;IACN,gBAAgB,kBAAA;IAChB,qBAAqB,uBAAA;IACrB,qBAAqB,uBAAA;IACrB,aAAa,eAAA;IACb,aAAa,eAAA;IACb,gBAAgB,kCAAA;IAChB,iBAAiB,2BAAA;CAClB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAgC;AAChC,2CAAyD;AACzD,mDAAkD;AAoIhD,iGApIO,gCAAgB,OAoIP;AAjIlB,mCAIgB;AAgId,oGAnIA,2BAAmB,OAmIA;AAFnB,kGAhIA,yBAAiB,OAgIA;AAGjB,oGAlIA,2BAAmB,OAkIA;AAhIrB,+DAA0D;AA8HxD,gGA9HO,kCAAe,OA8HP;AA7HjB,mCAAmC;AAgIjC,0FAhIO,iBAAS,OAgIP;AA9HX,MAAM,EACJ,WAAW,EACX,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,EACZ,eAAe,GAChB,GAAG,kBAAM,CAAA;AAEV;;;;;;GAMG;AACH,SAAS,MAAM,CAAC,MAAc,EAAE,WAAiC;IAC/D,MAAM,CAAC,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,EAAE,6BAA6B,CAAC,CAAA;IACpE,OAAO,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAC1C,CAAC;AAgGC,wBAAM;AA9FR;;;;;;;GAOG;AACH,SAAS,MAAM,CAAC,IAAY,EAAE,WAAiC;IAC7D,MAAM,CAAC,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAA;IACnC,OAAO,eAAe,CAAC,IAAkB,EAAE,EAAE,WAAW,EAAE,CAAC;SACxD,QAAQ,CAAC,KAAK,CAAC;SACf,WAAW,EAAE,CAAA;AAClB,CAAC;AAkFC,wBAAM;AAhFR;;;;;;;GAOG;AACH,SAAS,gBAAgB,CACvB,IAAY,EACZ,WAAiC;IAEjC,MAAM,CAAC,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAA;IACnC,OAAO,WAAW,CAAC,IAAkB,EAAE,sBAAU,CAAC,cAAc,EAAE;QAChE,WAAW;KACZ,CAAC;SACC,QAAQ,CAAC,KAAK,CAAC;SACf,WAAW,EAAE,CAAA;AAClB,CAAC;AA+DC,4CAAgB;AA7DlB;;;;;;;GAOG;AACH,SAAS,qBAAqB,CAAC,IAAY;IACzC,MAAM,CAAC,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAA;IACnC,OAAO,gBAAgB,CAAC,IAAmB,CAAC;SACzC,QAAQ,CAAC,KAAK,CAAC;SACf,WAAW,EAAE,CAAA;AAClB,CAAC;AAiDC,sDAAqB;AA/CvB;;;;;;;GAOG;AACH,SAAS,qBAAqB,CAC5B,IAAY,EACZ,MAAc,EACd,WAAiC;IAEjC,MAAM,CAAC,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAA;IACnC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,EAAE,CAAC,CAAA;IACvC,MAAM,cAAc,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;IAChE,OAAO,gBAAgB,CAAC,IAAkB,EAAE,MAAM,EAAE,cAAc,CAAC;SAChE,QAAQ,CAAC,KAAK,CAAC;SACf,WAAW,EAAE,CAAA;AAClB,CAAC;AA6BC,sDAAqB;AA3BvB;;;;;GAKG;AACH,SAAS,aAAa,CAAC,KAAa;IAClC,MAAM,CAAC,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAA;IACpC,OAAO,mBAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAA;AAC5D,CAAC;AAmBC,sCAAa;AAjBf;;;;;GAKG;AACH,SAAS,aAAa,CAAC,KAAa;IAClC,MAAM,CAAC,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAA;IACpC,OAAO,mBAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAA;AACzC,CAAC;AASC,sCAAa"}