@bithomp/xrpl-api 3.7.2 → 3.7.4

package/lib/client.d.ts

@@ -1,4 +1,5 @@
 import { Connection, ConnectionOptions } from "./connection";
+import { LedgerIndex } from "./models/ledger";
 export * from "./ledger";
 export declare let feeCushion: number;
 export declare let logger: any;
@@ -21,3 +22,4 @@ export declare function connect(): Promise<void>;
 export declare function disconnect(): Promise<void>;
 export declare function getNativeCurrency(): string;
 export declare function findConnection(type?: string, url?: string, strongFilter?: boolean, hash?: string, networkID?: number): Connection | null;
+export declare function findConnectionByLedger(ledgerIndex?: LedgerIndex, ledgerHash?: string, networkID?: number): Connection | null;

package/lib/client.js

@@ -20,6 +20,7 @@ exports.connect = connect;
 exports.disconnect = disconnect;
 exports.getNativeCurrency = getNativeCurrency;
 exports.findConnection = findConnection;
+exports.findConnectionByLedger = findConnectionByLedger;
 const connection_1 = require("./connection");
 const common_1 = require("./common");
 __exportStar(require("./ledger"), exports);
@@ -149,6 +150,37 @@ function findConnection(type, url, strongFilter, hash, networkID) {
     connections = connections.sort(sortHelperConnections);
     return connections[0];
 }
+function findConnectionByLedger(ledgerIndex, ledgerHash, networkID) {
+    if (ledgerHash) {
+        return findConnection("history", undefined, false, undefined, networkID);
+    }
+    if (typeof ledgerIndex === "string" || ledgerIndex === undefined) {
+        return findConnection(undefined, undefined, false, undefined, networkID);
+    }
+    const availableConnections = clientConnections.filter((con) => {
+        if (!con.isConnected()) {
+            return false;
+        }
+        if (typeof networkID === "number" && typeof con.getNetworkID() === "number") {
+            if (con.getNetworkID() !== networkID) {
+                return false;
+            }
+        }
+        return con.isLedgerIndexPresent(ledgerIndex);
+    });
+    if (availableConnections.length === 0) {
+        return findConnection(undefined, undefined, false, undefined, networkID);
+    }
+    else if (availableConnections.length === 1) {
+        return availableConnections[0];
+    }
+    if (loadBalancing) {
+        const index = Math.floor(Math.random() * availableConnections.length);
+        return availableConnections[index];
+    }
+    const sortedConnections = availableConnections.sort(sortHelperConnections);
+    return sortedConnections[0];
+}
 function sortHelperConnections(a, b) {
     if (a.getLatencyMs() < b.getLatencyMs()) {
         return -1;

package/lib/connection.d.ts

@@ -57,6 +57,7 @@ declare class Connection extends EventEmitter {
     getLatencyMs(): number;
     getNetworkID(): number | undefined;
     isLedgerIndexAvailable(ledgerIndex: any): boolean;
+    isLedgerIndexPresent(ledgerIndex: any): boolean;
     private updateLatency;
     private reconnect;
     private removeClient;

package/lib/connection.js

@@ -102,8 +102,9 @@ class Connection extends events_1.EventEmitter {
                 url: this.url,
                 error: err?.message || err?.name || err,
             });
+            this.removeClient();
         }
-        this.connectionValidation();
+        this.connectionValidation("connect");
     }
     async disconnect() {
         this.logger?.debug({
@@ -125,7 +126,16 @@ class Connection extends events_1.EventEmitter {
         const result = await this._request(request, options);
         let validResponse = true;
         if (result?.error) {
-            if (result.error === "timeout") {
+            if (result.error === "slowDown" || result.error === "Unexpected server response: 429") {
+                this.logger?.debug({
+                    service: "Bithomp::XRPL::Connection",
+                    function: "request",
+                    url: this.url,
+                    error: `Received slowdown error, reconnecting...`,
+                });
+                validResponse = false;
+            }
+            else if (result.error === "timeout") {
                 const timeouts = this.latency.filter((info) => info.delta >= this.timeout).length;
                 if (timeouts >= 3) {
                     this.logger?.debug({
@@ -135,10 +145,9 @@ class Connection extends events_1.EventEmitter {
                         error: `Too many timeouts (${timeouts}) in last ${this.latency.length} requests, reconnecting...`,
                     });
                     validResponse = false;
-                    this.removeClient();
                 }
             }
-            else if (result.error.startsWith("websocket was closed")) {
+            else if (result.error.toLowerCase().startsWith("websocket was closed")) {
                 this.logger?.debug({
                     service: "Bithomp::XRPL::Connection",
                     function: "request",
@@ -146,11 +155,13 @@ class Connection extends events_1.EventEmitter {
                     error: "Websocket was closed, reconnecting...",
                 });
                 validResponse = false;
-                this.removeClient();
             }
         }
         if (validResponse) {
-            this.connectionValidation();
+            this.connectionValidation("request");
+        }
+        else {
+            this.removeClient();
         }
         return result;
     }
@@ -259,6 +270,24 @@ class Connection extends events_1.EventEmitter {
         }
         return true;
     }
+    isLedgerIndexPresent(ledgerIndex) {
+        if (typeof ledgerIndex !== "number") {
+            return true;
+        }
+        if (!this.serverInfo?.complete_ledgers) {
+            return false;
+        }
+        const completeLedgers = this.serverInfo.complete_ledgers.split("-");
+        if (completeLedgers.length !== 2) {
+            return true;
+        }
+        completeLedgers[0] = parseInt(completeLedgers[0], 10);
+        completeLedgers[1] = parseInt(completeLedgers[1], 10);
+        if (ledgerIndex < completeLedgers[0] || ledgerIndex > completeLedgers[1]) {
+            return false;
+        }
+        return true;
+    }
     updateLatency(delta) {
         this.latency.push({
             timestamp: new Date(),
@@ -276,7 +305,6 @@ class Connection extends events_1.EventEmitter {
         if (!this.shutdown) {
             this.emit("reconnect");
             try {
-                this.emit("disconnected", 1000);
                 this.removeClient();
                 this.resetTypes();
                 this.serverInfoUpdating = false;
@@ -293,15 +321,16 @@ class Connection extends events_1.EventEmitter {
                     error: e.message,
                 });
             }
-            this.connectionValidation();
+            this.connectionValidation("reconnect");
         }
     }
-    removeClient() {
+    removeClient(code = 1000) {
         try {
             if (this.client) {
                 this.client.removeAllListeners();
                 this.client.disconnect();
                 this.client = undefined;
+                this.emit("disconnected", code);
             }
         }
         catch (_err) {
@@ -327,9 +356,10 @@ class Connection extends events_1.EventEmitter {
                 code,
                 url: this.url,
             });
-            this.onlineSince = 0;
-            this.serverInfo = null;
-            this.streamsSubscribed = false;
+            if (this.client) {
+                this.client.removeAllListeners();
+                this.client = undefined;
+            }
             this.emit("disconnected", code);
         });
         this.client.on("error", (source, message, error) => {
@@ -351,7 +381,6 @@ class Connection extends events_1.EventEmitter {
                     error: err?.message || err?.name || err,
                 });
             }
-            this.connectionValidation();
         });
         this.client.on("ledgerClosed", (ledgerStream) => {
             this.onLedgerClosed(ledgerStream);
@@ -466,7 +495,7 @@ class Connection extends events_1.EventEmitter {
             request.accounts = accounts;
         }
         const result = await this.request(request, { skip_subscription_update: true });
-        if (result.result) {
+        if (result.result && !result.error) {
             this.streamsSubscribed = true;
         }
         return result;
@@ -510,7 +539,7 @@ class Connection extends events_1.EventEmitter {
         else {
             this.updateServerInfo();
         }
-        this.connectionValidation();
+        this.connectionValidation("ledgerClosed");
     }
     async updateServerInfo() {
         if (this.serverInfoUpdating || this.shutdown) {
@@ -538,10 +567,11 @@ class Connection extends events_1.EventEmitter {
         }
         this.serverInfoUpdating = false;
     }
-    connectionValidation() {
+    connectionValidation(event) {
         this.logger?.debug({
             service: "Bithomp::XRPL::Connection",
             function: "connectionValidation",
+            event,
             url: this.url,
             shutdown: this.shutdown,
         });
@@ -549,17 +579,16 @@ class Connection extends events_1.EventEmitter {
             clearTimeout(this.connectionWatchTimer);
             this.connectionWatchTimer = null;
         }
-        if (!this.shutdown) {
-            if (this.streamsSubscribed === false) {
-                this.subscribe();
-            }
-            if (this.serverInfo === null && this.isConnected()) {
-                this.updateServerInfo();
-            }
-            this.connectionWatchTimer = setTimeout(this.bindConnectionWatchTimeout, LEDGER_CLOSED_TIMEOUT);
-        }
-        else {
+        if (this.shutdown) {
             this.removeClient();
+            return;
+        }
+        this.connectionWatchTimer = setTimeout(this.bindConnectionWatchTimeout, LEDGER_CLOSED_TIMEOUT);
+        if (this.streamsSubscribed === false) {
+            this.subscribe();
+        }
+        if (this.serverInfo === null && this.isConnected()) {
+            this.updateServerInfo();
         }
     }
     async connectionWatchTimeout() {
@@ -582,7 +611,7 @@ class Connection extends events_1.EventEmitter {
                 url: this.url,
                 error: e.message,
             });
-            this.connectionValidation();
+            this.connectionValidation("connectionWatchTimeout");
         }
     }
 }

package/lib/ledger/ledger.js

@@ -40,7 +40,7 @@ const ledger_1 = require("../parse/ledger/ledger");
 const utils_1 = require("../common/utils");
 async function getLedger(options = {}) {
     const formatted = options.legacy === true || options.formatted === true;
-    const connection = options.connection || Client.findConnection("history");
+    const connection = options.connection || Client.findConnectionByLedger(options.ledgerIndex, options.ledgerHash);
     if (!connection) {
         throw new Error("There is no connection");
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "3.7.2",
+  "version": "3.7.4",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -42,7 +42,7 @@
     "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
     "lint": "eslint",
     "prepare": "npm run build",
-    "prepublishOnly": "npm test && npm run lint",
+    "-prepublishOnly": "npm test && npm run lint",
     "preversion": "npm run lint",
     "version": "npm run format && git add -A src",
     "postversion": "git push && git push --tags"
@@ -51,7 +51,7 @@
     "lib/**/*"
   ],
   "dependencies": {
-    "axios": "^1.13.1",
+    "axios": "^1.13.2",
     "base-x": "^5.0.1",
     "bignumber.js": "^9.3.1",
     "elliptic": "^6.6.1",
@@ -73,13 +73,13 @@
     "@typescript-eslint/parser": "^8.46.2",
     "chai": "^6.2.0",
     "chai-as-promised": "^8.0.2",
-    "eslint": "^9.39.0",
+    "eslint": "^9.39.1",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-chai-friendly": "^1.1.0",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-n": "^17.23.1",
     "eslint-plugin-promise": "^7.2.1",
-    "mocha": "^11.7.4",
+    "mocha": "^11.7.5",
     "nconf": "^0.13.0",
     "ts-jest": "^29.4.5",
     "ts-node": "^10.9.2",