@bithomp/xrpl-api 3.0.2 → 3.0.4

package/lib/ledger/amm_info.d.ts

@@ -0,0 +1,13 @@
+import { Connection } from "../connection";
+import { ErrorResponse } from "../models/base_model";
+import { IssuedCurrency } from "../types";
+import { LedgerIndex } from "../models/ledger";
+export interface GetAmmInfoOptions {
+    url?: string;
+    type?: string;
+    connection?: Connection;
+    ledgerIndex?: LedgerIndex;
+    account?: string;
+}
+export declare function getAmmInfo(ammAccount: string, options?: GetAmmInfoOptions): Promise<object | ErrorResponse>;
+export declare function getAmmInfoByAssets(asset: string | IssuedCurrency, asset2: string | IssuedCurrency, options?: GetAmmInfoOptions): Promise<object | ErrorResponse>;

package/lib/ledger/amm_info.js

@@ -0,0 +1,102 @@
+"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.getAmmInfoByAssets = exports.getAmmInfo = void 0;
+const Client = __importStar(require("../client"));
+async function getAmmInfo(ammAccount, options = {}) {
+    const connection = options.connection || Client.findConnection(options.type, options.url, true);
+    if (!connection) {
+        throw new Error("There is no connection");
+    }
+    if (!ammAccount) {
+        return {
+            error: "invalidParams",
+            error_code: 31,
+            error_message: "Invalid parameters.",
+        };
+    }
+    const response = await connection.request({
+        command: "amm_info",
+        ledger_index: options.ledgerIndex || "validated",
+        account: options.account,
+        amm_account: ammAccount,
+    });
+    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.getAmmInfo = getAmmInfo;
+async function getAmmInfoByAssets(asset, asset2, options = {}) {
+    const connection = options.connection || Client.findConnection(options.type, options.url, true);
+    if (!connection) {
+        throw new Error("There is no connection");
+    }
+    if (!asset || !asset2) {
+        return {
+            error: "invalidParams",
+            error_code: 31,
+            error_message: "Invalid parameters.",
+        };
+    }
+    const response = await connection.request({
+        command: "amm_info",
+        ledger_index: options.ledgerIndex || "validated",
+        account: options.account,
+        asset: asset,
+        asset2: asset2,
+    });
+    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.getAmmInfoByAssets = getAmmInfoByAssets;

package/lib/ledger/index.d.ts

@@ -5,6 +5,7 @@ export * from "./account_nfts";
 export * from "./account_objects";
 export * from "./account_offers";
 export * from "./account_tx";
+export * from "./amm_info";
 export * from "./book_offers";
 export * from "./currency";
 export * from "./fee";

package/lib/ledger/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./account_nfts"), exports);
 __exportStar(require("./account_objects"), exports);
 __exportStar(require("./account_offers"), exports);
 __exportStar(require("./account_tx"), exports);
+__exportStar(require("./amm_info"), exports);
 __exportStar(require("./book_offers"), exports);
 __exportStar(require("./currency"), exports);
 __exportStar(require("./fee"), exports);

package/lib/ledger/transaction.js

@@ -142,6 +142,7 @@ async function getTransactionByCTID(ctid, options = {}) {
             error: "txnNotFound",
         };
     }
+    ledgerTx.ctid = ctid;
     const result = (0, transaction_1.ledgerTxToTx)(ledgerTx, ledgerIndex, ledger.close_time);
     if (formatted === true) {
         return (0, transaction_1.getTxDetails)(result, options.includeRawTransaction === true, undefined, options.definitions);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "3.0.2",
+  "version": "3.0.4",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -63,21 +63,21 @@
     "@types/lodash": "^4.17.0",
     "@types/mocha": "^10.0.6",
     "@types/nconf": "^0.10.6",
-    "@types/node": "^20.11.30",
-    "@typescript-eslint/eslint-plugin": "^7.3.1",
-    "@typescript-eslint/parser": "^7.3.1",
+    "@types/node": "^20.12.7",
+    "@typescript-eslint/eslint-plugin": "^7.7.0",
+    "@typescript-eslint/parser": "^7.7.0",
     "chai": "^4.4.1",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-chai-friendly": "^0.7.4",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-n": "^17.2.1",
     "eslint-plugin-promise": "^6.1.1",
-    "mocha": "^10.3.0",
+    "mocha": "^10.4.0",
     "nconf": "^0.12.1",
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.3"
+    "typescript": "^5.4.5"
   }
 }