@bithomp/xrpl-api 3.1.6 → 3.1.8

package/lib/client.d.ts

@@ -18,6 +18,6 @@ export interface ClientConnection {
 }
 export declare function setup(servers: ClientConnection[], options?: ClientOptions): void;
 export declare function connect(): Promise<void>;
-export declare function disconnect(): 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;

package/lib/client.js

@@ -61,13 +61,13 @@ async function connect() {
         await connection.connect();
     }
 }
-function disconnect() {
+async function disconnect() {
     exports.logger?.debug({
         service: "Bithomp::XRPL::Client",
         function: "disconnect",
     });
     for (const connection of clientConnections) {
-        connection.disconnect();
+        await connection.disconnect();
     }
 }
 function getNativeCurrency() {

package/lib/common/utils.d.ts

@@ -3,6 +3,7 @@ export type SortDirection = -1 | 0 | 1;
 export declare function signum(num: number): SortDirection;
 export declare function compareTransactions(first: any, second: any): SortDirection;
 export declare function sleep(ms: number): Promise<void>;
+export declare function getTimestamp(): number;
 export declare function createMarker(hash: string, marker?: any): any;
 export declare function parseMarker(marker?: any): any;
 export declare function dropsToXrp(drops: BigNumber.Value): string;

package/lib/common/utils.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.signum = signum;
 exports.compareTransactions = compareTransactions;
 exports.sleep = sleep;
+exports.getTimestamp = getTimestamp;
 exports.createMarker = createMarker;
 exports.parseMarker = parseMarker;
 exports.dropsToXrp = dropsToXrp;
@@ -32,6 +33,9 @@ async function sleep(ms) {
         setTimeout(resolve, ms);
     });
 }
+function getTimestamp() {
+    return new Date().getTime();
+}
 function createMarker(hash, marker) {
     if (marker === undefined) {
         return undefined;

package/lib/connection.js

@@ -88,20 +88,26 @@ class Connection extends events_1.EventEmitter {
                 (request.command === "subscribe" || request.command === "unsubscribe")) {
                 return this.updateSubscriptions(request);
             }
-            if (!this.client || !this.isConnected()) {
-                return { error: "Not connected" };
+            const waitTime = (0, utils_1.getTimestamp)() + RECONNECT_TIMEOUT;
+            while ((!this.client || !this.isConnected())) {
+                await (0, utils_1.sleep)(100);
+                if (this.shutdown) {
+                    return { error: "shutdownConnection", error_message: "Connection is shutdown.", status: "error" };
+                }
+                if ((0, utils_1.getTimestamp)() > waitTime) {
+                    return { error: "notConnected", error_message: "Not connected.", status: "error" };
+                }
             }
-            const startDate = new Date();
+            const startTimestamp = (0, utils_1.getTimestamp)();
             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());
+            this.updateLatency((0, utils_1.getTimestamp)() - startTimestamp);
             return response;
         }
         catch (err) {
-            this.updateLatency(1000);
+            this.updateLatency(RECONNECT_TIMEOUT);
             this.logger?.debug({
                 service: "Bithomp::XRPL::Connection",
                 function: "request",
@@ -144,7 +150,7 @@ class Connection extends events_1.EventEmitter {
     }
     getOnlinePeriodMs() {
         if (this.isConnected()) {
-            return this.onlineSince ? new Date().getTime() - this.onlineSince : 0;
+            return this.onlineSince ? (0, utils_1.getTimestamp)() - this.onlineSince : 0;
         }
         return null;
     }
@@ -229,7 +235,7 @@ class Connection extends events_1.EventEmitter {
                 url: this.url,
             });
             this.emit("connected");
-            this.onlineSince = new Date().getTime();
+            this.onlineSince = (0, utils_1.getTimestamp)();
         });
         this.client.connection.on("disconnected", (code) => {
             this.logger?.debug({
@@ -273,6 +279,9 @@ class Connection extends events_1.EventEmitter {
         this.client.connection.on("validationReceived", (validation) => {
             this.emit("validationReceived", validation);
         });
+        this.client.connection.on("manifestReceived", (manifest) => {
+            this.emit("manifestReceived", manifest);
+        });
         this.client.connection.on("peerStatusChange", (status) => {
             this.emit("peerStatusChange", status);
         });
@@ -349,8 +358,11 @@ class Connection extends events_1.EventEmitter {
         return { status: "success" };
     }
     async subscribe(streams, accounts) {
+        if (this.shutdown) {
+            return { error: "shutdownConnection", error_message: "Connection is shutdown.", status: "error" };
+        }
         if (this.streamsSubscribed === true && streams === undefined && accounts === undefined) {
-            return null;
+            return { status: "success" };
         }
         streams = streams || Object.keys(this.streams);
         accounts = accounts || Object.keys(this.accounts);
@@ -383,7 +395,7 @@ class Connection extends events_1.EventEmitter {
         return await this.request(request, { skip_subscription_update: true });
     }
     onLedgerClosed(ledgerStream) {
-        const time = new Date().getTime();
+        const time = (0, utils_1.getTimestamp)();
         const ledgerTime = (0, ledger_1.ledgerTimeToTimestamp)(ledgerStream.ledger_time);
         if (ledgerTime < time) {
             this.updateLatency(time - ledgerTime);

package/lib/ledger/account_objects.d.ts

@@ -28,10 +28,17 @@ export interface GetAccountNFTOffersObjectsOptions {
     marker?: string;
 }
 export declare function getAccountNFTOffersObjects(account: string, options?: GetAccountNFTOffersObjectsOptions): Promise<AccountNFTObjectsResponse | ErrorResponse>;
+export interface GetAccountDepositPreauthObjectsOptions {
+    ledgerHash?: string;
+    ledgerIndex?: LedgerIndex;
+    limit?: number;
+    marker?: string;
+}
+export declare function getAccountDepositPreauthObjects(account: string, options?: GetAccountDepositPreauthObjectsOptions): Promise<any | ErrorResponse>;
 export interface GetAccountURITokensObjectsOptions {
     ledgerHash?: string;
     ledgerIndex?: LedgerIndex;
     limit?: number;
     marker?: string;
 }
-export declare function getAccountURITokensObjects(account: string, options?: GetAccountNFTOffersObjectsOptions): Promise<AccountURITokensObjectsResponse | ErrorResponse>;
+export declare function getAccountURITokensObjects(account: string, options?: GetAccountURITokensObjectsOptions): Promise<AccountURITokensObjectsResponse | ErrorResponse>;

package/lib/ledger/account_objects.js

@@ -27,6 +27,7 @@ exports.getAccountObjects = getAccountObjects;
 exports.getAccountAllObjects = getAccountAllObjects;
 exports.getAccountLinesObjects = getAccountLinesObjects;
 exports.getAccountNFTOffersObjects = getAccountNFTOffersObjects;
+exports.getAccountDepositPreauthObjects = getAccountDepositPreauthObjects;
 exports.getAccountURITokensObjects = getAccountURITokensObjects;
 const Client = __importStar(require("../client"));
 const account_object_1 = require("../models/account_object");
@@ -78,7 +79,8 @@ async function getAccountObjects(account, options = {}) {
 }
 async function getAccountAllObjects(account, options = {}) {
     const loadOptions = { ...options };
-    loadOptions.connection = loadOptions.connection || Client.findConnection("account_objects", undefined, undefined);
+    loadOptions.connection =
+        loadOptions.connection || Client.findConnection("account_objects", undefined, undefined);
     const timeStart = new Date();
     const limit = loadOptions.limit;
     let response;
@@ -127,7 +129,7 @@ async function getAccountAllObjects(account, options = {}) {
         };
     }
     response.account_objects = accountObjects;
-    if (!options.hasOwnProperty("limit")) {
+    if (!options.hasOwnProperty("limit") || options.limit === undefined) {
         delete response.limit;
     }
     return response;
@@ -172,8 +174,22 @@ async function getAccountNFTOffersObjects(account, options = {}) {
         nft_offers: nftOffers,
     };
 }
+async function getAccountDepositPreauthObjects(account, options = {}) {
+    const response = await getAccountAllObjects(account, {
+        type: "deposit_preauth",
+        ledgerHash: options.ledgerHash,
+        ledgerIndex: options.ledgerIndex,
+        limit: options.limit,
+        marker: options.marker,
+    });
+    if ("error" in response) {
+        return response;
+    }
+    return response;
+}
 async function getAccountURITokensObjects(account, options = {}) {
     const response = await getAccountAllObjects(account, {
+        type: "uri_token",
         ledgerHash: options.ledgerHash,
         ledgerIndex: options.ledgerIndex,
         limit: options.limit,
@@ -183,12 +199,12 @@ async function getAccountURITokensObjects(account, options = {}) {
         return response;
     }
     const accountObjects = response.account_objects;
-    const uriTokens = (0, account_object_1.accountObjectsToURITokens)(accountObjects);
+    const uritokens = (0, account_object_1.accountObjectsToURITokens)(accountObjects);
     return {
         account: response.account,
         ledger_hash: response.ledger_hash,
         ledger_index: response.ledger_index,
         validated: response.validated,
-        uritokens: uriTokens,
+        uritokens: uritokens,
     };
 }

package/lib/ledger/transaction.js

@@ -387,7 +387,7 @@ async function waitForFinalTransactionOutcome(txHash, lastLedger) {
     await (0, utils_1.sleep)(LEDGER_CLOSE_TIME_AWAIT);
     const tx = await getTransaction(txHash);
     const error = tx?.error;
-    if (error === "Not connected") {
+    if (error === "notConnected") {
         return tx;
     }
     if (!tx || error === "txnNotFound" || tx.validated !== true) {

package/lib/models/account_object.d.ts

@@ -2,7 +2,7 @@ import { LedgerEntry } from "xrpl";
 import { Trustline } from "./account_lines";
 import { Amount } from "../types";
 export type AccountObject = LedgerEntry.Check | LedgerEntry.DepositPreauth | LedgerEntry.Escrow | LedgerEntry.Offer | LedgerEntry.PayChannel | LedgerEntry.SignerList | LedgerEntry.Ticket | LedgerEntry.RippleState;
-export type AccountObjectType = "check" | "escrow" | "offer" | "payment_channel" | "signer_list" | "state" | "ticket" | "nft_offer";
+export type AccountObjectType = Exclude<LedgerEntry.LedgerEntryFilter, "amendments" | "fee" | "hashes"> | "uri_token";
 export interface AccountObjects {
     account: string;
     account_objects: AccountObject[];

package/lib/models/account_object.js

@@ -70,7 +70,7 @@ function accountObjectsToURITokens(accountObjects) {
     const uriTokenObjects = accountObjects.filter((obj) => {
         return obj.LedgerEntryType === "URIToken";
     });
-    const uriTokens = uriTokenObjects.map((obj) => {
+    const uritokens = uriTokenObjects.map((obj) => {
         return (0, common_1.removeUndefined)({
             flags: obj.Flags,
             index: obj.index,
@@ -84,5 +84,5 @@ function accountObjectsToURITokens(accountObjects) {
             transaction_hash: obj.PreviousTxnID,
         });
     });
-    return uriTokens;
+    return uritokens;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "3.1.6",
+  "version": "3.1.8",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -76,7 +76,7 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-chai-friendly": "^1.0.1",
     "eslint-plugin-import": "^2.30.0",
-    "eslint-plugin-n": "^17.10.2",
+    "eslint-plugin-n": "^17.10.3",
     "eslint-plugin-promise": "^7.1.0",
     "mocha": "^10.7.3",
     "nconf": "^0.12.1",