@transia/ripple-binary-codec 1.4.6-alpha.9 → 2.5.1

package/dist/src/enums/field.d.ts

@@ -0,0 +1,28 @@
+import { Bytes } from './bytes';
+import { SerializedType } from '../types/serialized-type';
+/**
+ * Encoding information for a rippled field, often used in transactions.
+ * See the enums [README.md](https://github.com/XRPLF/xrpl.js/tree/main/packages/ripple-binary-codec/src/enums) for more details on what each means.
+ */
+export interface FieldInfo {
+    nth: number;
+    isVLEncoded: boolean;
+    isSerialized: boolean;
+    isSigningField: boolean;
+    type: string;
+}
+export interface FieldInstance {
+    readonly nth: number;
+    readonly isVariableLengthEncoded: boolean;
+    readonly isSerialized: boolean;
+    readonly isSigningField: boolean;
+    readonly type: Bytes;
+    readonly ordinal: number;
+    readonly name: string;
+    readonly header: Uint8Array;
+    readonly associatedType: typeof SerializedType;
+}
+export declare class FieldLookup {
+    constructor(fields: Array<[string, FieldInfo]>, types: Record<string, number>);
+    fromString(value: string): FieldInstance;
+}

package/dist/src/enums/field.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldLookup = void 0;
+const bytes_1 = require("./bytes");
+const serialized_type_1 = require("../types/serialized-type");
+const constants_1 = require("./constants");
+/*
+ * @brief: Serialize a field based on type_code and Field.nth
+ */
+function fieldHeader(type, nth) {
+    const header = [];
+    if (type < 16) {
+        if (nth < 16) {
+            header.push((type << 4) | nth);
+        }
+        else {
+            header.push(type << 4, nth);
+        }
+    }
+    else if (nth < 16) {
+        header.push(nth, type);
+    }
+    else {
+        header.push(0, type, nth);
+    }
+    return Uint8Array.from(header);
+}
+function buildField([name, info], typeOrdinal) {
+    const field = fieldHeader(typeOrdinal, info.nth);
+    return {
+        name: name,
+        nth: info.nth,
+        isVariableLengthEncoded: info.isVLEncoded,
+        isSerialized: info.isSerialized,
+        isSigningField: info.isSigningField,
+        ordinal: (typeOrdinal << 16) | info.nth,
+        type: new bytes_1.Bytes(info.type, typeOrdinal, constants_1.TYPE_WIDTH),
+        header: field,
+        associatedType: serialized_type_1.SerializedType, // For later assignment in ./types/index.js or Definitions.updateAll(...)
+    };
+}
+/*
+ * @brief: The collection of all fields as defined in definitions.json
+ */
+class FieldLookup {
+    constructor(fields, types) {
+        fields.forEach(([name, field_info]) => {
+            const typeOrdinal = types[field_info.type];
+            this[name] = buildField([name, field_info], typeOrdinal);
+            this[this[name].ordinal.toString()] = this[name];
+        });
+    }
+    fromString(value) {
+        return this[value];
+    }
+}
+exports.FieldLookup = FieldLookup;
+//# sourceMappingURL=field.js.map

package/dist/src/enums/field.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"field.js","sourceRoot":"","sources":["../../../src/enums/field.ts"],"names":[],"mappings":";;;AAAA,mCAA+B;AAC/B,8DAAyD;AACzD,2CAAwC;AA0BxC;;GAEG;AACH,SAAS,WAAW,CAAC,IAAY,EAAE,GAAW;IAC5C,MAAM,MAAM,GAAkB,EAAE,CAAA;IAChC,IAAI,IAAI,GAAG,EAAE,EAAE;QACb,IAAI,GAAG,GAAG,EAAE,EAAE;YACZ,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAA;SAC/B;aAAM;YACL,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE,GAAG,CAAC,CAAA;SAC5B;KACF;SAAM,IAAI,GAAG,GAAG,EAAE,EAAE;QACnB,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;KACvB;SAAM;QACL,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;KAC1B;IACD,OAAO,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AAChC,CAAC;AAED,SAAS,UAAU,CACjB,CAAC,IAAI,EAAE,IAAI,CAAsB,EACjC,WAAmB;IAEnB,MAAM,KAAK,GAAG,WAAW,CAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,CAAA;IAChD,OAAO;QACL,IAAI,EAAE,IAAI;QACV,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,uBAAuB,EAAE,IAAI,CAAC,WAAW;QACzC,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,cAAc,EAAE,IAAI,CAAC,cAAc;QACnC,OAAO,EAAE,CAAC,WAAW,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG;QACvC,IAAI,EAAE,IAAI,aAAK,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,sBAAU,CAAC;QACnD,MAAM,EAAE,KAAK;QACb,cAAc,EAAE,gCAAc,EAAE,yEAAyE;KAC1G,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAa,WAAW;IACtB,YACE,MAAkC,EAClC,KAA6B;QAE7B,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,EAAE;YACpC,MAAM,WAAW,GAAG,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;YAC1C,IAAI,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,WAAW,CAAC,CAAA;YACxD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAA;QAClD,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,UAAU,CAAC,KAAa;QACtB,OAAO,IAAI,CAAC,KAAK,CAAkB,CAAA;IACrC,CAAC;CACF;AAfD,kCAeC"}

package/dist/src/enums/index.d.ts

@@ -0,0 +1,12 @@
+import { XrplDefinitionsBase, FieldInstance, Bytes } from './xrpl-definitions-base';
+/**
+ * By default, coreTypes from the `types` folder is where known type definitions are initialized to avoid import cycles.
+ */
+declare const DEFAULT_DEFINITIONS: XrplDefinitionsBase;
+declare const Type: import("./bytes").BytesLookup;
+declare const LedgerEntryType: import("./bytes").BytesLookup;
+declare const TransactionType: import("./bytes").BytesLookup;
+declare const TransactionResult: import("./bytes").BytesLookup;
+declare const Field: import("./field").FieldLookup;
+declare const TRANSACTION_TYPES: string[];
+export { Bytes, XrplDefinitionsBase, DEFAULT_DEFINITIONS, Field, FieldInstance, Type, LedgerEntryType, TransactionResult, TransactionType, TRANSACTION_TYPES, };

package/dist/src/enums/index.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TRANSACTION_TYPES = exports.TransactionType = exports.TransactionResult = exports.LedgerEntryType = exports.Type = exports.Field = exports.DEFAULT_DEFINITIONS = exports.XrplDefinitionsBase = exports.Bytes = void 0;
+const definitions_json_1 = __importDefault(require("./definitions.json"));
+const xrpl_definitions_base_1 = require("./xrpl-definitions-base");
+Object.defineProperty(exports, "XrplDefinitionsBase", { enumerable: true, get: function () { return xrpl_definitions_base_1.XrplDefinitionsBase; } });
+Object.defineProperty(exports, "Bytes", { enumerable: true, get: function () { return xrpl_definitions_base_1.Bytes; } });
+/**
+ * By default, coreTypes from the `types` folder is where known type definitions are initialized to avoid import cycles.
+ */
+const DEFAULT_DEFINITIONS = new xrpl_definitions_base_1.XrplDefinitionsBase(definitions_json_1.default, {});
+exports.DEFAULT_DEFINITIONS = DEFAULT_DEFINITIONS;
+const Type = DEFAULT_DEFINITIONS.type;
+exports.Type = Type;
+const LedgerEntryType = DEFAULT_DEFINITIONS.ledgerEntryType;
+exports.LedgerEntryType = LedgerEntryType;
+const TransactionType = DEFAULT_DEFINITIONS.transactionType;
+exports.TransactionType = TransactionType;
+const TransactionResult = DEFAULT_DEFINITIONS.transactionResult;
+exports.TransactionResult = TransactionResult;
+const Field = DEFAULT_DEFINITIONS.field;
+exports.Field = Field;
+/*
+ * @brief: All valid transaction types
+ */
+const TRANSACTION_TYPES = DEFAULT_DEFINITIONS.transactionNames;
+exports.TRANSACTION_TYPES = TRANSACTION_TYPES;
+//# sourceMappingURL=index.js.map

package/dist/src/enums/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/enums/index.ts"],"names":[],"mappings":";;;;;;AAAA,0EAAsC;AACtC,mEAIgC;AAmB9B,oGAtBA,2CAAmB,OAsBA;AADnB,sFAnBA,6BAAK,OAmBA;AAjBP;;GAEG;AACH,MAAM,mBAAmB,GAAG,IAAI,2CAAmB,CAAC,0BAAK,EAAE,EAAE,CAAC,CAAA;AAgB5D,kDAAmB;AAdrB,MAAM,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAA;AAiBnC,oBAAI;AAhBN,MAAM,eAAe,GAAG,mBAAmB,CAAC,eAAe,CAAA;AAiBzD,0CAAe;AAhBjB,MAAM,eAAe,GAAG,mBAAmB,CAAC,eAAe,CAAA;AAkBzD,0CAAe;AAjBjB,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,iBAAiB,CAAA;AAgB7D,8CAAiB;AAfnB,MAAM,KAAK,GAAG,mBAAmB,CAAC,KAAK,CAAA;AAWrC,sBAAK;AATP;;GAEG;AACH,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,gBAAgB,CAAA;AAY5D,8CAAiB"}

package/dist/src/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/src/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/src/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/src/enums/xrpl-definitions-base.d.ts

@@ -0,0 +1,47 @@
+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>;
+    granularPermissions: Record<string, number>;
+    delegatablePermissions: BytesLookup;
+    /**
+     * 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 the tool at
+     * `packages/ripple-binary-codec/tools/generateDefinitions.js`.
+     *
+     * 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/src/enums/xrpl-definitions-base.js

@@ -0,0 +1,83 @@
+"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 the tool at
+     * `packages/ripple-binary-codec/tools/generateDefinitions.js`.
+     *
+     * 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);
+        this.granularPermissions = {
+            TrustlineAuthorize: 65537,
+            TrustlineFreeze: 65538,
+            TrustlineUnfreeze: 65539,
+            AccountDomainSet: 65540,
+            AccountEmailHashSet: 65541,
+            AccountMessageKeySet: 65542,
+            AccountTransferRateSet: 65543,
+            AccountTickSizeSet: 65544,
+            PaymentMint: 65545,
+            PaymentBurn: 65546,
+            MPTokenIssuanceLock: 65547,
+            MPTokenIssuanceUnlock: 65548,
+        };
+        const incrementedTransactionTypes = Object.fromEntries(Object.entries(enums.TRANSACTION_TYPES).map(([key, value]) => [
+            key,
+            value + 1,
+        ]));
+        const combinedPermissions = Object.assign(Object.assign({}, this.granularPermissions), incrementedTransactionTypes);
+        this.delegatablePermissions = new bytes_1.BytesLookup(combinedPermissions, constants_1.DELEGATABLE_PERMISSIONS_WIDTH);
+    }
+    /**
+     * 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;
+        if (this.field['PermissionValue']) {
+            this.field['PermissionValue'].associatedType = this.delegatablePermissions;
+        }
+    }
+    getAssociatedTypes() {
+        return this.dataTypes;
+    }
+}
+exports.XrplDefinitionsBase = XrplDefinitionsBase;
+//# sourceMappingURL=xrpl-definitions-base.js.map

package/dist/src/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;AAkJ1C,sFAlJO,aAAK,OAkJP;AACL,4FAnJc,mBAAW,OAmJd;AAlJb,mCAA+D;AA8I7D,4FA9IkB,mBAAW,OA8IlB;AA7Ib,2CAMoB;AAUpB;;;GAGG;AACH,MAAM,mBAAmB;IAoBvB;;;;;;;;;;;OAWG;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;QAE1B,IAAI,CAAC,mBAAmB,GAAG;YACzB,kBAAkB,EAAE,KAAK;YACzB,eAAe,EAAE,KAAK;YACtB,iBAAiB,EAAE,KAAK;YACxB,gBAAgB,EAAE,KAAK;YACvB,mBAAmB,EAAE,KAAK;YAC1B,oBAAoB,EAAE,KAAK;YAC3B,sBAAsB,EAAE,KAAK;YAC7B,kBAAkB,EAAE,KAAK;YACzB,WAAW,EAAE,KAAK;YAClB,WAAW,EAAE,KAAK;YAClB,mBAAmB,EAAE,KAAK;YAC1B,qBAAqB,EAAE,KAAK;SAC7B,CAAA;QAED,MAAM,2BAA2B,GAAG,MAAM,CAAC,WAAW,CACpD,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;YAC5D,GAAG;YACH,KAAK,GAAG,CAAC;SACV,CAAC,CACH,CAAA;QACD,MAAM,mBAAmB,mCACpB,IAAI,CAAC,mBAAmB,GACxB,2BAA2B,CAC/B,CAAA;QACD,IAAI,CAAC,sBAAsB,GAAG,IAAI,mBAAW,CAC3C,mBAAmB,EACnB,yCAA6B,CAC9B,CAAA;IACH,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;QACnE,IAAI,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE;YACjC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,cAAc,GAAG,IAAI,CAAC,sBAAsB,CAAA;SAC3E;IACH,CAAC;IAEM,kBAAkB;QACvB,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;CACF;AAIC,kDAAmB"}

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

@@ -0,0 +1,22 @@
+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 the tool at
+     * `packages/ripple-binary-codec/tools/generateDefinitions.js`.
+     *
+     * 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/src/enums/xrpl-definitions.js

@@ -0,0 +1,30 @@
+"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 the tool at
+     * `packages/ripple-binary-codec/tools/generateDefinitions.js`.
+     *
+     * 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/src/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;;;;;;;;;;;OAWG;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;AApBD,0CAoBC"}

package/dist/src/hash-prefixes.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Maps HashPrefix names to their byte representation
+ */
+declare const HashPrefix: Record<string, Uint8Array>;
+export { HashPrefix };

package/dist/src/hash-prefixes.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HashPrefix = void 0;
+const utils_1 = require("./utils");
+/**
+ * Write a 32 bit integer to a Uint8Array
+ *
+ * @param uint32 32 bit integer to write to Uint8Array
+ * @returns a Uint8Array with the bytes representation of uint32
+ */
+function bytes(uint32) {
+    const result = new Uint8Array(4);
+    (0, utils_1.writeUInt32BE)(result, 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),
+    // batch
+    batch: bytes(0x42434800),
+};
+exports.HashPrefix = HashPrefix;
+//# sourceMappingURL=hash-prefixes.js.map

package/dist/src/hash-prefixes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash-prefixes.js","sourceRoot":"","sources":["../../src/hash-prefixes.ts"],"names":[],"mappings":";;;AAAA,mCAAuC;AAEvC;;;;;GAKG;AACH,SAAS,KAAK,CAAC,MAAc;IAC3B,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;IAChC,IAAA,qBAAa,EAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAA;IAChC,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,GAA+B;IAC7C,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;IACtC,QAAQ;IACR,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC;CACzB,CAAA;AAEQ,gCAAU"}