@bithomp/xrpl-api 3.2.14 → 3.2.16

package/README.md

@@ -168,7 +168,7 @@ const vl = await BithompXRPL.Client.createVLv2(vk, sk, [publishBlob, publishBlob
 
 // vl will contain the signed validator list with
 // {
-//   "blobs-v2": "...",
+//   "blobs_v2": "...",
 //   "manifest": "...", // signed with vk.privateKey and sk.privateKey
 //   "version": 2,
 //   "public_key": "..." // vk.publicKey

package/lib/ledger/vl-v2.js

@@ -107,7 +107,7 @@ async function createVLv2(masterKey, ephemeralKey, publishBlobs) {
         MasterPrivateKey: masterKey.privateKey,
     });
     return {
-        "blobs-v2": blobs,
+        "blobs_v2": blobs,
         manifest: globalManifest,
         public_key: masterKey.publicKey,
         version: 2,

package/lib/models/vl.d.ts

@@ -4,7 +4,7 @@ export interface VLInterface {
     public_key?: string;
     manifest?: string;
     blob?: string;
-    "blobs-v2"?: VLBlobInfoInterface[];
+    blobs_v2?: VLBlobInfoInterface[];
     signature?: string;
 }
 export interface ParsedVLInterface {

package/lib/models/vl.js

@@ -102,10 +102,13 @@ function parseVL(vl) {
         }
     }
     else if (decoded.version === 2) {
-        const blobs = vl["blobs-v2"];
+        const blobs = (vl["blobs-v2"] || vl["blobs_v2"]);
         if (!decoded.blobs) {
             decoded.blobs = [];
         }
+        if (!blobs) {
+            return decoded;
+        }
         for (const blobInfo of blobs) {
             const blob = decodeVLBlob(blobInfo.blob);
             error = isValidVLBlob(blob);
@@ -188,7 +191,10 @@ function isValidVL(vl) {
         }
     }
     else if (vl.version === 2) {
-        const blobs = vl["blobs-v2"];
+        const blobs = (vl["blobs-v2"] || vl["blobs_v2"]);
+        if (!blobs) {
+            return "blobs_v2 missing from vl";
+        }
         for (const blobInfo of blobs) {
             const blob = decodeVLBlob(blobInfo.blob);
             error = isValidVLBlob(blob);
@@ -226,17 +232,18 @@ function isValidVLFormat(vl) {
         }
     }
     else if (version === 2) {
+        const blobs = (vl["blobs-v2"] || vl["blobs_v2"]);
         if (blob !== undefined) {
             error = "Blob should not be present in vl version 2";
         }
-        else if (vl["blobs-v2"] === undefined) {
-            error = "blobs-v2 missing from vl";
+        else if (blobs === undefined) {
+            error = "blobs_v2 missing from vl";
         }
-        else if (!Array.isArray(vl["blobs-v2"])) {
-            error = "blobs-v2 should be an array";
+        else if (!Array.isArray(blobs)) {
+            error = "blobs_v2 should be an array";
         }
-        else if (vl["blobs-v2"].length === 0) {
-            error = "blobs-v2 should not be empty";
+        else if (blobs.length === 0) {
+            error = "blobs_v2 should not be empty";
         }
     }
     else {

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

@@ -1,3 +1,4 @@
-import { FormattedIssuedCurrencyAmount, FormattedIssuedMPTAmount } from "../../types";
-declare function parseDeliveredAmount(tx: any): FormattedIssuedCurrencyAmount | FormattedIssuedMPTAmount | undefined;
+import { IssuedCurrencyAmount, FormattedIssuedCurrencyAmount, FormattedIssuedMPTAmount } from "../../types";
+import { BalanceChanges } from "./balance_changes";
+declare function parseDeliveredAmount(tx: any, balanceChanges: BalanceChanges): IssuedCurrencyAmount | FormattedIssuedCurrencyAmount | FormattedIssuedMPTAmount | undefined;
 export { parseDeliveredAmount };

package/lib/parse/outcome/delivered_amount.js

@@ -4,41 +4,60 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseDeliveredAmount = parseDeliveredAmount;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const client_1 = require("../../client");
 const import_1 = require("../ledger/import");
 const amount_1 = __importDefault(require("../ledger/amount"));
-const utils_1 = require("../utils");
 const balance_changes_1 = require("./balance_changes");
-function parseDeliveredAmount(tx) {
-    if (!["Import", "Payment"].includes(tx.TransactionType) || tx.meta.TransactionResult !== "tesSUCCESS") {
+function parseDeliveredAmount(tx, balanceChanges) {
+    if (tx.meta.TransactionResult !== "tesSUCCESS") {
         return undefined;
     }
-    if (tx.meta.delivered_amount && tx.meta.delivered_amount === "unavailable") {
-        return undefined;
+    if (tx.TransactionType === "Payment") {
+        const txBalanceChanges = balanceChanges || (0, balance_changes_1.parseBalanceChanges)(tx.meta, (0, client_1.getNativeCurrency)());
+        if (txBalanceChanges) {
+            const account = tx.Destination;
+            const changes = txBalanceChanges[account];
+            if (changes) {
+                const positives = changes.filter((change) => change.value[0] !== "-");
+                if (positives.length === 1) {
+                    return positives[0];
+                }
+            }
+        }
+    }
+    else if (tx.TransactionType === "CheckCash") {
+        const txBalanceChanges = balanceChanges || (0, balance_changes_1.parseBalanceChanges)(tx.meta, (0, client_1.getNativeCurrency)());
+        if (txBalanceChanges) {
+            const account = tx.Account;
+            const changes = txBalanceChanges[account];
+            if (changes) {
+                const positives = changes.filter((change) => change.value[0] !== "-");
+                if (positives.length === 1) {
+                    return positives[0];
+                }
+            }
+        }
+    }
+    else if (tx.TransactionType === "Import") {
+        const txBalanceChanges = balanceChanges || (0, balance_changes_1.parseBalanceChanges)(tx.meta, (0, client_1.getNativeCurrency)());
+        const blob = (0, import_1.parseImportBlob)(tx.Blob);
+        if (typeof blob === "object") {
+            const account = blob.transaction.tx.Account;
+            const balanceChange = txBalanceChanges[account];
+            if (balanceChange && balanceChange.length === 1) {
+                return {
+                    currency: balanceChange[0].currency,
+                    value: new bignumber_js_1.default(balanceChange[0].value).abs().toString(),
+                };
+            }
+        }
     }
-    if (tx.meta.delivered_amount) {
+    if (tx.meta.delivered_amount && tx.meta.delivered_amount !== "unavailable") {
         return (0, amount_1.default)(tx.meta.delivered_amount);
     }
     if (tx.meta.DeliveredAmount) {
         return (0, amount_1.default)(tx.meta.DeliveredAmount);
     }
-    if (tx.Amount && !(0, utils_1.isPartialPayment)(tx)) {
-        return (0, amount_1.default)(tx.Amount);
-    }
-    if (tx.TransactionType === "Import") {
-        const balanceChanges = (0, balance_changes_1.parseBalanceChanges)(tx.meta);
-        const blob = (0, import_1.parseImportBlob)(tx.Blob);
-        if (typeof blob === "string") {
-            return undefined;
-        }
-        const account = blob.transaction.tx.Account;
-        const balanceChange = balanceChanges[account];
-        if (!balanceChange || balanceChange.length !== 1) {
-            return undefined;
-        }
-        return {
-            currency: balanceChange[0].currency,
-            value: balanceChange[0].value,
-        };
-    }
     return undefined;
 }

package/lib/parse/outcome.js

@@ -34,11 +34,12 @@ function parseOutcome(tx, nativeCurrency, definitions) {
     if (!metadata) {
         return undefined;
     }
+    const balanceChanges = getBalanceChanges(tx, nativeCurrency || (0, client_1.getNativeCurrency)());
     return (0, common_1.removeUndefined)({
         result: tx.meta.TransactionResult,
         timestamp: (0, utils_1.parseTimestamp)(tx.date),
         fee: (0, common_1.dropsToXrp)(tx.Fee),
-        balanceChanges: getBalanceChanges(tx, nativeCurrency || (0, client_1.getNativeCurrency)()),
+        balanceChanges,
         lockedBalanceChanges: getLockedBalanceChanges(tx),
         orderbookChanges: getOrderbookChanges(tx),
         channelChanges: getChannelChanges(tx),
@@ -60,7 +61,7 @@ function parseOutcome(tx, nativeCurrency, definitions) {
         ledgerIndex: tx.ledger_index || tx.inLedger,
         ledgerVersion: tx.ledger_index || tx.inLedger,
         indexInLedger: tx.meta.TransactionIndex,
-        deliveredAmount: (0, index_1.parseDeliveredAmount)(tx),
+        deliveredAmount: (0, index_1.parseDeliveredAmount)(tx, balanceChanges),
     });
 }
 function getBalanceChanges(tx, nativeCurrency) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "3.2.14",
+  "version": "3.2.16",
   "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.7.9",
+    "axios": "^1.8.1",
     "base-x": "^5.0.0",
     "bignumber.js": "^9.1.2",
     "elliptic": "^6.6.1",
@@ -62,26 +62,26 @@
     "xrpl": "^4.2.0"
   },
   "devDependencies": {
-    "@eslint/eslintrc": "^3.2.0",
+    "@eslint/eslintrc": "^3.3.0",
     "@types/chai": "^5.0.1",
     "@types/chai-as-promised": "^8.0.1",
     "@types/lodash": "^4.17.15",
     "@types/mocha": "^10.0.10",
     "@types/nconf": "^0.10.7",
-    "@types/node": "^22.13.4",
-    "@typescript-eslint/eslint-plugin": "^8.24.1",
-    "@typescript-eslint/parser": "^8.24.1",
+    "@types/node": "^22.13.5",
+    "@typescript-eslint/eslint-plugin": "^8.25.0",
+    "@typescript-eslint/parser": "^8.25.0",
     "chai": "^4.5.0",
     "chai-as-promised": "^7.1.2",
-    "eslint": "^9.20.1",
-    "eslint-config-prettier": "^10.0.1",
+    "eslint": "^9.21.0",
+    "eslint-config-prettier": "^10.0.2",
     "eslint-plugin-chai-friendly": "^1.0.1",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-n": "^17.15.1",
     "eslint-plugin-promise": "^7.2.1",
     "mocha": "^11.1.0",
     "nconf": "^0.12.1",
-    "ts-jest": "^29.2.5",
+    "ts-jest": "^29.2.6",
     "ts-node": "^10.9.2",
     "typescript": "^5.7.3"
   }