@bithomp/xrpl-api 2.6.6 → 2.7.0

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/ledger/transaction.d.ts

@@ -26,7 +26,7 @@ interface LegacyPaymentInterface {
     destinationValue: string;
     destinationCurrency: string;
     networkID?: number;
-    memos: FormattedMemo[];
+    memos?: FormattedMemo[];
     secret: string;
     fee?: string;
 }

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/escrow_changes.d.ts

@@ -0,0 +1,13 @@
+import { FormattedSourceAddress, FormattedDestinationAddress } from "../../v1/common/types/objects/account";
+declare function parseEscrowChanges(tx: any): {
+    status: string | undefined;
+    escrowIndex: any;
+    escrowSequence: any;
+    amount: any;
+    condition: any;
+    source: FormattedSourceAddress;
+    destination: FormattedDestinationAddress;
+    allowCancelAfter: string | undefined;
+    allowExecuteAfter: string | undefined;
+} | undefined;
+export { parseEscrowChanges };

package/lib/parse/outcome/escrow_changes.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseEscrowChanges = void 0;
+const common_1 = require("../../common");
+const utils_1 = require("../../v1/common/utils");
+const utils_2 = require("../utils");
+function parseEscrowStatus(tx, node) {
+    if (node.diffType === "CreatedNode") {
+        return "created";
+    }
+    if (node.diffType === "DeletedNode") {
+        if (tx.TransactionType === "EscrowCancel") {
+            return "cancelled";
+        }
+        if (tx.TransactionType === "EscrowFinish") {
+            return "executed";
+        }
+        return "deleted";
+    }
+    return undefined;
+}
+function parseEscrowSequence(tx) {
+    if (tx.TransactionType === "EscrowCreate") {
+        return tx.Sequence || tx.TicketSequence;
+    }
+    if (tx.TransactionType === "EscrowCancel" || tx.TransactionType === "EscrowFinish") {
+        return tx.OfferSequence;
+    }
+    return undefined;
+}
+function summarizeEscrow(tx, node) {
+    const final = node.diffType === "CreatedNode" ? node.newFields : node.finalFields;
+    const source = {
+        address: final.Account,
+        tag: final.SourceTag,
+    };
+    const destination = {
+        address: final.Destination,
+        tag: final.DestinationTag,
+    };
+    const summary = (0, common_1.removeUndefined)({
+        status: parseEscrowStatus(tx, node),
+        escrowIndex: node.ledgerIndex,
+        escrowSequence: parseEscrowSequence(tx),
+        amount: final.Amount,
+        condition: final.Condition,
+        source: (0, common_1.removeUndefined)(source),
+        destination: (0, common_1.removeUndefined)(destination),
+        allowCancelAfter: (0, utils_2.parseTimestamp)(final.CancelAfter),
+        allowExecuteAfter: (0, utils_2.parseTimestamp)(final.FinishAfter),
+    });
+    return summary;
+}
+function parseEscrowChanges(tx) {
+    const escrows = (0, utils_1.normalizeNodes)(tx.meta).filter((n) => {
+        return n.entryType === "Escrow";
+    });
+    return escrows.length === 1 ? summarizeEscrow(tx, escrows[0]) : undefined;
+}
+exports.parseEscrowChanges = parseEscrowChanges;

package/lib/parse/outcome/index.d.ts

@@ -9,3 +9,4 @@ export { parseChannelChanges } from "./channel_changes";
 export { parseOrderbookChanges } from "./orderbook_changes";
 export { parseHooksExecutions } from "./hooks_executions";
 export { parseEmittedTxns } from "./emitted_txns";
+export { parseEscrowChanges } from "./escrow_changes";

package/lib/parse/outcome/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseEmittedTxns = exports.parseHooksExecutions = exports.parseOrderbookChanges = exports.parseChannelChanges = exports.parseLockedBalanceChanges = exports.parseBalanceChanges = exports.parseURITokenSellOfferChanges = exports.parseURITokenChanges = exports.parseNFTokenOfferChanges = exports.parseNFTokenChanges = exports.parseAffectedObjects = void 0;
+exports.parseEscrowChanges = exports.parseEmittedTxns = exports.parseHooksExecutions = exports.parseOrderbookChanges = exports.parseChannelChanges = exports.parseLockedBalanceChanges = exports.parseBalanceChanges = exports.parseURITokenSellOfferChanges = exports.parseURITokenChanges = exports.parseNFTokenOfferChanges = exports.parseNFTokenChanges = exports.parseAffectedObjects = void 0;
 var affected_objects_1 = require("./affected_objects");
 Object.defineProperty(exports, "parseAffectedObjects", { enumerable: true, get: function () { return affected_objects_1.parseAffectedObjects; } });
 var nftoken_changes_1 = require("./nftoken_changes");
@@ -23,3 +23,5 @@ var hooks_executions_1 = require("./hooks_executions");
 Object.defineProperty(exports, "parseHooksExecutions", { enumerable: true, get: function () { return hooks_executions_1.parseHooksExecutions; } });
 var emitted_txns_1 = require("./emitted_txns");
 Object.defineProperty(exports, "parseEmittedTxns", { enumerable: true, get: function () { return emitted_txns_1.parseEmittedTxns; } });
+var escrow_changes_1 = require("./escrow_changes");
+Object.defineProperty(exports, "parseEscrowChanges", { enumerable: true, get: function () { return escrow_changes_1.parseEscrowChanges; } });

package/lib/parse/outcome.js

@@ -69,6 +69,7 @@ function parseOutcome(tx, nativeCurrency, definitions) {
     const lockedBalanceChanges = (0, index_1.parseLockedBalanceChanges)(metadata);
     const orderbookChanges = (0, index_1.parseOrderbookChanges)(metadata);
     const channelChanges = (0, index_1.parseChannelChanges)(metadata);
+    const escrowChanges = (0, index_1.parseEscrowChanges)(tx);
     const nftokenChanges = (0, index_1.parseNFTokenChanges)(tx);
     const nftokenOfferChanges = (0, index_1.parseNFTokenOfferChanges)(tx);
     const uritokenChanges = (0, index_1.parseURITokenChanges)(tx);
@@ -84,11 +85,12 @@ 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,
+        escrowChanges,
+        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/parse/specification/escrow-cancel.js

@@ -31,10 +31,15 @@ const common_1 = require("../../common");
 const memos_1 = __importDefault(require("../ledger/memos"));
 function parseEscrowCancel(tx) {
     assert.ok(tx.TransactionType === "EscrowCancel");
+    const source = {
+        address: tx.Account,
+        tag: tx.SourceTag,
+    };
     return (0, common_1.removeUndefined)({
-        memos: (0, memos_1.default)(tx),
+        source: (0, common_1.removeUndefined)(source),
         owner: tx.Owner,
         escrowSequence: tx.OfferSequence,
+        memos: (0, memos_1.default)(tx),
     });
 }
 exports.default = parseEscrowCancel;

package/lib/parse/specification/escrow-create.js

@@ -28,20 +28,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const assert = __importStar(require("assert"));
 const common_1 = require("../../common");
-const ripple_amount_1 = __importDefault(require("../ledger/ripple-amount"));
 const utils_1 = require("../utils");
 const memos_1 = __importDefault(require("../ledger/memos"));
 function parseEscrowCreation(tx) {
     assert.ok(tx.TransactionType === "EscrowCreate");
+    const source = {
+        address: tx.Account,
+        tag: tx.SourceTag,
+    };
+    const destination = {
+        address: tx.Destination,
+        tag: tx.DestinationTag,
+    };
     return (0, common_1.removeUndefined)({
-        amount: (0, ripple_amount_1.default)(tx.Amount),
-        destination: tx.Destination,
-        memos: (0, memos_1.default)(tx),
+        amount: tx.Amount,
+        source: (0, common_1.removeUndefined)(source),
+        destination: (0, common_1.removeUndefined)(destination),
         condition: tx.Condition,
         allowCancelAfter: (0, utils_1.parseTimestamp)(tx.CancelAfter),
         allowExecuteAfter: (0, utils_1.parseTimestamp)(tx.FinishAfter),
-        sourceTag: tx.SourceTag,
-        destinationTag: tx.DestinationTag,
+        memos: (0, memos_1.default)(tx),
     });
 }
 exports.default = parseEscrowCreation;

package/lib/parse/specification/escrow-finish.js

@@ -31,12 +31,17 @@ const common_1 = require("../../common");
 const memos_1 = __importDefault(require("../ledger/memos"));
 function parseEscrowFinish(tx) {
     assert.ok(tx.TransactionType === "EscrowFinish");
+    const source = {
+        address: tx.Account,
+        tag: tx.SourceTag,
+    };
     return (0, common_1.removeUndefined)({
-        memos: (0, memos_1.default)(tx),
+        source: (0, common_1.removeUndefined)(source),
         owner: tx.Owner,
         escrowSequence: tx.OfferSequence,
         condition: tx.Condition,
         fulfillment: tx.Fulfillment,
+        memos: (0, memos_1.default)(tx),
     });
 }
 exports.default = parseEscrowFinish;

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/lib/v1/common/types/objects/escrows.d.ts

@@ -1,19 +1,21 @@
 import { FormattedBaseSpecification } from "./specification";
-import { FormattedAmount } from "../../../../types";
+import { Amount } from "../../../../types";
+import { FormattedSourceAddress, FormattedDestinationAddress } from "./account";
 export type FormattedEscrowCancelSpecification = {
+    source: FormattedSourceAddress;
     owner: string;
     escrowSequence: number;
 } & FormattedBaseSpecification;
 export type FormattedEscrowCreateSpecification = {
-    amount?: FormattedAmount;
-    destination: string;
+    amount?: Amount;
+    source: FormattedSourceAddress;
+    destination: FormattedDestinationAddress;
     condition: string;
     allowCancelAfter?: string;
     allowExecuteAfter?: string;
-    sourceTag?: number;
-    destinationTag?: number;
 } & FormattedBaseSpecification;
 export type FormattedEscrowFinishSpecification = {
+    source: FormattedSourceAddress;
     owner: string;
     escrowSequence: number;
     condition?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "2.6.6",
+  "version": "2.7.0",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -47,7 +47,7 @@
     "lib/**/*"
   ],
   "dependencies": {
-    "axios": "^1.6.1",
+    "axios": "^1.6.2",
     "base-x": "^4.0.0",
     "bignumber.js": "^9.1.2",
     "elliptic": "^6.5.4",
@@ -63,8 +63,8 @@
     "@types/mocha": "^10.0.4",
     "@types/nconf": "^0.10.6",
     "@types/node": "^20.9.0",
-    "@typescript-eslint/eslint-plugin": "^6.10.0",
-    "@typescript-eslint/parser": "^6.10.0",
+    "@typescript-eslint/eslint-plugin": "^6.11.0",
+    "@typescript-eslint/parser": "^6.11.0",
     "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
     "mocha": "^10.2.0",