@bithomp/xrpl-api 3.6.16 → 3.6.18

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

@@ -15,6 +15,7 @@ export interface BalanceChanges {
 }
 interface ParseBalanceChangesOptions {
     adjustBalancesForNativeEscrow?: boolean;
+    adjustBalancesForPaymentChannel?: boolean;
 }
 declare function parseBalanceChanges(metadata: TransactionMetadata, nativeCurrency?: string, tx?: any, options?: ParseBalanceChangesOptions): BalanceChanges;
 declare function parseFinalBalances(metadata: TransactionMetadata, nativeCurrency?: string): {

package/lib/parse/outcome/balance_changes.js

@@ -13,7 +13,9 @@ const utils_1 = require("../utils");
 const mptoken_1 = require("../../models/mptoken");
 const mptoken_normalize_1 = require("../mptoken_normalize");
 const amount_1 = __importDefault(require("../ledger/amount"));
+const channel_changes_1 = require("./channel_changes");
 const ESCROW_TYPES = ["EscrowFinish", "EscrowCreate", "EscrowCancel"];
+const PAYMENT_CHANNEL_TYPES = ["PaymentChannelClaim", "PaymentChannelCreate", "PaymentChannelFund"];
 function groupByAddress(balanceChanges) {
     const grouped = lodash_1.default.groupBy(balanceChanges, function (node) {
         return node.address;
@@ -70,7 +72,9 @@ function parseFinalBalance(node) {
         return parseValue(node.finalFields.Balance);
     }
     else if (node.entryType === "MPToken") {
-        return parseValue(node.finalFields.MPTAmount);
+        if (node.finalFields.MPTAmount) {
+            return parseValue(node.finalFields.MPTAmount);
+        }
     }
     else if (node.entryType === "MPTokenIssuance") {
         if (node.newFields.MaximumAmount) {
@@ -217,6 +221,45 @@ function adjustBalancesForNativeEscrow(balanceChanges, metadata, nativeCurrency,
         adjustBalancesChanges(balanceChanges, source, [{ currency: amount.currency, value: `-${amount.value}` }]);
     }
 }
+function adjustBalancesForPaymentChannel(balanceChanges, metadata, nativeCurrency, tx) {
+    const channelChanges = (0, channel_changes_1.parseChannelChanges)(metadata);
+    if (!channelChanges) {
+        return;
+    }
+    if (!channelChanges.source?.address) {
+        return;
+    }
+    if (tx.TransactionType === "PaymentChannelCreate") {
+        adjustBalancesChanges(balanceChanges, channelChanges.source.address, [
+            { currency: channelChanges.amount.currency, value: channelChanges.amount.value },
+        ]);
+    }
+    else if (tx.TransactionType === "PaymentChannelFund") {
+        if (channelChanges.amountChange) {
+            adjustBalancesChanges(balanceChanges, channelChanges.source.address, [
+                { currency: channelChanges.amountChange.currency, value: channelChanges.amountChange.value },
+            ]);
+        }
+    }
+    else if (tx.TransactionType === "PaymentChannelClaim") {
+        if (tx.Account === channelChanges.source.address && channelChanges.amountChange) {
+            adjustBalancesChanges(balanceChanges, channelChanges.source.address, [
+                { currency: channelChanges.amountChange.currency, value: channelChanges.amountChange.value },
+            ]);
+        }
+        else if (channelChanges.status === "deleted") {
+            const unlockedAmount = new bignumber_js_1.default(channelChanges.amount.value).minus(new bignumber_js_1.default(channelChanges?.balance?.value || "0"));
+            adjustBalancesChanges(balanceChanges, channelChanges.source.address, [
+                { currency: channelChanges.amount.currency, value: `-${unlockedAmount.toString()}` },
+            ]);
+        }
+        else if (channelChanges.balanceChange) {
+            adjustBalancesChanges(balanceChanges, channelChanges.source.address, [
+                { currency: channelChanges.balanceChange.currency, value: channelChanges.balanceChange.value },
+            ]);
+        }
+    }
+}
 function adjustBalancesChanges(balanceChanges, address, changes) {
     const existingChanges = balanceChanges[address] || [];
     const change = existingChanges.find((c) => c.currency === changes[0].currency && c.issuer === changes[0].issuer);
@@ -242,10 +285,13 @@ function parseBalanceChanges(metadata, nativeCurrency, tx, options) {
         (0, mptoken_normalize_1.normalizeMPTokensPreviousFields)(metadata, tx);
     }
     const balanceChanges = parseQuantities(metadata, computeBalanceChange, nativeCurrency);
-    if (tx && options && options.adjustBalancesForNativeEscrow) {
-        if (tx.TransactionType && ESCROW_TYPES.includes(tx.TransactionType)) {
+    if (tx && tx.TransactionType && options) {
+        if (options.adjustBalancesForNativeEscrow && ESCROW_TYPES.includes(tx.TransactionType)) {
             adjustBalancesForNativeEscrow(balanceChanges, metadata, nativeCurrency, tx);
         }
+        else if (options.adjustBalancesForPaymentChannel && PAYMENT_CHANNEL_TYPES.includes(tx.TransactionType)) {
+            adjustBalancesForPaymentChannel(balanceChanges, metadata, nativeCurrency, tx);
+        }
     }
     return balanceChanges;
 }

package/lib/parse/outcome/channel_changes.js

@@ -39,8 +39,8 @@ function summarizePaymentChannel(node) {
     if (prev.Amount) {
         summary.channelAmountChangeDrops = new bignumber_js_1.default(final.Amount).minus(new bignumber_js_1.default(prev.Amount || 0)).toString(10);
         summary.amountChange = (0, amount_1.default)(prev.Amount);
-        summary.amountChange.value = new bignumber_js_1.default(summary.amountChange.value)
-            .minus(new bignumber_js_1.default(summary.amount.value))
+        summary.amountChange.value = new bignumber_js_1.default(summary.amount.value)
+            .minus(new bignumber_js_1.default(summary.amountChange.value))
             .toString(10);
     }
     if (prev.Balance) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "3.6.16",
+  "version": "3.6.18",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -43,7 +43,7 @@
     "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
     "lint": "eslint",
     "prepare": "npm run build",
-    "-prepublishOnly": "npm test && npm run lint",
+    "prepublishOnly": "npm test && npm run lint",
     "preversion": "npm run lint",
     "version": "npm run format && git add -A src",
     "postversion": "git push && git push --tags"
@@ -74,7 +74,7 @@
     "@typescript-eslint/parser": "^8.46.1",
     "chai": "^6.2.0",
     "chai-as-promised": "^8.0.2",
-    "eslint": "^9.37.0",
+    "eslint": "^9.38.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-chai-friendly": "^1.1.0",
     "eslint-plugin-import": "^2.32.0",