@bithomp/xrpl-api 3.1.7 → 3.1.9

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/connection.js

@@ -279,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);
         });
@@ -355,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);

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/account_tx.js

@@ -107,28 +107,29 @@ async function getTransactions(account, options = { limit: DEFAULT_LIMIT }) {
 async function findTransactions(account, options = { limit: DEFAULT_LIMIT, timeout: 15000 }) {
     let transactions = [];
     let accountTransactionsError = null;
-    const formatted = options.legacy === true || options.formatted === true;
     const timeStart = new Date();
-    options.binary = false;
-    applyLimitOptions(options);
-    await applyStartTxOptions(options);
-    while (transactions.length !== options.limit) {
+    const loadOptions = { ...options };
+    const formatted = loadOptions.legacy === true || loadOptions.formatted === true;
+    loadOptions.binary = false;
+    applyLimitOptions(loadOptions);
+    await applyStartTxOptions(loadOptions);
+    while (transactions.length !== loadOptions.limit) {
         const currentTime = new Date();
-        if (options.timeout && currentTime.getTime() - timeStart.getTime() > options.timeout) {
+        if (loadOptions.timeout && currentTime.getTime() - timeStart.getTime() > loadOptions.timeout) {
             break;
         }
-        let limit = options.limit;
-        if (transactions.length === 0 && options.startTxHash) {
+        let limit = loadOptions.limit;
+        if (transactions.length === 0 && loadOptions.startTxHash) {
             limit += LIMIT_INCREASE_COUNT;
         }
-        if (options.sourceTag || options.destinationTag) {
+        if (loadOptions.sourceTag || loadOptions.destinationTag) {
             limit += LIMIT_INCREASE_COUNT;
         }
         if (limit > MAX_LIMIT) {
             limit = MAX_LIMIT;
         }
         const accountTransactions = await getTransactions(account, {
-            ...options,
+            ...loadOptions,
             ...{ balanceChanges: false, specification: false, limit },
         });
         if (!accountTransactions || accountTransactions.error) {
@@ -136,16 +137,16 @@ async function findTransactions(account, options = { limit: DEFAULT_LIMIT, timeo
             break;
         }
         let newTransactions = accountTransactions.transactions;
-        options.marker = accountTransactions.marker;
+        loadOptions.marker = accountTransactions.marker;
         newTransactions = newTransactions
-            .filter(lodash_1.default.partial(filterHelperTransactions, account, options))
-            .filter(lodash_1.default.partial(filterHelperStartTx, options));
-        if (formatted !== true && (options.balanceChanges === true || options.specification === true)) {
+            .filter(lodash_1.default.partial(filterHelperTransactions, account, loadOptions))
+            .filter(lodash_1.default.partial(filterHelperStartTx, loadOptions));
+        if (formatted !== true && (loadOptions.balanceChanges === true || loadOptions.specification === true)) {
             for (const newTransaction of newTransactions) {
-                if (options.balanceChanges === true) {
+                if (loadOptions.balanceChanges === true) {
                     newTransaction.balanceChanges = (0, xrpl_1.getBalanceChanges)(newTransaction.meta);
                 }
-                if (options.specification === true) {
+                if (loadOptions.specification === true) {
                     const details = (0, transaction_1.getAccountTxDetails)(newTransaction, true);
                     newTransaction.specification = details.specification;
                     newTransaction.outcome = details.outcome;
@@ -154,23 +155,23 @@ async function findTransactions(account, options = { limit: DEFAULT_LIMIT, timeo
             }
         }
         transactions = transactions.concat(newTransactions);
-        transactions = transactions.slice(0, options.limit);
-        if (options.marker === undefined) {
+        transactions = transactions.slice(0, loadOptions.limit);
+        if (loadOptions.marker === undefined) {
             break;
         }
     }
     if (accountTransactionsError && transactions.length === 0) {
         return accountTransactionsError;
     }
-    if (options.marker && transactions.length === 0) {
+    if (loadOptions.marker && transactions.length === 0) {
         return {
             status: "timeout",
             error: "searchTimeout",
-            marker: options.marker,
+            marker: loadOptions.marker,
         };
     }
     if (formatted === true) {
-        transactions = transactions.map((transaction) => (0, transaction_1.getAccountTxDetails)(transaction, options.includeRawTransactions === true));
+        transactions = transactions.map((transaction) => (0, transaction_1.getAccountTxDetails)(transaction, loadOptions.includeRawTransactions === true));
     }
     return transactions;
 }

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.7",
+  "version": "3.1.9",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",