@bithomp/xrpl-api 3.6.11 → 3.6.15

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

@@ -13,7 +13,10 @@ export interface AddressBalanceChangeQuantity {
 export interface BalanceChanges {
     [key: string]: BalanceChangeQuantity[];
 }
-declare function parseBalanceChanges(metadata: TransactionMetadata, nativeCurrency?: string, tx?: any): BalanceChanges;
+interface ParseBalanceChangesOptions {
+    adjustBalancesForNativeEscrow?: boolean;
+}
+declare function parseBalanceChanges(metadata: TransactionMetadata, nativeCurrency?: string, tx?: any, options?: ParseBalanceChangesOptions): BalanceChanges;
 declare function parseFinalBalances(metadata: TransactionMetadata, nativeCurrency?: string): {
     [x: string]: BalanceChangeQuantity[];
 };

package/lib/parse/outcome/balance_changes.js

@@ -12,6 +12,8 @@ const client_1 = require("../../client");
 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 ESCROW_TYPES = ["EscrowFinish", "EscrowCreate", "EscrowCancel"];
 function groupByAddress(balanceChanges) {
     const grouped = lodash_1.default.groupBy(balanceChanges, function (node) {
         return node.address;
@@ -34,16 +36,18 @@ function computeBalanceChange(node) {
         value = parseValue(node.newFields.Balance);
     }
     else if (node.newFields.MPTAmount) {
-        value = parseValue(node.newFields);
+        value = parseValue(node.newFields.MPTAmount);
     }
     else if (node.previousFields.Balance && node.finalFields.Balance) {
         value = parseValue(node.finalFields.Balance).minus(parseValue(node.previousFields.Balance));
     }
     else if (node.entryType === "MPToken" && (node.previousFields.MPTAmount || node.previousFields.LockedAmount)) {
-        value = parseValue(node.finalFields.MPTAmount ?? 0)
-            .minus(parseValue(node.previousFields.MPTAmount ?? 0))
-            .plus(parseValue(node.finalFields.LockedAmount ?? 0))
-            .minus(parseValue(node.previousFields.LockedAmount ?? 0));
+        value = parseValue(node.finalFields.MPTAmount ?? 0).minus(parseValue(node.previousFields.MPTAmount ?? 0));
+        if (node.previousFields.LockedAmount) {
+            value = value
+                .plus(parseValue(node.finalFields.LockedAmount ?? 0))
+                .minus(parseValue(node.previousFields.LockedAmount ?? 0));
+        }
     }
     else if (node.entryType === "MPTokenIssuance") {
         if (node.newFields.MaximumAmount) {
@@ -186,11 +190,64 @@ function parseQuantities(metadata, valueParser, nativeCurrency) {
     });
     return groupByAddress(lodash_1.default.compact(lodash_1.default.flatten(values)));
 }
-function parseBalanceChanges(metadata, nativeCurrency, tx) {
+function adjustBalancesForNativeEscrow(balanceChanges, metadata, nativeCurrency, tx) {
+    let escrow;
+    if (tx.TransactionType === "EscrowCreate") {
+        escrow = metadata.AffectedNodes.find((node) => node.CreatedNode?.LedgerEntryType === "Escrow");
+    }
+    else {
+        escrow = metadata.AffectedNodes.find((node) => node.DeletedNode?.LedgerEntryType === "Escrow");
+    }
+    if (!escrow) {
+        return;
+    }
+    const fields = escrow.CreatedNode?.NewFields || escrow.DeletedNode?.FinalFields;
+    if (!fields || !fields.Amount) {
+        return;
+    }
+    const amount = (0, amount_1.default)(fields.Amount);
+    if (!amount || amount.currency !== (nativeCurrency || common_1.MAINNET_NATIVE_CURRENCY) || !amount.value) {
+        return;
+    }
+    const source = fields.Account;
+    if (tx.TransactionType === "EscrowCreate") {
+        adjustBalancesChanges(balanceChanges, source, [{ currency: amount.currency, value: amount.value }]);
+    }
+    else if (tx.TransactionType === "EscrowFinish" || tx.TransactionType === "EscrowCancel") {
+        adjustBalancesChanges(balanceChanges, source, [{ currency: amount.currency, value: `-${amount.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);
+    if (change) {
+        const newValue = new bignumber_js_1.default(change.value).plus(new bignumber_js_1.default(changes[0].value));
+        if (newValue.isZero()) {
+            balanceChanges[address] = existingChanges.filter((c) => c !== change);
+            if (balanceChanges[address].length === 0) {
+                delete balanceChanges[address];
+            }
+        }
+        else {
+            change.value = newValue.toString();
+        }
+    }
+    else {
+        existingChanges.push(changes[0]);
+        balanceChanges[address] = existingChanges;
+    }
+}
+function parseBalanceChanges(metadata, nativeCurrency, tx, options) {
     if (tx && nativeCurrency === common_1.MAINNET_NATIVE_CURRENCY && metadata.TransactionResult === "tesSUCCESS") {
         (0, mptoken_normalize_1.normalizeMPTokensPreviousFields)(metadata, tx);
     }
-    return parseQuantities(metadata, computeBalanceChange, nativeCurrency);
+    const balanceChanges = parseQuantities(metadata, computeBalanceChange, nativeCurrency);
+    if (tx && options && options.adjustBalancesForNativeEscrow) {
+        if (tx.TransactionType && ESCROW_TYPES.includes(tx.TransactionType)) {
+            adjustBalancesForNativeEscrow(balanceChanges, metadata, nativeCurrency, tx);
+        }
+    }
+    return balanceChanges;
 }
 function parseFinalBalances(metadata, nativeCurrency) {
     return parseQuantities(metadata, parseFinalBalance, nativeCurrency);

package/lib/parse/outcome/mptoken_changes.js

@@ -50,6 +50,7 @@ class MPTokenChanges {
                         mptIssuanceID,
                         account,
                         amount: node.NewFields.MPTAmount,
+                        lockedAmount: node.NewFields.LockedAmount,
                     });
                 }
                 if (affectedNode.ModifiedNode) {
@@ -61,6 +62,15 @@ class MPTokenChanges {
                     if (amountChange === "0") {
                         amountChange = undefined;
                     }
+                    let lockedAmountChange = undefined;
+                    if (node.PreviousFields.LockedAmount !== undefined) {
+                        lockedAmountChange = new bignumber_js_1.default(node.FinalFields.LockedAmount ?? 0)
+                            .minus(node.PreviousFields.LockedAmount ?? 0)
+                            .toString();
+                        if (lockedAmountChange === "0") {
+                            lockedAmountChange = undefined;
+                        }
+                    }
                     let flagsChange;
                     if (node.PreviousFields?.Flags !== undefined) {
                         flagsChange = (0, mptoken_flags_1.default)(node.PreviousFields.Flags);
@@ -71,7 +81,9 @@ class MPTokenChanges {
                         mptIssuanceID,
                         account,
                         amount: node.FinalFields.MPTAmount,
+                        lockedAmount: node.FinalFields.LockedAmount,
                         amountChange,
+                        lockedAmountChange,
                         flagsChange,
                     });
                 }
@@ -84,6 +96,7 @@ class MPTokenChanges {
                         mptIssuanceID,
                         account,
                         amount: node.FinalFields.MPTAmount,
+                        lockedAmount: node.FinalFields.LockedAmount,
                     });
                 }
             }

package/lib/parse/outcome/mptoken_issuance_changes.js

@@ -50,6 +50,7 @@ class MPTokenIssuanceChanges {
                         transferFee: node.NewFields.TransferFee,
                         maximumAmount: node.NewFields.MaximumAmount,
                         outstandingAmount: node.NewFields.OutstandingAmount,
+                        lockedAmount: node.NewFields.LockedAmount,
                         metadata: node.NewFields.Metadata,
                         scale: node.NewFields.AssetScale,
                     });
@@ -62,6 +63,23 @@ class MPTokenIssuanceChanges {
                     if (outstandingAmountChange === "0") {
                         outstandingAmountChange = undefined;
                     }
+                    let lockedAmountChange = undefined;
+                    if (node.PreviousFields.LockedAmount !== undefined) {
+                        lockedAmountChange = new bignumber_js_1.default(node.FinalFields.LockedAmount ?? 0)
+                            .minus(new bignumber_js_1.default(node.PreviousFields.LockedAmount ?? 0))
+                            .toString();
+                        if (lockedAmountChange === "0") {
+                            lockedAmountChange = undefined;
+                        }
+                    }
+                    let lockedAmount = node.FinalFields.LockedAmount;
+                    if (lockedAmount === undefined && lockedAmountChange !== undefined) {
+                        lockedAmount = "0";
+                    }
+                    let flagsChange;
+                    if (node.PreviousFields?.Flags !== undefined) {
+                        flagsChange = (0, mptoken_issuance_flags_1.default)(node.PreviousFields.Flags);
+                    }
                     this.addChange(mptIssuanceID, {
                         status: "modified",
                         flags: (0, mptoken_issuance_flags_1.default)(node.FinalFields.Flags),
@@ -71,10 +89,12 @@ class MPTokenIssuanceChanges {
                         transferFee: node.FinalFields.TransferFee,
                         maximumAmount: node.FinalFields.MaximumAmount,
                         outstandingAmount: node.FinalFields.OutstandingAmount,
+                        lockedAmount,
                         metadata: node.FinalFields.Metadata,
                         scale: node.FinalFields.AssetScale,
                         outstandingAmountChange,
-                        flagsChange: node.PreviousFields.hasOwnProperty("Flags") ? (0, mptoken_issuance_flags_1.default)(node.PreviousFields.Flags) : undefined,
+                        lockedAmountChange,
+                        flagsChange,
                     });
                 }
                 if (affectedNode.DeletedNode) {
@@ -88,6 +108,7 @@ class MPTokenIssuanceChanges {
                         transferFee: node.FinalFields.TransferFee,
                         maximumAmount: node.FinalFields.MaximumAmount,
                         outstandingAmount: node.FinalFields.OutstandingAmount,
+                        lockedAmount: node.FinalFields.LockedAmount,
                         metadata: node.FinalFields.Metadata,
                         scale: node.FinalFields.AssetScale,
                     });

package/lib/parse/outcome.js

@@ -35,6 +35,9 @@ const MPTOKEN_TYPES = [
     "MPTokenIssuanceDestroy",
     "Payment",
     "Clawback",
+    "EscrowFinish",
+    "EscrowCreate",
+    "EscrowCancel",
 ];
 const CREDENTIAL_TYPES = ["CredentialCreate", "CredentialAccept", "CredentialDelete"];
 const DELEGATE_TYPES = ["DelegateSet"];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "3.6.11",
+  "version": "3.6.15",
   "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"
@@ -70,8 +70,8 @@
     "@types/mocha": "^10.0.10",
     "@types/nconf": "^0.10.7",
     "@types/node": "^22.15.21",
-    "@typescript-eslint/eslint-plugin": "^8.45.0",
-    "@typescript-eslint/parser": "^8.45.0",
+    "@typescript-eslint/eslint-plugin": "^8.46.1",
+    "@typescript-eslint/parser": "^8.46.1",
     "chai": "^6.2.0",
     "chai-as-promised": "^8.0.2",
     "eslint": "^9.37.0",
@@ -82,7 +82,7 @@
     "eslint-plugin-promise": "^7.2.1",
     "mocha": "^11.7.4",
     "nconf": "^0.13.0",
-    "ts-jest": "^29.4.4",
+    "ts-jest": "^29.4.5",
     "ts-node": "^10.9.2",
     "typescript": "^5.9.3"
   }