@bithomp/xrpl-api 3.1.3 → 3.1.5

package/lib/base58.js

@@ -15,7 +15,7 @@ function decode(value) {
     try {
         return Buffer.from(base58.decode(value));
     }
-    catch (e) {
+    catch (_err) {
     }
     return null;
 }
@@ -26,7 +26,7 @@ function encode(buffer) {
     try {
         return base58.encode(buffer);
     }
-    catch (e) {
+    catch (_err) {
     }
     return null;
 }

package/lib/connection.js

@@ -61,7 +61,7 @@ class Connection extends events_1.EventEmitter {
             this.client = new xrpl_1.Client(this.url, (0, common_1.removeUndefined)({ timeout: this.timeout, connectionTimeout: this.connectionTimeout }));
             this.client.apiVersion = this.apiVersion;
             this.setupEmitter();
-            await this.client.connect();
+            await this.client.connection.connect();
             await this.updateServerInfo();
             await this.subscribe();
         }
@@ -92,7 +92,10 @@ class Connection extends events_1.EventEmitter {
                 return { error: "Not connected" };
             }
             const startDate = new Date();
-            const response = await this.client.request(request);
+            if (this.apiVersion && !request.hasOwnProperty("api_version") && exports.DEFAULT_API_VERSION !== this.apiVersion) {
+                request.api_version = this.apiVersion;
+            }
+            const response = await this.client.connection.request(request);
             const endDate = new Date();
             this.updateLatency(endDate.getTime() - startDate.getTime());
             return response;
@@ -137,7 +140,7 @@ class Connection extends events_1.EventEmitter {
         if (!this.client) {
             return false;
         }
-        return this.client.isConnected();
+        return this.client.connection.isConnected();
     }
     getOnlinePeriodMs() {
         if (this.isConnected()) {
@@ -207,19 +210,19 @@ class Connection extends events_1.EventEmitter {
     async removeClient() {
         try {
             if (this.client) {
-                await this.client.disconnect();
-                this.client.removeAllListeners();
+                await this.client.connection.disconnect();
+                this.client.connection.removeAllListeners();
                 this.client = undefined;
             }
         }
-        catch (e) {
+        catch (_err) {
         }
     }
     setupEmitter() {
         if (!this.client) {
             return;
         }
-        this.client.on("connected", () => {
+        this.client.connection.on("connected", () => {
             this.logger?.debug({
                 service: "Bithomp::XRPL::Connection",
                 emit: "connected",
@@ -228,7 +231,7 @@ class Connection extends events_1.EventEmitter {
             this.emit("connected");
             this.onlineSince = new Date().getTime();
         });
-        this.client.on("disconnected", (code) => {
+        this.client.connection.on("disconnected", (code) => {
             this.logger?.debug({
                 service: "Bithomp::XRPL::Connection",
                 emit: "disconnected",
@@ -240,7 +243,7 @@ class Connection extends events_1.EventEmitter {
             this.streamsSubscribed = false;
             this.emit("disconnected", code);
         });
-        this.client.on("error", (source, message, error) => {
+        this.client.connection.on("error", (source, message, error) => {
             try {
                 this.logger?.error({
                     service: "Bithomp::XRPL::Connection",
@@ -260,23 +263,23 @@ class Connection extends events_1.EventEmitter {
             }
             this.connectionValidation();
         });
-        this.client.on("ledgerClosed", (ledgerStream) => {
+        this.client.connection.on("ledgerClosed", (ledgerStream) => {
             this.onLedgerClosed(ledgerStream);
             this.emit("ledgerClosed", ledgerStream);
         });
-        this.client.on("transaction", (transactionStream) => {
+        this.client.connection.on("transaction", (transactionStream) => {
             this.emit("transaction", transactionStream);
         });
-        this.client.on("validationReceived", (validation) => {
+        this.client.connection.on("validationReceived", (validation) => {
             this.emit("validationReceived", validation);
         });
-        this.client.on("peerStatusChange", (status) => {
+        this.client.connection.on("peerStatusChange", (status) => {
             this.emit("peerStatusChange", status);
         });
-        this.client.on("consensusPhase", (consensus) => {
+        this.client.connection.on("consensusPhase", (consensus) => {
             this.emit("consensusPhase", consensus);
         });
-        this.client.on("path_find", (path) => {
+        this.client.connection.on("path_find", (path) => {
             this.emit("path_find", path);
         });
     }
@@ -427,7 +430,7 @@ class Connection extends events_1.EventEmitter {
                 }
             }
         }
-        catch (error) {
+        catch (_err) {
         }
         this.serverInfoUpdating = false;
     }

package/lib/ledger/account_info.d.ts

@@ -2,11 +2,15 @@ import { Connection } from "../connection";
 import { LedgerIndex } from "../models/ledger";
 import { AccountInfoResponse, AccountInfoDataResponse } from "../models/account_info";
 import { ErrorResponse } from "../models/base_model";
+import { FormattedAccountInfoData } from "../types";
 export interface GetAccountInfoOptions {
     ledgerIndex?: LedgerIndex;
     signerLists?: boolean;
     connection?: Connection;
 }
 export declare function getAccountInfo(account: string, options?: GetAccountInfoOptions): Promise<AccountInfoResponse | ErrorResponse>;
-export declare function getAccountInfoData(account: string, options?: GetAccountInfoOptions): Promise<AccountInfoDataResponse | ErrorResponse>;
+export interface GetAccountInfoDataOptions extends GetAccountInfoOptions {
+    formatted?: boolean;
+}
+export declare function getAccountInfoData(account: string, options?: GetAccountInfoDataOptions): Promise<AccountInfoDataResponse | FormattedAccountInfoData | ErrorResponse>;
 export declare function isActivated(account: string): Promise<boolean>;

package/lib/ledger/account_info.js

@@ -27,6 +27,7 @@ exports.getAccountInfo = getAccountInfo;
 exports.getAccountInfoData = getAccountInfoData;
 exports.isActivated = isActivated;
 const Client = __importStar(require("../client"));
+const account_info_1 = require("../parse/ledger/account-info");
 async function getAccountInfo(account, options = {}) {
     const connection = options.connection || Client.findConnection();
     if (!connection) {
@@ -70,11 +71,15 @@ async function getAccountInfo(account, options = {}) {
     return result;
 }
 async function getAccountInfoData(account, options = {}) {
+    const formatted = options.formatted === true;
     const response = await getAccountInfo(account, options);
     if ("error" in response) {
         return response;
     }
-    return response?.account_data;
+    if (formatted) {
+        return (0, account_info_1.parseAccountInfoData)(response);
+    }
+    return response.account_data;
 }
 async function isActivated(account) {
     const response = await getAccountInfo(account);

package/lib/ledger/account_objects.d.ts

@@ -1,3 +1,4 @@
+import { Connection } from "../connection";
 import { AccountObjectType, AccountObjects, AccountNFTObjectsResponse, AccountURITokensObjectsResponse } from "../models/account_object";
 import { AccountLinesResponse } from "../models/account_lines";
 import { ErrorResponse } from "../models/base_model";
@@ -8,6 +9,7 @@ export interface GetAccountObjectsOptions {
     ledgerIndex?: LedgerIndex;
     limit?: number;
     marker?: string;
+    connection?: Connection;
 }
 export declare function getAccountObjects(account: string, options?: GetAccountObjectsOptions): Promise<AccountObjects | ErrorResponse>;
 export interface GetAccountAllObjectsOptions extends GetAccountObjectsOptions {

package/lib/ledger/account_objects.js

@@ -37,7 +37,7 @@ const OBJECTS_LIMIT_MIN = 10;
 async function getAccountObjects(account, options = {}) {
     const { hash, marker } = (0, utils_1.parseMarker)(options.marker);
     options.marker = marker;
-    const connection = Client.findConnection("account_objects", undefined, undefined, hash);
+    const connection = options.connection || Client.findConnection("account_objects", undefined, undefined, hash);
     if (!connection) {
         throw new Error("There is no connection");
     }
@@ -77,27 +77,29 @@ async function getAccountObjects(account, options = {}) {
     return result;
 }
 async function getAccountAllObjects(account, options = {}) {
+    const loadOptions = { ...options };
+    loadOptions.connection = loadOptions.connection || Client.findConnection("account_objects", undefined, undefined);
     const timeStart = new Date();
-    const limit = options.limit;
+    const limit = loadOptions.limit;
     let response;
     const accountObjects = [];
     while (true) {
         const currentTime = new Date();
-        if (options.timeout && currentTime.getTime() - timeStart.getTime() > options.timeout) {
-            options.timeout = currentTime.getTime() - timeStart.getTime();
+        if (loadOptions.timeout && currentTime.getTime() - timeStart.getTime() > loadOptions.timeout) {
+            loadOptions.timeout = currentTime.getTime() - timeStart.getTime();
             break;
         }
-        if (options.limit && limit) {
+        if (loadOptions.limit && limit) {
             const left = limit - accountObjects.length;
             const parts = Math.floor(left / OBJECTS_LIMIT_MAX);
             if (parts === 0) {
-                options.limit = left;
+                loadOptions.limit = left;
             }
             else {
-                options.limit = left - OBJECTS_LIMIT_MIN;
+                loadOptions.limit = left - OBJECTS_LIMIT_MIN;
             }
         }
-        response = await getAccountObjects(account, options);
+        response = await getAccountObjects(account, loadOptions);
         if (response.error) {
             return response;
         }
@@ -107,7 +109,7 @@ async function getAccountAllObjects(account, options = {}) {
             break;
         }
         if (response.marker) {
-            options.marker = response.marker;
+            loadOptions.marker = response.marker;
         }
         else {
             break;
@@ -125,6 +127,9 @@ async function getAccountAllObjects(account, options = {}) {
         };
     }
     response.account_objects = accountObjects;
+    if (!options.hasOwnProperty("limit")) {
+        delete response.limit;
+    }
     return response;
 }
 async function getAccountLinesObjects(account, options = {}) {

package/lib/ledger/currency.js

@@ -132,7 +132,7 @@ async function getLedger(ledgerIndex) {
     try {
         ledgerInfo = await Client.getLedger({ ledgerIndex, transactions: true, expand: true });
     }
-    catch (e) {
+    catch (_err) {
     }
     return ledgerInfo;
 }

package/lib/ledger/gateway_balances.d.ts

@@ -1,12 +1,15 @@
 import { Trustline } from "../models/account_lines";
 import { LedgerIndex } from "../models/ledger";
 import { ErrorResponse } from "../models/base_model";
+import { GatewayBalances } from "../models/gateway_balances";
+import { FormattedGatewayBalances } from "../types";
 export interface GetBalanceSheetOptions {
     ledgerIndex?: LedgerIndex;
     hotwallet?: string;
     strict?: boolean;
+    formatted?: boolean;
 }
-export declare function getBalanceSheet(account: string, options?: GetBalanceSheetOptions): Promise<object | ErrorResponse>;
+export declare function getBalanceSheet(account: string, options?: GetBalanceSheetOptions): Promise<GatewayBalances | FormattedGatewayBalances | ErrorResponse>;
 export interface ObligationTrustline extends Trustline {
     obligation?: boolean;
 }

package/lib/ledger/gateway_balances.js

@@ -31,7 +31,9 @@ exports.getAccountObligations = getAccountObligations;
 const lodash_1 = __importDefault(require("lodash"));
 const bignumber_js_1 = __importDefault(require("bignumber.js"));
 const Client = __importStar(require("../client"));
+const gateway_balances_1 = require("../parse/ledger/gateway-balances");
 async function getBalanceSheet(account, options = {}) {
+    const formatted = options.formatted === true;
     const connection = Client.findConnection("gateway_balances");
     if (!connection) {
         throw new Error("There is no connection");
@@ -61,7 +63,11 @@ async function getBalanceSheet(account, options = {}) {
             validated,
         };
     }
-    return response?.result;
+    const result = response.result;
+    if (formatted) {
+        return (0, gateway_balances_1.parseGatewayBalances)(result);
+    }
+    return result;
 }
 async function getAccountObligations(account) {
     const response = (await getBalanceSheet(account));

package/lib/ledger/transaction.js

@@ -235,7 +235,7 @@ async function getAccountPaymentParams(account, connection) {
         });
         const sequencePromise = new Promise(async (resolve, rejects) => {
             try {
-                const accountData = await Client.getAccountInfoData(account, { connection });
+                const accountData = (await Client.getAccountInfoData(account, { connection }));
                 if (!accountData) {
                     return rejects(new Error("Account not found"));
                 }
@@ -256,7 +256,7 @@ async function getAccountPaymentParams(account, connection) {
                 }
                 resolve(undefined);
             }
-            catch (e) {
+            catch (_err) {
                 resolve(undefined);
             }
         });
@@ -306,7 +306,7 @@ async function getTxSubmitParams(account, tx, definitions, connection, skip) {
         if (skip?.sequence !== true) {
             sequencePromise = new Promise(async (resolve, rejects) => {
                 try {
-                    const accountData = await Client.getAccountInfoData(account, { connection });
+                    const accountData = (await Client.getAccountInfoData(account, { connection }));
                     if (!accountData) {
                         return rejects(new Error("Account not found"));
                     }
@@ -329,7 +329,7 @@ async function getTxSubmitParams(account, tx, definitions, connection, skip) {
                     }
                     resolve(undefined);
                 }
-                catch (e) {
+                catch (_err) {
                     resolve(undefined);
                 }
             });

package/lib/models/gateway_balances.d.ts

@@ -0,0 +1,19 @@
+export interface GatewayBalance {
+    currency: string;
+    value: string;
+}
+export interface GatewayBalances {
+    account: string;
+    obligations?: {
+        [currency: string]: string;
+    };
+    balances?: {
+        [address: string]: GatewayBalance[];
+    };
+    assets?: {
+        [address: string]: GatewayBalance[];
+    };
+    ledger_hash?: string;
+    ledger_current_index?: number;
+    ledger_index?: number;
+}

package/lib/models/gateway_balances.js

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

package/lib/parse/ledger/account-info.d.ts

@@ -0,0 +1,3 @@
+import { AccountInfoResponse } from "../../models/account_info";
+import { FormattedAccountInfoData } from "../../types";
+export declare function parseAccountInfoData(response: AccountInfoResponse): FormattedAccountInfoData;

package/lib/parse/ledger/account-info.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseAccountInfoData = parseAccountInfoData;
+const common_1 = require("../../common");
+function parseAccountInfoData(response) {
+    const data = response.account_data;
+    return (0, common_1.removeUndefined)({
+        sequence: data.Sequence,
+        xrpBalance: (0, common_1.dropsToXrp)(data.Balance),
+        ownerCount: data.OwnerCount,
+        previousInitiatedTransactionID: data.AccountTxnID,
+        previousAffectingTransactionID: data.PreviousTxnID,
+        previousAffectingTransactionLedgerVersion: data.PreviousTxnLgrSeq,
+    });
+}

package/lib/parse/ledger/gateway-balances.d.ts

@@ -0,0 +1,3 @@
+import { FormattedGatewayBalances } from "../../types";
+import { GatewayBalances } from "../../models/gateway_balances";
+export declare function parseGatewayBalances(balanceSheet: GatewayBalances): FormattedGatewayBalances;

package/lib/parse/ledger/gateway-balances.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseGatewayBalances = parseGatewayBalances;
+function parseGatewayBalances(balanceSheet) {
+    const result = {};
+    if (typeof balanceSheet.balances === "object") {
+        Object.entries(balanceSheet.balances).forEach((entry) => {
+            const [counterparty, balances] = entry;
+            balances.forEach((balance) => {
+                if (!result.balances) {
+                    result.balances = [];
+                }
+                result.balances.push(Object.assign({ counterparty }, balance));
+            });
+        });
+    }
+    if (typeof balanceSheet.assets === "object") {
+        Object.entries(balanceSheet.assets).forEach(([counterparty, assets]) => {
+            assets.forEach((balance) => {
+                if (!result.assets) {
+                    result.assets = [];
+                }
+                result.assets.push(Object.assign({ counterparty }, balance));
+            });
+        });
+    }
+    if (typeof balanceSheet.obligations === "object") {
+        result.obligations = Object.entries(balanceSheet.obligations).map(([currency, value]) => ({ currency, value }));
+    }
+    return result;
+}

package/lib/parse/ledger/import.js

@@ -34,7 +34,7 @@ function parseImportBlob(blob) {
             },
         };
     }
-    catch (e) {
+    catch (_err) {
         return blob;
     }
 }

package/lib/parse/outcome/emitted_txns.js

@@ -42,7 +42,7 @@ class EmittedTxns {
                     try {
                         id = (0, wallet_1.hashSignedTx)(tx, this.definitions, false);
                     }
-                    catch (err) {
+                    catch (_err) {
                     }
                     this.emittedTxns.push((0, common_1.removeUndefined)({
                         id,

package/lib/types/account.d.ts

@@ -13,3 +13,11 @@ export type FormattedDestinationAddress = {
     address: string;
     tag?: number;
 };
+export type FormattedAccountInfoData = {
+    sequence: number;
+    xrpBalance: string;
+    ownerCount: number;
+    previousInitiatedTransactionID?: string;
+    previousAffectingTransactionID: string;
+    previousAffectingTransactionLedgerVersion: number;
+};

package/lib/types/gateway_balances.d.ts

@@ -0,0 +1,11 @@
+import { FormattedIssuedCurrency } from "./amounts";
+type FormattedGatewayBalanceObligations = {
+    currency: string;
+    value: string;
+};
+export type FormattedGatewayBalances = {
+    balances?: FormattedIssuedCurrency[];
+    assets?: FormattedIssuedCurrency[];
+    obligations?: FormattedGatewayBalanceObligations[];
+};
+export {};

package/lib/types/gateway_balances.js

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

package/lib/types/index.d.ts

@@ -1,12 +1,17 @@
+export * from "./account";
 export * from "./adjustments";
+export * from "./amendments";
 export * from "./amounts";
+export * from "./amm";
+export * from "./checks";
+export * from "./deposits";
+export * from "./escrows";
+export * from "./fees";
+export * from "./gateway_balances";
 export * from "./ledger";
 export * from "./ledger_data";
 export * from "./ledger_entries";
 export * from "./memos";
-export * from "./checks";
-export * from "./deposits";
-export * from "./escrows";
 export * from "./offers";
 export * from "./queue_data";
 export * from "./settings";
@@ -15,11 +20,8 @@ export * from "./transactions";
 export * from "./trustlines";
 export * from "./nftokens";
 export * from "./uritokens";
-export * from "./amendments";
-export * from "./fees";
 export * from "./import";
 export * from "./invoke";
 export * from "./unl_reports";
 export * from "./remits";
 export * from "./hooks";
-export * from "./amm";

package/lib/types/index.js

@@ -14,15 +14,20 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./account"), exports);
 __exportStar(require("./adjustments"), exports);
+__exportStar(require("./amendments"), exports);
 __exportStar(require("./amounts"), exports);
+__exportStar(require("./amm"), exports);
+__exportStar(require("./checks"), exports);
+__exportStar(require("./deposits"), exports);
+__exportStar(require("./escrows"), exports);
+__exportStar(require("./fees"), exports);
+__exportStar(require("./gateway_balances"), exports);
 __exportStar(require("./ledger"), exports);
 __exportStar(require("./ledger_data"), exports);
 __exportStar(require("./ledger_entries"), exports);
 __exportStar(require("./memos"), exports);
-__exportStar(require("./checks"), exports);
-__exportStar(require("./deposits"), exports);
-__exportStar(require("./escrows"), exports);
 __exportStar(require("./offers"), exports);
 __exportStar(require("./queue_data"), exports);
 __exportStar(require("./settings"), exports);
@@ -31,11 +36,8 @@ __exportStar(require("./transactions"), exports);
 __exportStar(require("./trustlines"), exports);
 __exportStar(require("./nftokens"), exports);
 __exportStar(require("./uritokens"), exports);
-__exportStar(require("./amendments"), exports);
-__exportStar(require("./fees"), exports);
 __exportStar(require("./import"), exports);
 __exportStar(require("./invoke"), exports);
 __exportStar(require("./unl_reports"), exports);
 __exportStar(require("./remits"), exports);
 __exportStar(require("./hooks"), exports);
-__exportStar(require("./amm"), exports);

package/lib/validator.js

@@ -92,7 +92,7 @@ function sign(message, secret) {
         const decoded = ripple_address_codec_1.codec.decode(secret, { versions: [0x20] });
         secret = VALIDATOR_HEX_PREFIX_ED25519 + (0, utils_1.bytesToHex)(decoded.bytes.buffer);
     }
-    catch (err) {
+    catch (_err) {
     }
     return rippleKeypairs.sign(message.toString("hex"), secret).toUpperCase();
 }
@@ -107,7 +107,7 @@ function verify(message, signature, publicKey) {
     try {
         return rippleKeypairs.verify(message.toString("hex"), signature, publicKey);
     }
-    catch (err) {
+    catch (_err) {
     }
     return false;
 }

package/lib/wallet.js

@@ -56,7 +56,7 @@ function isValidSecret(secret) {
         (0, ripple_keypairs_1.deriveKeypair)(secret);
         return true;
     }
-    catch (err) {
+    catch (_err) {
     }
     return false;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "3.1.3",
+  "version": "3.1.5",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -52,7 +52,7 @@
     "lib/**/*"
   ],
   "dependencies": {
-    "axios": "^1.7.4",
+    "axios": "^1.7.7",
     "base-x": "^5.0.0",
     "bignumber.js": "^9.1.2",
     "elliptic": "^6.5.7",
@@ -62,25 +62,25 @@
     "xrpl": "^4.0.0"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.17",
+    "@types/chai": "^4.3.19",
     "@types/chai-as-promised": "^7.1.8",
     "@types/lodash": "^4.17.7",
     "@types/mocha": "^10.0.7",
     "@types/nconf": "^0.10.7",
     "@types/node": "^20.14.15",
-    "@typescript-eslint/eslint-plugin": "^8.1.0",
-    "@typescript-eslint/parser": "^8.1.0",
+    "@typescript-eslint/eslint-plugin": "^8.4.0",
+    "@typescript-eslint/parser": "^8.4.0",
     "chai": "^4.5.0",
     "chai-as-promised": "^7.1.2",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-chai-friendly": "^1.0.1",
-    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-import": "^2.30.0",
     "eslint-plugin-n": "^17.10.2",
     "eslint-plugin-promise": "^7.1.0",
     "mocha": "^10.7.3",
     "nconf": "^0.12.1",
-    "ts-jest": "^29.2.4",
+    "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5"
   }