@bithomp/xrpl-api 2.6.6 → 2.6.7

package/lib/ledger/account_objects.d.ts

@@ -1,4 +1,4 @@
-import { AccountObjectType, AccountObjectsResponse, AccountNFTObjectsResponse, AccountURITokensObjectsResponse } from "../models/account_object";
+import { AccountObjectType, AccountObjects, AccountNFTObjectsResponse, AccountURITokensObjectsResponse } from "../models/account_object";
 import { AccountLinesResponse } from "../models/account_lines";
 import { ErrorResponse } from "../models/base_model";
 import { LedgerIndex } from "../models/ledger";
@@ -9,11 +9,11 @@ export interface GetAccountObjectsOptions {
     limit?: number;
     marker?: string;
 }
-export declare function getAccountObjects(account: string, options?: GetAccountObjectsOptions): Promise<AccountObjectsResponse | ErrorResponse>;
+export declare function getAccountObjects(account: string, options?: GetAccountObjectsOptions): Promise<AccountObjects | ErrorResponse>;
 export interface GetAccountAllObjectsOptions extends GetAccountObjectsOptions {
     timeout?: number;
 }
-export declare function getAccountAllObjects(account: string, options?: GetAccountAllObjectsOptions): Promise<AccountObjectsResponse | ErrorResponse>;
+export declare function getAccountAllObjects(account: string, options?: GetAccountAllObjectsOptions): Promise<AccountObjects | ErrorResponse>;
 export interface GetAccountLinesObjectsOptions {
     ledgerHash?: string;
     ledgerIndex?: LedgerIndex;

package/lib/ledger/account_offers.d.ts

@@ -1,8 +1,13 @@
 import { LedgerIndex } from "../models/ledger";
 import { ErrorResponse } from "../models/base_model";
+import { FormattedAccountOrders } from "../parse/ledger/account-order";
+import { AccountOffers } from "../v1/common/types/commands/account_offers";
 export interface GetAccountOffers {
     ledgerIndex?: LedgerIndex;
     limit?: number;
     marker?: any;
+    legacy?: boolean;
+    formatted?: boolean;
 }
-export declare function getAccountOffers(account: string, options?: GetAccountOffers): Promise<object | ErrorResponse>;
+export declare function getAccountOffers(account: string, options?: GetAccountOffers): Promise<AccountOffers | FormattedAccountOrders | ErrorResponse>;
+export declare function getAccountAllOffers(account: string, options?: GetAccountOffers): Promise<AccountOffers | FormattedAccountOrders | ErrorResponse>;

package/lib/ledger/account_offers.js

@@ -22,11 +22,18 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAccountOffers = void 0;
+exports.getAccountAllOffers = exports.getAccountOffers = void 0;
+const lodash_1 = __importDefault(require("lodash"));
 const Client = __importStar(require("../client"));
 const utils_1 = require("../common/utils");
+const account_order_1 = require("../parse/ledger/account-order");
+const OFFERS_LIMIT_MAX = 400;
 async function getAccountOffers(account, options = {}) {
+    const formatted = options.legacy === true || options.formatted === true;
     const { hash, marker } = (0, utils_1.parseMarker)(options.marker);
     options.marker = marker;
     const connection = Client.findConnection(undefined, undefined, undefined, hash);
@@ -62,6 +69,61 @@ async function getAccountOffers(account, options = {}) {
     if (newMarker) {
         result.marker = newMarker;
     }
+    if (formatted === true) {
+        result.offers = formatResponse(account, result.offers);
+    }
     return result;
 }
 exports.getAccountOffers = getAccountOffers;
+async function getAccountAllOffers(account, options = {}) {
+    const limit = options.limit;
+    let response;
+    const accountOffers = [];
+    while (true) {
+        if (options.limit && limit) {
+            const left = limit - accountOffers.length;
+            const parts = Math.floor(left / OFFERS_LIMIT_MAX);
+            if (parts === 0) {
+                options.limit = left;
+            }
+            else {
+                options.limit = left;
+            }
+        }
+        response = await getAccountOffers(account, options);
+        if (response.error) {
+            return response;
+        }
+        accountOffers.push(...response.offers);
+        if (limit && accountOffers.length >= limit) {
+            response.limit = accountOffers.length;
+            break;
+        }
+        if (response.marker) {
+            options.marker = response.marker;
+        }
+        else {
+            break;
+        }
+    }
+    if (response.error) {
+        const { error, error_code, error_message, status, validated } = response;
+        return {
+            account,
+            error,
+            error_code,
+            error_message,
+            status,
+            validated,
+        };
+    }
+    response.offers = accountOffers;
+    return response;
+}
+exports.getAccountAllOffers = getAccountAllOffers;
+function formatResponse(address, offers) {
+    const orders = offers.map((offer) => {
+        return (0, account_order_1.parseAccountOrder)(address, offer);
+    });
+    return lodash_1.default.sortBy(orders, (order) => order.properties.sequence);
+}

package/lib/models/account_object.d.ts

@@ -3,7 +3,7 @@ import { Trustline } from "./account_lines";
 import { Amount } from "../v1/common/types/objects";
 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 interface AccountObjectsResponse {
+export interface AccountObjects {
     account: string;
     account_objects: AccountObject[];
     ledger_hash?: string;

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

@@ -1,4 +1,12 @@
 import { FormattedOfferCreateSpecification } from "../../v1/common/types/objects";
+export type FormattedAccountOrders = {
+    account: string;
+    offers?: FormattedAccountOrder[];
+    ledger_current_index?: number;
+    ledger_index?: number;
+    ledger_hash?: string;
+    marker?: unknown;
+};
 export type FormattedAccountOrder = {
     specification: FormattedOfferCreateSpecification;
     properties: {

package/lib/parse/outcome.js

@@ -84,11 +84,11 @@ function parseOutcome(tx, nativeCurrency, definitions) {
         timestamp: (0, utils_1.parseTimestamp)(tx.date),
         fee: (0, common_1.dropsToXrp)(tx.Fee),
         balanceChanges,
-        lockedBalanceChanges,
-        orderbookChanges,
+        lockedBalanceChanges: Object.keys(lockedBalanceChanges).length > 0 ? lockedBalanceChanges : undefined,
+        orderbookChanges: Object.keys(orderbookChanges).length > 0 ? orderbookChanges : undefined,
         channelChanges,
-        nftokenChanges,
-        nftokenOfferChanges,
+        nftokenChanges: Object.keys(nftokenChanges).length > 0 ? nftokenChanges : undefined,
+        nftokenOfferChanges: Object.keys(nftokenOfferChanges).length > 0 ? nftokenOfferChanges : undefined,
         uritokenChanges: Object.keys(uritokenChanges).length > 0 ? uritokenChanges : undefined,
         uritokenSellOfferChanges: Object.keys(uritokenSellOfferChanges).length > 0 ? uritokenSellOfferChanges : undefined,
         affectedObjects: affectedObjects ? (0, common_1.removeUndefined)(affectedObjects) : undefined,

package/lib/v1/common/types/commands/account_objects.d.ts

@@ -14,7 +14,7 @@ export interface AccountObjectsRequest {
     limit?: number;
     marker?: string;
 }
-export interface AccountObjectsResponse {
+export interface AccountObjects {
     account: string;
     account_objects: Array<CheckLedgerEntry | RippleStateLedgerEntry | OfferLedgerEntry | SignerListLedgerEntry | EscrowLedgerEntry | PayChannelLedgerEntry | DepositPreauthLedgerEntry>;
     ledger_hash?: string;

package/lib/v1/common/types/commands/account_offers.d.ts

@@ -1,4 +1,4 @@
-import { Amount } from "../objects";
+import { AccountOffer } from "xrpl";
 export interface AccountOffersRequest {
     account: string;
     ledger_hash?: string;
@@ -6,19 +6,11 @@ export interface AccountOffersRequest {
     limit?: number;
     marker?: any;
 }
-export interface AccountOffersResponse {
+export interface AccountOffers {
     account: string;
-    ledger_hash?: string;
+    offers?: AccountOffer[];
     ledger_current_index?: number;
     ledger_index?: number;
-    marker?: any;
-    offers?: AccountOffer[];
-}
-export interface AccountOffer {
-    seq: number;
-    flags: number;
-    taker_gets: Amount;
-    taker_pays: Amount;
-    quality: string;
-    expiration?: number;
+    ledger_hash?: string;
+    marker?: unknown;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "2.6.6",
+  "version": "2.6.7",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",