@bithomp/xrpl-api 3.2.18 → 3.2.20

package/lib/ledger/fee.js

@@ -32,9 +32,12 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getFee = getFee;
-const bignumber_js_1 = require("bignumber.js");
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
 const ripple_binary_codec_1 = require("ripple-binary-codec");
 const Client = __importStar(require("../client"));
 const common_1 = require("../common");
@@ -58,9 +61,9 @@ async function getFee(options = {}) {
     if (!openLedgerFee) {
         return null;
     }
-    const fee = new bignumber_js_1.BigNumber(openLedgerFee)
+    const fee = new bignumber_js_1.default(openLedgerFee)
         .multipliedBy(Client.feeCushion)
         .dividedBy(common_1.dropsInXRP)
-        .decimalPlaces(6, bignumber_js_1.BigNumber.ROUND_UP);
+        .decimalPlaces(6, bignumber_js_1.default.ROUND_UP);
     return fee.toString();
 }

package/lib/ledger/gateway_balances.js

@@ -106,7 +106,7 @@ function ObligationToObligationTrustline(account, value, currency) {
     return {
         account,
         currency,
-        balance: new bignumber_js_1.default(-value).toString(),
+        balance: new bignumber_js_1.default(value).times(-1).toString(),
         limit: "0",
         limit_peer: "0",
         quality_in: 0,

package/lib/models/book_offers.js

@@ -30,7 +30,7 @@ function alignOrder(base, order) {
 function formatBidsAndAsks(orderbook, offers) {
     const orders = offers
         .sort((a, b) => {
-        return new bignumber_js_1.default(a.quality).comparedTo(b.quality);
+        return new bignumber_js_1.default(a.quality).comparedTo(b.quality) ?? 0;
     })
         .map(orderbook_order_1.parseOrderbookOrder);
     const alignedOrders = orders.map(lodash_1.default.partial(alignOrder, orderbook.base));

package/lib/parse/ledger/account-order.js

@@ -9,22 +9,24 @@ const xrpl_1 = require("xrpl");
 const amount_1 = __importDefault(require("./amount"));
 const utils_1 = require("../utils");
 const common_1 = require("../../common");
+const offer_flags_1 = __importDefault(require("../ledger/offer-flags"));
 function computeQuality(takerGets, takerPays) {
     const quotient = new bignumber_js_1.default(takerPays.value).dividedBy(takerGets.value);
     return quotient.precision(16, bignumber_js_1.default.ROUND_HALF_UP).toString();
 }
 function parseAccountOrder(address, order) {
-    const direction = (order.flags & xrpl_1.LedgerEntry.OfferFlags.lsfSell) === 0 ? "buy" : "sell";
+    const flags = (0, offer_flags_1.default)(order.flags);
     const takerGetsAmount = (0, amount_1.default)(order.taker_gets);
     const takerPaysAmount = (0, amount_1.default)(order.taker_pays);
-    const quantity = direction === "buy" ? takerPaysAmount : takerGetsAmount;
-    const totalPrice = direction === "buy" ? takerGetsAmount : takerPaysAmount;
+    const quantity = flags.sell === true ? takerGetsAmount : takerPaysAmount;
+    const totalPrice = flags.sell === true ? takerPaysAmount : takerGetsAmount;
     const specification = (0, common_1.removeUndefined)({
-        direction: direction,
+        flags: flags,
         quantity: quantity,
         totalPrice: totalPrice,
-        passive: (order.flags & xrpl_1.LedgerEntry.OfferFlags.lsfPassive) !== 0 || undefined,
         expirationTime: (0, utils_1.parseTimestamp)(order.expiration),
+        direction: (order.flags & xrpl_1.LedgerEntry.OfferFlags.lsfSell) === 0 ? "buy" : "sell",
+        passive: (order.flags & xrpl_1.LedgerEntry.OfferFlags.lsfPassive) !== 0 || undefined,
     });
     const makerExchangeRate = order.quality
         ? (0, utils_1.adjustQualityForXRP)(order.quality.toString(), takerGetsAmount.currency, takerPaysAmount.currency)

package/lib/parse/ledger/amount.js

@@ -9,7 +9,7 @@ function parseAmount(amount) {
             value: (0, common_1.dropsToXrp)(amount),
         };
     }
-    if ("value" in amount && "currency" in amount && "issuer" in amount) {
+    if (amount && "value" in amount && "currency" in amount && "issuer" in amount) {
         return {
             issuer: amount.issuer,
             currency: amount.currency,

package/lib/parse/ledger/offer-create-flags.d.ts

@@ -0,0 +1,5 @@
+import { OfferCreateFlagsKeysInterface } from "../../types/offers";
+declare function parseOfferCreateFlags(value: number, options?: {
+    excludeFalse?: boolean;
+}): OfferCreateFlagsKeysInterface;
+export default parseOfferCreateFlags;

package/lib/parse/ledger/offer-create-flags.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const offers_1 = require("../../types/offers");
+const flags_1 = require("./flags");
+function parseOfferCreateFlags(value, options = {}) {
+    return (0, flags_1.parseFlags)(value, offers_1.OfferCreateFlagsKeys, options);
+}
+exports.default = parseOfferCreateFlags;

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

@@ -1,4 +1,4 @@
-import { Amount, OfferLedgerEntry, FormattedIssuedCurrencyAmount, FormattedOfferCreateSpecification } from "../../types";
+import { Amount, OfferLedgerEntry, IssuedCurrencyAmount, FormattedOfferCreateSpecification } from "../../types";
 export interface BookOffer extends OfferLedgerEntry {
     quality?: string;
     owner_funds?: string;
@@ -13,8 +13,8 @@ export type FormattedOrderbookOrder = {
         makerExchangeRate: string;
     };
     state?: {
-        fundedAmount?: FormattedIssuedCurrencyAmount;
-        priceOfFundedAmount?: FormattedIssuedCurrencyAmount;
+        fundedAmount?: IssuedCurrencyAmount;
+        priceOfFundedAmount?: IssuedCurrencyAmount;
     };
     data: BookOffer;
 };

package/lib/parse/ledger/orderbook-order.js

@@ -9,23 +9,25 @@ const xrpl_1 = require("xrpl");
 const utils_1 = require("../utils");
 const common_1 = require("../../common");
 const amount_1 = __importDefault(require("./amount"));
+const offer_flags_1 = __importDefault(require("../ledger/offer-flags"));
 function parseOrderbookOrder(data) {
-    const direction = (data.Flags & xrpl_1.LedgerEntry.OfferFlags.lsfSell) === 0 ? "buy" : "sell";
-    const takerGetsAmount = (0, amount_1.default)(data.TakerGets);
-    const takerPaysAmount = (0, amount_1.default)(data.TakerPays);
-    const quantity = direction === "buy" ? takerPaysAmount : takerGetsAmount;
-    const totalPrice = direction === "buy" ? takerGetsAmount : takerPaysAmount;
+    const flags = (0, offer_flags_1.default)(data.Flags);
+    const takerGets = (0, amount_1.default)(data.TakerGets);
+    const takerPays = (0, amount_1.default)(data.TakerPays);
+    const quantity = flags.sell === true ? takerGets : takerPays;
+    const totalPrice = flags.sell === true ? takerPays : takerGets;
     const specification = (0, common_1.removeUndefined)({
-        direction: direction,
+        flags: flags,
         quantity: quantity,
         totalPrice: totalPrice,
-        passive: (data.Flags & xrpl_1.LedgerEntry.OfferFlags.lsfPassive) !== 0 || undefined,
         expirationTime: (0, utils_1.parseTimestamp)(data.Expiration),
+        direction: (data.Flags & xrpl_1.LedgerEntry.OfferFlags.lsfSell) === 0 ? "buy" : "sell",
+        passive: (data.Flags & xrpl_1.LedgerEntry.OfferFlags.lsfPassive) !== 0 || undefined,
     });
     const properties = {
         maker: data.Account,
         sequence: data.Sequence,
-        makerExchangeRate: (0, utils_1.adjustQualityForXRP)(data.quality, takerGetsAmount.currency, takerPaysAmount.currency),
+        makerExchangeRate: (0, utils_1.adjustQualityForXRP)(data.quality, takerGets.currency, takerPays.currency),
     };
     const takerGetsFunded = data.taker_gets_funded ? (0, amount_1.default)(data.taker_gets_funded) : undefined;
     const takerPaysFunded = data.taker_pays_funded ? (0, amount_1.default)(data.taker_pays_funded) : undefined;

package/lib/parse/outcome/mptoken_changes.js

@@ -1,7 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseMPTokenChanges = parseMPTokenChanges;
-const bignumber_js_1 = require("bignumber.js");
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
 const common_1 = require("../../common");
 function parseMPTokenChanges(tx) {
     return new MPTokenChanges(tx).call();
@@ -51,7 +54,7 @@ class MPTokenChanges {
                 if (affectedNode.ModifiedNode) {
                     const mptIssuanceID = node.FinalFields.MPTokenIssuanceID;
                     const account = node.FinalFields.Account;
-                    let amountChange = new bignumber_js_1.BigNumber(node.FinalFields.MPTAmount ?? 0)
+                    let amountChange = new bignumber_js_1.default(node.FinalFields.MPTAmount ?? 0)
                         .minus(node.PreviousFields.MPTAmount ?? 0)
                         .toString();
                     if (amountChange === "0") {

package/lib/parse/outcome/mptoken_issuance_changes.js

@@ -1,7 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseMPTokenIssuanceChanges = parseMPTokenIssuanceChanges;
-const bignumber_js_1 = require("bignumber.js");
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
 const common_1 = require("../../common");
 const mptoken_1 = require("../../models/mptoken");
 function parseMPTokenIssuanceChanges(tx) {
@@ -52,7 +55,7 @@ class MPTokenIssuanceChanges {
                 }
                 if (affectedNode.ModifiedNode) {
                     const mptIssuanceID = (0, mptoken_1.buildMPTokenIssuanceID)(node.FinalFields.Sequence, node.FinalFields.Issuer);
-                    let outstandingAmountChange = new bignumber_js_1.BigNumber(node.FinalFields.OutstandingAmount ?? 0)
+                    let outstandingAmountChange = new bignumber_js_1.default(node.FinalFields.OutstandingAmount ?? 0)
                         .minus(node.PreviousFields.OutstandingAmount ?? 0)
                         .toString();
                     if (outstandingAmountChange === "0") {

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

@@ -1,12 +1,15 @@
 import { TransactionMetadata } from "xrpl";
+import { OfferFlagsKeysInterface } from "../../types";
 type OfferDescription = {
-    direction: string;
+    flags: OfferFlagsKeysInterface;
+    account?: string;
     quantity: any;
     totalPrice: any;
     sequence: number;
     status?: string;
     makerExchangeRate: string;
     expirationTime?: string;
+    direction: string;
 };
 type Orderbook = {
     [key: string]: OfferDescription[];

package/lib/parse/outcome/orderbook_changes.js

@@ -5,31 +5,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseOrderbookChanges = parseOrderbookChanges;
 const lodash_1 = __importDefault(require("lodash"));
-const bignumber_js_1 = require("bignumber.js");
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const BigNumber = bignumber_js_1.default.clone({ DECIMAL_PLACES: 40 });
 const xrpl_1 = require("xrpl");
-const BigNumber = bignumber_js_1.BigNumber.clone({ DECIMAL_PLACES: 40 });
 const common_1 = require("../../common");
 const models_1 = require("../../models");
 const utils_1 = require("../utils");
 const orderbook_quality_1 = require("./orderbook_quality");
 const currency_amount_1 = __importDefault(require("../ledger/currency-amount"));
+const offer_flags_1 = __importDefault(require("../ledger/offer-flags"));
 const client_1 = require("../../client");
-function convertOrderChange(order) {
-    const takerGets = order.taker_gets;
-    const takerPays = order.taker_pays;
-    const direction = order.sell ? "sell" : "buy";
-    const quantity = direction === "buy" ? takerPays : takerGets;
-    const totalPrice = direction === "buy" ? takerGets : takerPays;
-    return (0, common_1.removeUndefined)({
-        direction: direction,
-        quantity: quantity,
-        totalPrice: totalPrice,
-        sequence: order.sequence,
-        status: order.status,
-        makerExchangeRate: order.quality,
-        expirationTime: order.expiration,
-    });
-}
 function getExpirationTime(node) {
     const expirationTime = (node.finalFields.Expiration || node.newFields.Expiration);
     if (expirationTime === undefined) {
@@ -83,14 +68,18 @@ function parseChangeAmount(node, type) {
     return lodash_1.default.assign({}, finalAmount, { value: value });
 }
 function parseOrderChange(node) {
-    const orderChange = convertOrderChange({
-        taker_pays: parseChangeAmount(node, "TakerPays"),
-        taker_gets: parseChangeAmount(node, "TakerGets"),
-        sell: (node.finalFields.Flags & xrpl_1.LedgerEntry.OfferFlags.lsfSell) !== 0,
+    const flags = (0, offer_flags_1.default)(node.finalFields.Flags);
+    const takerPays = parseChangeAmount(node, "TakerPays");
+    const takerGets = parseChangeAmount(node, "TakerGets");
+    const orderChange = (0, common_1.removeUndefined)({
+        flags,
+        quantity: flags.sell === true ? takerGets : takerPays,
+        totalPrice: flags.sell === true ? takerPays : takerGets,
         sequence: (node.finalFields.Sequence || node.newFields.Sequence),
         status: parseOrderStatus(node),
-        quality: getQuality(node),
-        expiration: getExpirationTime(node),
+        makerExchangeRate: getQuality(node),
+        expirationTime: getExpirationTime(node),
+        direction: (node.finalFields.Flags & xrpl_1.LedgerEntry.OfferFlags.lsfSell) === 0 ? "buy" : "sell",
     });
     Object.defineProperty(orderChange, "account", {
         value: node.finalFields.Account || node.newFields.Account,

package/lib/parse/outcome.js

@@ -8,7 +8,14 @@ const common_1 = require("../common");
 const ESCROW_TYPES = ["EscrowFinish", "EscrowCreate", "EscrowCancel"];
 const CHANNEL_TYPES = ["PaymentChannelCreate", "PaymentChannelFund", "PaymentChannelClaim"];
 const CHECK_TYPES = ["CheckCreate", "CheckCash", "CheckCancel"];
-const NFTOKEN_TYPES = ["NFTokenMint", "NFTokenBurn", "NFTokenCreateOffer", "NFTokenCancelOffer", "NFTokenAcceptOffer"];
+const NFTOKEN_TYPES = [
+    "NFTokenMint",
+    "NFTokenBurn",
+    "NFTokenCreateOffer",
+    "NFTokenCancelOffer",
+    "NFTokenAcceptOffer",
+    "NFTokenModify",
+];
 const URITOKEN_TYPES = [
     "Remit",
     "URITokenMint",

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

@@ -46,20 +46,22 @@ const common_1 = require("../../common");
 const signers_1 = require("../ledger/signers");
 const regular_key_1 = require("../ledger/regular-key");
 const source_1 = require("../ledger/source");
+const offer_create_flags_1 = __importDefault(require("../ledger/offer-create-flags"));
 function parseOfferCreate(tx) {
     assert.ok(tx.TransactionType === "OfferCreate");
-    const direction = (tx.Flags & xrpl_1.OfferCreateFlags.tfSell) === 0 ? "buy" : "sell";
-    const takerGetsAmount = (0, amount_1.default)(tx.TakerGets);
-    const takerPaysAmount = (0, amount_1.default)(tx.TakerPays);
-    const quantity = direction === "buy" ? takerPaysAmount : takerGetsAmount;
-    const totalPrice = direction === "buy" ? takerGetsAmount : takerPaysAmount;
+    const flags = (0, offer_create_flags_1.default)(tx.Flags);
+    const takerGets = (0, amount_1.default)(tx.TakerGets);
+    const takerPays = (0, amount_1.default)(tx.TakerPays);
+    const quantity = flags.sell === true ? takerGets : takerPays;
+    const totalPrice = flags.sell === true ? takerPays : takerGets;
     return (0, common_1.removeUndefined)({
         signers: (0, signers_1.parseSigners)(tx),
         signer: (0, regular_key_1.parseSignerRegularKey)(tx),
         source: (0, source_1.parseSource)(tx),
-        direction: direction,
+        flags,
         quantity: quantity,
         totalPrice: totalPrice,
+        direction: (tx.Flags & xrpl_1.OfferCreateFlags.tfSell) === 0 ? "buy" : "sell",
         passive: (tx.Flags & xrpl_1.OfferCreateFlags.tfPassive) !== 0 || undefined,
         immediateOrCancel: (tx.Flags & xrpl_1.OfferCreateFlags.tfImmediateOrCancel) !== 0 || undefined,
         fillOrKill: (tx.Flags & xrpl_1.OfferCreateFlags.tfFillOrKill) !== 0 || undefined,

package/lib/types/offers.d.ts

@@ -1,6 +1,18 @@
-import { LedgerEntry } from "xrpl";
+import { LedgerEntry, OfferCreateFlags } from "xrpl";
 import { FormattedBaseSpecification } from "./specification";
 import { FormattedIssuedCurrencyAmount } from "./amounts";
+export declare const OfferCreateFlagsKeys: {
+    passive: OfferCreateFlags;
+    immediateOrCancel: OfferCreateFlags;
+    fillOrKill: OfferCreateFlags;
+    sell: OfferCreateFlags;
+};
+export interface OfferCreateFlagsKeysInterface {
+    passive: boolean;
+    immediateOrCancel: boolean;
+    fillOrKill: boolean;
+    sell: boolean;
+}
 export declare const OfferFlagsKeys: {
     passive: LedgerEntry.OfferFlags;
     sell: LedgerEntry.OfferFlags;
@@ -13,12 +25,13 @@ export type FormattedOfferCancelSpecification = {
     orderSequence: number;
 } & FormattedBaseSpecification;
 export type FormattedOfferCreateSpecification = {
-    direction: string;
+    flags: OfferCreateFlagsKeysInterface;
     quantity: FormattedIssuedCurrencyAmount;
     totalPrice: FormattedIssuedCurrencyAmount;
-    immediateOrCancel?: boolean;
-    fillOrKill?: boolean;
     expirationTime?: string;
     orderToReplace?: number;
+    direction: string;
+    immediateOrCancel?: boolean;
+    fillOrKill?: boolean;
     passive?: boolean;
 } & FormattedBaseSpecification;

package/lib/types/offers.js

@@ -1,8 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OfferFlagsKeys = void 0;
+exports.OfferFlagsKeys = exports.OfferCreateFlagsKeys = void 0;
 const xrpl_1 = require("xrpl");
 const { OfferFlags } = xrpl_1.LedgerEntry;
+exports.OfferCreateFlagsKeys = {
+    passive: xrpl_1.OfferCreateFlags.tfPassive,
+    immediateOrCancel: xrpl_1.OfferCreateFlags.tfImmediateOrCancel,
+    fillOrKill: xrpl_1.OfferCreateFlags.tfFillOrKill,
+    sell: xrpl_1.OfferCreateFlags.tfSell,
+};
 exports.OfferFlagsKeys = {
     passive: OfferFlags.lsfPassive,
     sell: OfferFlags.lsfSell,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "3.2.18",
+  "version": "3.2.20",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -52,7 +52,7 @@
     "lib/**/*"
   ],
   "dependencies": {
-    "axios": "^1.8.2",
+    "axios": "^1.8.4",
     "base-x": "^5.0.1",
     "bignumber.js": "^9.1.2",
     "elliptic": "^6.6.1",
@@ -62,27 +62,27 @@
     "xrpl": "^4.2.0"
   },
   "devDependencies": {
-    "@eslint/eslintrc": "^3.3.0",
-    "@types/chai": "^5.2.0",
-    "@types/chai-as-promised": "^8.0.1",
+    "@eslint/eslintrc": "^3.3.1",
+    "@types/chai": "^5.2.1",
+    "@types/chai-as-promised": "^8.0.2",
     "@types/lodash": "^4.17.16",
     "@types/mocha": "^10.0.10",
     "@types/nconf": "^0.10.7",
-    "@types/node": "^22.13.10",
-    "@typescript-eslint/eslint-plugin": "^8.26.0",
-    "@typescript-eslint/parser": "^8.26.0",
+    "@types/node": "^22.14.1",
+    "@typescript-eslint/eslint-plugin": "^8.30.1",
+    "@typescript-eslint/parser": "^8.30.1",
     "chai": "^4.5.0",
     "chai-as-promised": "^7.1.2",
-    "eslint": "^9.22.0",
-    "eslint-config-prettier": "^10.1.1",
+    "eslint": "^9.24.0",
+    "eslint-config-prettier": "^10.1.2",
     "eslint-plugin-chai-friendly": "^1.0.1",
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-n": "^17.16.2",
+    "eslint-plugin-n": "^17.17.0",
     "eslint-plugin-promise": "^7.2.1",
     "mocha": "^11.1.0",
-    "nconf": "^0.12.1",
-    "ts-jest": "^29.2.6",
+    "nconf": "^0.13.0",
+    "ts-jest": "^29.3.2",
     "ts-node": "^10.9.2",
-    "typescript": "^5.8.2"
+    "typescript": "^5.8.3"
   }
 }