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

package/dist/enums/field.d.ts

@@ -0,0 +1,29 @@
+import { Bytes } from './bytes';
+import { SerializedType } from '../types/serialized-type';
+import { Buffer } from 'buffer/';
+/**
+ * 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: Buffer;
+    readonly associatedType: typeof SerializedType;
+}
+export declare class FieldLookup {
+    constructor(fields: Array<[string, FieldInfo]>, types: Record<string, number>);
+    fromString(value: string): FieldInstance;
+}

package/dist/enums/field.js

@@ -0,0 +1,59 @@
+"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");
+const buffer_1 = require("buffer/");
+/*
+ * @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 buffer_1.Buffer.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/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;AACxC,oCAAgC;AA0BhC;;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,eAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AAC5B,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/enums/index.d.ts

@@ -0,0 +1,13 @@
+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[];
+declare const TRANSACTION_TYPE_MAP: Record<string, number>;
+export { Bytes, XrplDefinitionsBase, DEFAULT_DEFINITIONS, Field, FieldInstance, Type, LedgerEntryType, TransactionResult, TransactionType, TRANSACTION_TYPES, TRANSACTION_TYPE_MAP, };

package/dist/enums/index.js

@@ -0,0 +1,53 @@
+"use strict";
+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.TRANSACTION_TYPE_MAP = exports.TRANSACTION_TYPES = exports.TransactionType = exports.TransactionResult = exports.LedgerEntryType = exports.Type = exports.Field = exports.DEFAULT_DEFINITIONS = exports.XrplDefinitionsBase = exports.Bytes = void 0;
+const enums = __importStar(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(enums, {});
+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;
+const TRANSACTION_TYPE_MAP = DEFAULT_DEFINITIONS.transactionMap;
+exports.TRANSACTION_TYPE_MAP = TRANSACTION_TYPE_MAP;
+//# sourceMappingURL=index.js.map

package/dist/enums/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/enums/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0DAA2C;AAC3C,mEAIgC;AAoB9B,oGAvBA,2CAAmB,OAuBA;AADnB,sFApBA,6BAAK,OAoBA;AAlBP;;GAEG;AACH,MAAM,mBAAmB,GAAG,IAAI,2CAAmB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;AAiB5D,kDAAmB;AAfrB,MAAM,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAA;AAkBnC,oBAAI;AAjBN,MAAM,eAAe,GAAG,mBAAmB,CAAC,eAAe,CAAA;AAkBzD,0CAAe;AAjBjB,MAAM,eAAe,GAAG,mBAAmB,CAAC,eAAe,CAAA;AAmBzD,0CAAe;AAlBjB,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,iBAAiB,CAAA;AAiB7D,8CAAiB;AAhBnB,MAAM,KAAK,GAAG,mBAAmB,CAAC,KAAK,CAAA;AAYrC,sBAAK;AAVP;;GAEG;AACH,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,gBAAgB,CAAA;AAa5D,8CAAiB;AAZnB,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,cAAc,CAAA;AAa7D,oDAAoB"}