@bithomp/xrpl-api 2.7.9 → 2.7.10

package/lib/ledger/index.d.ts

@@ -14,6 +14,7 @@ export * from "./ledger_entry";
 export * from "./manifest";
 export * from "./nft_info";
 export * from "./server_info";
+export * from "./server_definitions";
 export * from "./transaction";
 export * from "./vl";
 export * from "./vl-v2";

package/lib/ledger/index.js

@@ -30,6 +30,7 @@ __exportStar(require("./ledger_entry"), exports);
 __exportStar(require("./manifest"), exports);
 __exportStar(require("./nft_info"), exports);
 __exportStar(require("./server_info"), exports);
+__exportStar(require("./server_definitions"), exports);
 __exportStar(require("./transaction"), exports);
 __exportStar(require("./vl"), exports);
 __exportStar(require("./vl-v2"), exports);

package/lib/ledger/server_definitions.d.ts

@@ -0,0 +1,7 @@
+import { Connection } from "../connection";
+import { ErrorResponse } from "../models/base_model";
+import { ServerDefinitionsResponseResult } from "../models/server_definitions";
+export interface GetServerDefinitionsOptions {
+    connection?: Connection;
+}
+export declare function getServerDefinitions(options?: GetServerDefinitionsOptions): Promise<ServerDefinitionsResponseResult | ErrorResponse>;

package/lib/ledger/server_definitions.js

@@ -0,0 +1,54 @@
+"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.getServerDefinitions = void 0;
+const Client = __importStar(require("../client"));
+async function getServerDefinitions(options = {}) {
+    const connection = options.connection || Client.findConnection();
+    if (!connection) {
+        throw new Error("There is no connection");
+    }
+    const response = await connection.request({
+        command: "server_definitions",
+    });
+    if (!response) {
+        return {
+            status: "error",
+            error: "invalidResponse",
+        };
+    }
+    if (response.error) {
+        const { error, error_code, error_message, status, validated } = response;
+        return {
+            error,
+            error_code,
+            error_message,
+            status,
+            validated,
+        };
+    }
+    return response?.result;
+}
+exports.getServerDefinitions = getServerDefinitions;

package/lib/models/index.d.ts

@@ -8,6 +8,7 @@ export * from "./account_lines";
 export * from "./account_namespace";
 export * from "./account_uritokens";
 export * from "./vl";
+export * from "./server_definitions";
 export { parseAffectedObjects } from "../parse/outcome/affected_objects";
 export { parseNFTokenChanges } from "../parse/outcome/nftoken_changes";
 export { parseNFTokenOfferChanges } from "../parse/outcome/nftoken_offer_changes";

package/lib/models/index.js

@@ -28,6 +28,7 @@ __exportStar(require("./account_lines"), exports);
 __exportStar(require("./account_namespace"), exports);
 __exportStar(require("./account_uritokens"), exports);
 __exportStar(require("./vl"), exports);
+__exportStar(require("./server_definitions"), exports);
 var affected_objects_1 = require("../parse/outcome/affected_objects");
 Object.defineProperty(exports, "parseAffectedObjects", { enumerable: true, get: function () { return affected_objects_1.parseAffectedObjects; } });
 var nftoken_changes_1 = require("../parse/outcome/nftoken_changes");

package/lib/models/server_definitions.d.ts

@@ -0,0 +1,33 @@
+interface FieldInfo {
+    nth: number;
+    isVLEncoded: boolean;
+    isSerialized: boolean;
+    isSigningField: boolean;
+    type: string;
+}
+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>;
+}
+interface AmendmentInterface {
+    count?: number;
+    enabled?: boolean;
+    name?: string;
+    supported?: boolean;
+    threshold?: number;
+    validations?: number;
+    vetoed?: string;
+}
+interface ServerDefinitionsResponseResultBase extends DefinitionsData {
+    features?: {
+        [key: string]: AmendmentInterface;
+    }[];
+}
+export type ServerDefinitionsResponseResult = {
+    hash: string;
+    native_currency_code?: string;
+} & ServerDefinitionsResponseResultBase;
+export {};

package/lib/models/server_definitions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "2.7.9",
+  "version": "2.7.10",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",