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

package/dist/enums/utils-renumber.d.ts

@@ -0,0 +1,101 @@
+/**
+ * Quick script to re-number values
+ */
+declare const input: {
+    temBAD_SEND_XRP_PATHS: number;
+    temBAD_SEQUENCE: number;
+    temBAD_SIGNATURE: number;
+    temBAD_SRC_ACCOUNT: number;
+    temBAD_TRANSFER_RATE: number;
+    temDST_IS_SRC: number;
+    temDST_NEEDED: number;
+    temINVALID: number;
+    temINVALID_FLAG: number;
+    temREDUNDANT: number;
+    temRIPPLE_EMPTY: number;
+    temDISABLED: number;
+    temBAD_SIGNER: number;
+    temBAD_QUORUM: number;
+    temBAD_WEIGHT: number;
+    temBAD_TICK_SIZE: number;
+    temINVALID_ACCOUNT_ID: number;
+    temCANNOT_PREAUTH_SELF: number;
+    temUNCERTAIN: number;
+    temUNKNOWN: number;
+    tefFAILURE: number;
+    tefALREADY: number;
+    tefBAD_ADD_AUTH: number;
+    tefBAD_AUTH: number;
+    tefBAD_LEDGER: number;
+    tefCREATED: number;
+    tefEXCEPTION: number;
+    tefINTERNAL: number;
+    tefNO_AUTH_REQUIRED: number;
+    tefPAST_SEQ: number;
+    tefWRONG_PRIOR: number;
+    tefMASTER_DISABLED: number;
+    tefMAX_LEDGER: number;
+    tefBAD_SIGNATURE: number;
+    tefBAD_QUORUM: number;
+    tefNOT_MULTI_SIGNING: number;
+    tefBAD_AUTH_MASTER: number;
+    tefINVARIANT_FAILED: number;
+    tefTOO_BIG: number;
+    terRETRY: number;
+    terFUNDS_SPENT: number;
+    terINSUF_FEE_B: number;
+    terNO_ACCOUNT: number;
+    terNO_AUTH: number;
+    terNO_LINE: number;
+    terOWNERS: number;
+    terPRE_SEQ: number;
+    terLAST: number;
+    terNO_RIPPLE: number;
+    terQUEUED: number;
+    tesSUCCESS: number;
+    tecCLAIM: number;
+    tecPATH_PARTIAL: number;
+    tecUNFUNDED_ADD: number;
+    tecUNFUNDED_OFFER: number;
+    tecUNFUNDED_PAYMENT: number;
+    tecFAILED_PROCESSING: number;
+    tecDIR_FULL: number;
+    tecINSUF_RESERVE_LINE: number;
+    tecINSUF_RESERVE_OFFER: number;
+    tecNO_DST: number;
+    tecNO_DST_INSUF_XRP: number;
+    tecNO_LINE_INSUF_RESERVE: number;
+    tecNO_LINE_REDUNDANT: number;
+    tecPATH_DRY: number;
+    tecUNFUNDED: number;
+    tecNO_ALTERNATIVE_KEY: number;
+    tecNO_REGULAR_KEY: number;
+    tecOWNERS: number;
+    tecNO_ISSUER: number;
+    tecNO_AUTH: number;
+    tecNO_LINE: number;
+    tecINSUFF_FEE: number;
+    tecFROZEN: number;
+    tecNO_TARGET: number;
+    tecNO_PERMISSION: number;
+    tecNO_ENTRY: number;
+    tecINSUFFICIENT_RESERVE: number;
+    tecNEED_MASTER_KEY: number;
+    tecDST_TAG_NEEDED: number;
+    tecINTERNAL: number;
+    tecOVERSIZE: number;
+    tecCRYPTOCONDITION_ERROR: number;
+    tecINVARIANT_FAILED: number;
+    tecEXPIRED: number;
+    tecDUPLICATE: number;
+    tecKILLED: number;
+    tecHAS_OBLIGATIONS: number;
+    tecTOO_SOON: number;
+};
+declare let startingFromTemBADSENDXRPPATHS: number;
+declare let startingFromTefFAILURE: number;
+declare let startingFromTerRETRY: number;
+declare const tesSUCCESS = 0;
+declare let startingFromTecCLAIM: number;
+declare const startingFromTecDIRFULL = 121;
+declare let previousKey: string;

package/dist/enums/utils-renumber.js

@@ -0,0 +1,127 @@
+"use strict";
+/**
+ * Quick script to re-number values
+ */
+const input = {
+    temBAD_SEND_XRP_PATHS: -283,
+    temBAD_SEQUENCE: -282,
+    temBAD_SIGNATURE: -281,
+    temBAD_SRC_ACCOUNT: -280,
+    temBAD_TRANSFER_RATE: -279,
+    temDST_IS_SRC: -278,
+    temDST_NEEDED: -277,
+    temINVALID: -276,
+    temINVALID_FLAG: -275,
+    temREDUNDANT: -274,
+    temRIPPLE_EMPTY: -273,
+    temDISABLED: -272,
+    temBAD_SIGNER: -271,
+    temBAD_QUORUM: -270,
+    temBAD_WEIGHT: -269,
+    temBAD_TICK_SIZE: -268,
+    temINVALID_ACCOUNT_ID: -267,
+    temCANNOT_PREAUTH_SELF: -266,
+    temUNCERTAIN: -265,
+    temUNKNOWN: -264,
+    tefFAILURE: -199,
+    tefALREADY: -198,
+    tefBAD_ADD_AUTH: -197,
+    tefBAD_AUTH: -196,
+    tefBAD_LEDGER: -195,
+    tefCREATED: -194,
+    tefEXCEPTION: -193,
+    tefINTERNAL: -192,
+    tefNO_AUTH_REQUIRED: -191,
+    tefPAST_SEQ: -190,
+    tefWRONG_PRIOR: -189,
+    tefMASTER_DISABLED: -188,
+    tefMAX_LEDGER: -187,
+    tefBAD_SIGNATURE: -186,
+    tefBAD_QUORUM: -185,
+    tefNOT_MULTI_SIGNING: -184,
+    tefBAD_AUTH_MASTER: -183,
+    tefINVARIANT_FAILED: -182,
+    tefTOO_BIG: -181,
+    terRETRY: -99,
+    terFUNDS_SPENT: -98,
+    terINSUF_FEE_B: -97,
+    terNO_ACCOUNT: -96,
+    terNO_AUTH: -95,
+    terNO_LINE: -94,
+    terOWNERS: -93,
+    terPRE_SEQ: -92,
+    terLAST: -91,
+    terNO_RIPPLE: -90,
+    terQUEUED: -89,
+    tesSUCCESS: 0,
+    tecCLAIM: 100,
+    tecPATH_PARTIAL: 101,
+    tecUNFUNDED_ADD: 102,
+    tecUNFUNDED_OFFER: 103,
+    tecUNFUNDED_PAYMENT: 104,
+    tecFAILED_PROCESSING: 105,
+    tecDIR_FULL: 121,
+    tecINSUF_RESERVE_LINE: 122,
+    tecINSUF_RESERVE_OFFER: 123,
+    tecNO_DST: 124,
+    tecNO_DST_INSUF_XRP: 125,
+    tecNO_LINE_INSUF_RESERVE: 126,
+    tecNO_LINE_REDUNDANT: 127,
+    tecPATH_DRY: 128,
+    tecUNFUNDED: 129,
+    tecNO_ALTERNATIVE_KEY: 130,
+    tecNO_REGULAR_KEY: 131,
+    tecOWNERS: 132,
+    tecNO_ISSUER: 133,
+    tecNO_AUTH: 134,
+    tecNO_LINE: 135,
+    tecINSUFF_FEE: 136,
+    tecFROZEN: 137,
+    tecNO_TARGET: 138,
+    tecNO_PERMISSION: 139,
+    tecNO_ENTRY: 140,
+    tecINSUFFICIENT_RESERVE: 141,
+    tecNEED_MASTER_KEY: 142,
+    tecDST_TAG_NEEDED: 143,
+    tecINTERNAL: 144,
+    tecOVERSIZE: 145,
+    tecCRYPTOCONDITION_ERROR: 146,
+    tecINVARIANT_FAILED: 147,
+    tecEXPIRED: 148,
+    tecDUPLICATE: 149,
+    tecKILLED: 150,
+    tecHAS_OBLIGATIONS: 151,
+    tecTOO_SOON: 152,
+};
+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(`    "${key}": ${startingFromTemBADSENDXRPPATHS++},`);
+    }
+    else if (key.substring(0, 3) === 'tef') {
+        console.log(`    "${key}": ${startingFromTefFAILURE++},`);
+    }
+    else if (key.substring(0, 3) === 'ter') {
+        console.log(`    "${key}": ${startingFromTerRETRY++},`);
+    }
+    else if (key.substring(0, 3) === 'tes') {
+        console.log(`    "${key}": ${tesSUCCESS},`);
+    }
+    else if (key.substring(0, 3) === 'tec') {
+        if (key === 'tecDIR_FULL') {
+            startingFromTecCLAIM = startingFromTecDIRFULL;
+        }
+        console.log(`    "${key}": ${startingFromTecCLAIM++},`);
+    }
+});
+//# sourceMappingURL=utils-renumber.js.map

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

@@ -0,0 +1 @@
+{"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,45 @@
+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[];
+    transactionMap: Record<string, number>;
+    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,63 @@
+"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);
+        const ignoreList = ['EnableAmendment', 'SetFee', 'UNLModify', 'EmitFailure'];
+        this.transactionMap = Object.assign({}, ...Object.entries(enums.TRANSACTION_TYPES)
+            .filter(([_key, _value]) => _value >= 0 || ignoreList.includes(_key))
+            .map(([key, value]) => ({ [key]: value })));
+        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;AAuH1C,sFAvHO,aAAK,OAuHP;AACL,4FAxHc,mBAAW,OAwHd;AAvHb,mCAA+D;AAmH7D,4FAnHkB,mBAAW,OAmHlB;AAlHb,2CAKoB;AAUpB;;;GAGG;AACH,MAAM,mBAAmB;IAkBvB;;;;;;;;;;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;QAED,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,MAAM,UAAU,GAAG,CAAC,iBAAiB,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,CAAC,CAAA;QAC5E,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,MAAM,CACjC,EAAE,EACF,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC;aAEvC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,IAAI,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;aACpE,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAC7C,CAAA;QAED,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.d.ts

@@ -0,0 +1,6 @@
+import { Buffer } from 'buffer/';
+/**
+ * Maps HashPrefix names to their byte representation
+ */
+declare const HashPrefix: Record<string, Buffer>;
+export { HashPrefix };

package/dist/hash-prefixes.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HashPrefix = void 0;
+const buffer_1 = require("buffer/");
+/**
+ * Write a 32 bit integer to a Buffer
+ *
+ * @param uint32 32 bit integer to write to buffer
+ * @returns a buffer with the bytes representation of uint32
+ */
+function bytes(uint32) {
+    const result = buffer_1.Buffer.alloc(4);
+    result.writeUInt32BE(uint32, 0);
+    return result;
+}
+/**
+ * Maps HashPrefix names to their byte representation
+ */
+const HashPrefix = {
+    transactionID: bytes(0x54584e00),
+    // transaction plus metadata
+    transaction: bytes(0x534e4400),
+    // account state
+    accountStateEntry: bytes(0x4d4c4e00),
+    // inner node in tree
+    innerNode: bytes(0x4d494e00),
+    // ledger master data for signing
+    ledgerHeader: bytes(0x4c575200),
+    // inner transaction to sign
+    transactionSig: bytes(0x53545800),
+    // inner transaction to sign
+    transactionMultiSig: bytes(0x534d5400),
+    // validation for signing
+    validation: bytes(0x56414c00),
+    // proposal for signing
+    proposal: bytes(0x50525000),
+    // payment channel claim
+    paymentChannelClaim: bytes(0x434c4d00),
+};
+exports.HashPrefix = HashPrefix;
+//# sourceMappingURL=hash-prefixes.js.map

package/dist/hash-prefixes.js.map

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

@@ -0,0 +1,51 @@
+import { Hash256 } from './types/hash-256';
+import { BytesList } from './serdes/binary-serializer';
+import { Buffer } from 'buffer/';
+/**
+ * Class for hashing with SHA512
+ * @extends BytesList So SerializedTypes can write bytes to a Sha512Half
+ */
+declare class Sha512Half extends BytesList {
+    private hash;
+    /**
+     * Construct a new Sha512Hash and write bytes this.hash
+     *
+     * @param bytes bytes to write to this.hash
+     * @returns the new Sha512Hash object
+     */
+    static put(bytes: Buffer): Sha512Half;
+    /**
+     * Write bytes to an existing Sha512Hash
+     *
+     * @param bytes bytes to write to object
+     * @returns the Sha512 object
+     */
+    put(bytes: Buffer): Sha512Half;
+    /**
+     * Compute SHA512 hash and slice in half
+     *
+     * @returns half of a SHA512 hash
+     */
+    finish256(): Buffer;
+    /**
+     * Constructs a Hash256 from the Sha512Half object
+     *
+     * @returns a Hash256 object
+     */
+    finish(): Hash256;
+}
+/**
+ * compute SHA512 hash of a list of bytes
+ *
+ * @param args zero or more arguments to hash
+ * @returns the sha512half hash of the arguments.
+ */
+declare function sha512Half(...args: Buffer[]): Buffer;
+/**
+ * Construct a transactionID from a Serialized Transaction
+ *
+ * @param serialized bytes to hash
+ * @returns a Hash256 object
+ */
+declare function transactionID(serialized: Buffer): Hash256;
+export { Sha512Half, sha512Half, transactionID };

package/dist/hashes.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transactionID = exports.sha512Half = exports.Sha512Half = void 0;
+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
+ */
+class Sha512Half extends binary_serializer_1.BytesList {
+    constructor() {
+        super(...arguments);
+        this.hash = createHash('sha512');
+    }
+    /**
+     * Construct a new Sha512Hash and write bytes this.hash
+     *
+     * @param bytes bytes to write to this.hash
+     * @returns the new Sha512Hash object
+     */
+    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
+     */
+    put(bytes) {
+        this.hash.update(bytes);
+        return this;
+    }
+    /**
+     * Compute SHA512 hash and slice in half
+     *
+     * @returns half of a SHA512 hash
+     */
+    finish256() {
+        return buffer_1.Buffer.from(this.hash.digest().slice(0, 32));
+    }
+    /**
+     * Constructs a Hash256 from the Sha512Half object
+     *
+     * @returns a Hash256 object
+     */
+    finish() {
+        return new hash_256_1.Hash256(this.finish256());
+    }
+}
+exports.Sha512Half = Sha512Half;
+/**
+ * compute SHA512 hash of a list of bytes
+ *
+ * @param args zero or more arguments to hash
+ * @returns the sha512half hash of the arguments.
+ */
+function sha512Half(...args) {
+    const hash = new Sha512Half();
+    args.forEach((a) => hash.put(a));
+    return hash.finish256();
+}
+exports.sha512Half = sha512Half;
+/**
+ * Construct a transactionID from a Serialized Transaction
+ *
+ * @param serialized bytes to hash
+ * @returns a Hash256 object
+ */
+function transactionID(serialized) {
+    return new hash_256_1.Hash256(sha512Half(hash_prefixes_1.HashPrefix.transactionID, serialized));
+}
+exports.transactionID = transactionID;
+//# sourceMappingURL=hashes.js.map

package/dist/hashes.js.map

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

@@ -0,0 +1,64 @@
+import { decodeLedgerData } from './ledger-hashes';
+import { JsonObject } from './types/serialized-type';
+import { XrplDefinitionsBase, TRANSACTION_TYPES, TRANSACTION_TYPE_MAP, 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, 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, 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, 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;
+/**
+ * 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
+ */
+declare function encodeForMultisigning(json: object, signer: string, definitions?: XrplDefinitionsBase): string;
+/**
+ * Encode a quality value
+ *
+ * @param value string representation of a number
+ * @returns a hex-string representing the quality
+ */
+declare function encodeQuality(value: string): string;
+/**
+ * Decode a quality value
+ *
+ * @param value hex-string of a quality
+ * @returns a string representing the quality
+ */
+declare function decodeQuality(value: string): string;
+export { decode, encode, encodeForSigning, encodeForSigningClaim, encodeForMultisigning, encodeQuality, decodeQuality, decodeLedgerData, TRANSACTION_TYPES, TRANSACTION_TYPE_MAP, XrplDefinitions, XrplDefinitionsBase, DEFAULT_DEFINITIONS, coreTypes, };