@bithomp/xrpl-api 3.2.10 → 3.2.11

package/lib/parse/outcome/amm_changes.js

@@ -5,8 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseAmmChanges = parseAmmChanges;
 const bignumber_js_1 = __importDefault(require("bignumber.js"));
-const utils_1 = require("../utils");
 const common_1 = require("../../common");
+const utils_1 = require("../utils");
 const amount_1 = __importDefault(require("../ledger/amount"));
 const asset_1 = __importDefault(require("../ledger/asset"));
 const auth_accounts_1 = __importDefault(require("../ledger/auth-accounts"));
@@ -44,7 +44,7 @@ function parseVoteSlot(voteSlot) {
 }
 function summarizeVoteSlotsChanges(node) {
     const final = node.diffType === "CreatedNode" ? node.newFields : node.finalFields;
-    const prev = node.previousFields || {};
+    const prev = node.previousFields;
     const changes = final.VoteSlots.reduce((acc, slot) => {
         const prevSlot = prev.VoteSlots.find((s) => s.VoteEntry.Account === slot.VoteEntry.Account);
         if (!prevSlot) {
@@ -89,7 +89,7 @@ function summarizeVoteSlotsChanges(node) {
 }
 function summarizeActionSlotChanges(node) {
     const final = node.diffType === "CreatedNode" ? node.newFields : node.finalFields;
-    const prev = node.previousFields || {};
+    const prev = node.previousFields;
     const changes = {};
     if (prev.AuctionSlot) {
         if (final.AuctionSlot.Account !== prev.AuctionSlot.Account) {
@@ -165,14 +165,14 @@ function isEqualAuthAccounts(obj1, obj2) {
 }
 function summarizeAmm(node) {
     const final = node.diffType === "CreatedNode" ? node.newFields : node.finalFields;
-    const prev = node.previousFields || {};
+    const prev = node.previousFields;
     let asset = (0, asset_1.default)(final.Asset);
     if (node.diffType === "CreatedNode" && !asset) {
         asset = { currency: (0, client_1.getNativeCurrency)() };
     }
     const summary = {
         status: parseAmmStatus(node),
-        ammID: node.LedgerIndex,
+        ammID: node.ledgerIndex,
         account: final.Account,
         asset: asset,
         asset2: (0, asset_1.default)(final.Asset2),
@@ -202,8 +202,13 @@ function summarizeAmm(node) {
     return (0, common_1.removeUndefined)(summary);
 }
 function parseAmmChanges(metadata) {
-    const amms = (0, utils_1.normalizeNodes)(metadata).filter((n) => {
-        return n.entryType === "AMM";
+    const affectedNodes = metadata.AffectedNodes.filter((affectedNode) => {
+        const node = affectedNode.CreatedNode || affectedNode.ModifiedNode || affectedNode.DeletedNode;
+        return node.LedgerEntryType === "AMM";
     });
-    return amms.length === 1 ? summarizeAmm(amms[0]) : undefined;
+    if (affectedNodes.length !== 1) {
+        return undefined;
+    }
+    const normalizedNode = (0, utils_1.normalizeNode)(affectedNodes[0]);
+    return summarizeAmm(normalizedNode);
 }

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

@@ -13,9 +13,7 @@ export interface AddressBalanceChangeQuantity {
 export interface BalanceChanges {
     [key: string]: BalanceChangeQuantity[];
 }
-declare function parseBalanceChanges(metadata: TransactionMetadata, nativeCurrency?: string): {
-    [x: string]: BalanceChangeQuantity[];
-};
+declare function parseBalanceChanges(metadata: TransactionMetadata, nativeCurrency?: string): BalanceChanges;
 declare function parseFinalBalances(metadata: TransactionMetadata, nativeCurrency?: string): {
     [x: string]: BalanceChangeQuantity[];
 };

package/lib/parse/outcome/balance_changes.js

@@ -8,8 +8,8 @@ exports.parseFinalBalances = parseFinalBalances;
 const lodash_1 = __importDefault(require("lodash"));
 const bignumber_js_1 = __importDefault(require("bignumber.js"));
 const common_1 = require("../../common");
-const utils_1 = require("../utils");
 const client_1 = require("../../client");
+const utils_1 = require("../utils");
 function groupByAddress(balanceChanges) {
     const grouped = lodash_1.default.groupBy(balanceChanges, function (node) {
         return node.address;
@@ -63,7 +63,7 @@ function parseXRPQuantity(node, valueParser, nativeCurrency) {
         return null;
     }
     return {
-        address: node.finalFields.Account || node.newFields.Account,
+        address: (node.finalFields.Account || node.newFields.Account),
         balance: {
             currency: nativeCurrency || (0, client_1.getNativeCurrency)(),
             value: (0, common_1.dropsToXrp)(value).toString(),
@@ -114,15 +114,20 @@ function parseMPTQuantity(node, valueParser) {
     };
 }
 function parseQuantities(metadata, valueParser, nativeCurrency) {
-    const values = (0, utils_1.normalizeNodes)(metadata).map(function (node) {
-        if (node.entryType === "AccountRoot") {
-            return [parseXRPQuantity(node, valueParser, nativeCurrency)];
+    const values = metadata.AffectedNodes.map(function (affectedNode) {
+        const node = affectedNode.CreatedNode || affectedNode.ModifiedNode || affectedNode.DeletedNode;
+        if (!["AccountRoot", "RippleState", "MPToken"].includes(node.LedgerEntryType)) {
+            return [];
+        }
+        const normalizedNode = (0, utils_1.normalizeNode)(affectedNode);
+        if (node.LedgerEntryType === "AccountRoot") {
+            return [parseXRPQuantity(normalizedNode, valueParser, nativeCurrency)];
         }
-        else if (node.entryType === "RippleState") {
-            return parseTrustlineQuantity(node, valueParser);
+        else if (node.LedgerEntryType === "RippleState") {
+            return parseTrustlineQuantity(normalizedNode, valueParser);
         }
-        else if (node.entryType === "MPToken") {
-            return [parseMPTQuantity(node, valueParser)];
+        else if (node.LedgerEntryType === "MPToken") {
+            return [parseMPTQuantity(normalizedNode, valueParser)];
         }
         return [];
     });

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

@@ -1,6 +1,7 @@
-declare function parseChannelChanges(metadata: any): {
+import { TransactionMetadata } from "xrpl";
+declare function parseChannelChanges(metadata: TransactionMetadata): {
     status: string | undefined;
-    channelId: any;
+    channelId: string;
     source: any;
     destination: any;
     channelAmountDrops: string;

package/lib/parse/outcome/channel_changes.js

@@ -20,7 +20,7 @@ function parsePaymentChannelStatus(node) {
 }
 function summarizePaymentChannel(node) {
     const final = node.diffType === "CreatedNode" ? node.newFields : node.finalFields;
-    const prev = node.previousFields || {};
+    const prev = node.previousFields;
     const summary = {
         status: parsePaymentChannelStatus(node),
         channelId: node.ledgerIndex,
@@ -45,8 +45,13 @@ function summarizePaymentChannel(node) {
     return summary;
 }
 function parseChannelChanges(metadata) {
-    const paymentChannels = (0, utils_1.normalizeNodes)(metadata).filter((n) => {
-        return n.entryType === "PayChannel";
+    const affectedNodes = metadata.AffectedNodes.filter((affectedNode) => {
+        const node = affectedNode.CreatedNode || affectedNode.ModifiedNode || affectedNode.DeletedNode;
+        return node.LedgerEntryType === "PayChannel";
     });
-    return paymentChannels.length === 1 ? summarizePaymentChannel(paymentChannels[0]) : undefined;
+    if (affectedNodes.length !== 1) {
+        return undefined;
+    }
+    const normalizedNode = (0, utils_1.normalizeNode)(affectedNodes[0]);
+    return summarizePaymentChannel(normalizedNode);
 }

package/lib/parse/outcome/did_changes.js

@@ -17,10 +17,10 @@ function parseDIDStatus(node) {
 }
 function summarizeDID(node) {
     const final = node.diffType === "CreatedNode" ? node.newFields : node.finalFields;
-    const prev = node.previousFields || {};
+    const prev = node.previousFields;
     const summary = {
         status: parseDIDStatus(node),
-        didID: node.LedgerIndex,
+        didID: node.ledgerIndex,
         account: final.Account,
         uri: final.URI,
         data: final.Data,
@@ -38,8 +38,13 @@ function summarizeDID(node) {
     return (0, common_1.removeUndefined)(summary);
 }
 function parseDIDChanges(metadata) {
-    const dids = (0, utils_1.normalizeNodes)(metadata).filter((n) => {
-        return n.entryType === "DID";
+    const affectedNodes = metadata.AffectedNodes.filter((affectedNode) => {
+        const node = affectedNode.CreatedNode || affectedNode.ModifiedNode || affectedNode.DeletedNode;
+        return node.LedgerEntryType === "DID";
     });
-    return dids.length === 1 ? summarizeDID(dids[0]) : undefined;
+    if (affectedNodes.length !== 1) {
+        return undefined;
+    }
+    const normalizedNode = (0, utils_1.normalizeNode)(affectedNodes[0]);
+    return summarizeDID(normalizedNode);
 }

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

@@ -1,7 +1,7 @@
 import { FormattedSourceAddress, FormattedDestinationAddress } from "../../types/account";
 interface FormattedEscrowSummaryInterface {
     status?: "created" | "cancelled" | "executed" | "deleted";
-    escrowIndex?: number;
+    escrowIndex?: string;
     escrowSequence?: number;
     amount?: string;
     condition?: string;

package/lib/parse/outcome/escrow_changes.js

@@ -63,8 +63,13 @@ function summarizeEscrow(tx, node) {
     return (0, common_1.removeUndefined)(summary);
 }
 function parseEscrowChanges(tx) {
-    const escrows = (0, utils_1.normalizeNodes)(tx.meta).filter((n) => {
-        return n.entryType === "Escrow";
+    const affectedNodes = tx.meta.AffectedNodes.filter((affectedNode) => {
+        const node = affectedNode.CreatedNode || affectedNode.ModifiedNode || affectedNode.DeletedNode;
+        return node.LedgerEntryType === "Escrow";
     });
-    return escrows.length === 1 ? summarizeEscrow(tx, escrows[0]) : undefined;
+    if (affectedNodes.length !== 1) {
+        return undefined;
+    }
+    const normalizedNode = (0, utils_1.normalizeNode)(affectedNodes[0]);
+    return summarizeEscrow(tx, normalizedNode);
 }

package/lib/parse/outcome/locked_balance_changes.js

@@ -62,9 +62,14 @@ function parseTrustlineQuantity(node, valueParser) {
     return [result];
 }
 function parseQuantities(metadata, valueParser) {
-    const values = (0, utils_1.normalizeNodes)(metadata).map(function (node) {
-        if (node.entryType === "RippleState") {
-            return parseTrustlineQuantity(node, valueParser);
+    const values = metadata.AffectedNodes.map(function (affectedNode) {
+        const node = affectedNode.CreatedNode || affectedNode.ModifiedNode || affectedNode.DeletedNode;
+        if (node.LedgerEntryType !== "RippleState") {
+            return [];
+        }
+        const normalizedNode = (0, utils_1.normalizeNode)(affectedNode);
+        if (node.LedgerEntryType === "RippleState") {
+            return parseTrustlineQuantity(normalizedNode, valueParser);
         }
         return [];
     });

package/lib/parse/outcome/oracle_changes.js

@@ -55,7 +55,7 @@ function parsePriceDataSeries(series) {
 }
 function summarizePriceDataSeriesChanges(node) {
     const final = node.diffType === "CreatedNode" ? node.newFields : node.finalFields;
-    const prev = node.previousFields || {};
+    const prev = node.previousFields;
     const changes = final.PriceDataSeries.reduce((acc, series) => {
         const prevSeries = prev.PriceDataSeries.find((s) => s.PriceData.BaseAsset === series.PriceData.BaseAsset && s.PriceData.QuoteAsset === series.PriceData.QuoteAsset);
         const priceFinal = hexPriceToBigNumber(series.PriceData.AssetPrice) || new bignumber_js_1.default(0);
@@ -115,10 +115,10 @@ function summarizePriceDataSeriesChanges(node) {
 }
 function summarizeOracle(node) {
     const final = node.diffType === "CreatedNode" ? node.newFields : node.finalFields;
-    const prev = node.previousFields || {};
+    const prev = node.previousFields;
     const summary = {
         status: parseOracleStatus(node),
-        oracleID: node.LedgerIndex,
+        oracleID: node.ledgerIndex,
         oracleDocumentID: final.OracleDocumentID,
         provider: final.Provider,
         uri: final.URI,
@@ -138,8 +138,13 @@ function summarizeOracle(node) {
     return (0, common_1.removeUndefined)(summary);
 }
 function parseOracleChanges(metadata) {
-    const oracles = (0, utils_1.normalizeNodes)(metadata).filter((n) => {
-        return n.entryType === "Oracle";
+    const affectedNodes = metadata.AffectedNodes.filter((affectedNode) => {
+        const node = affectedNode.CreatedNode || affectedNode.ModifiedNode || affectedNode.DeletedNode;
+        return node.LedgerEntryType === "Oracle";
     });
-    return oracles.length === 1 ? summarizeOracle(oracles[0]) : undefined;
+    if (affectedNodes.length !== 1) {
+        return undefined;
+    }
+    const normalizedNode = (0, utils_1.normalizeNode)(affectedNodes[0]);
+    return summarizeOracle(normalizedNode);
 }

package/lib/parse/outcome/orderbook_changes.js

@@ -31,18 +31,18 @@ function convertOrderChange(order) {
     });
 }
 function getExpirationTime(node) {
-    const expirationTime = node.finalFields.Expiration || node.newFields.Expiration;
+    const expirationTime = (node.finalFields.Expiration || node.newFields.Expiration);
     if (expirationTime === undefined) {
         return undefined;
     }
     return new Date((0, models_1.ledgerTimeToTimestamp)(expirationTime)).toISOString();
 }
 function getQuality(node) {
-    const takerGets = node.finalFields.TakerGets || node.newFields.TakerGets;
-    const takerPays = node.finalFields.TakerPays || node.newFields.TakerPays;
+    const takerGets = (node.finalFields.TakerGets || node.newFields.TakerGets);
+    const takerPays = (node.finalFields.TakerPays || node.newFields.TakerPays);
     const takerGetsCurrency = takerGets.currency || (0, client_1.getNativeCurrency)();
     const takerPaysCurrency = takerPays.currency || (0, client_1.getNativeCurrency)();
-    const bookDirectory = node.finalFields.BookDirectory || node.newFields.BookDirectory;
+    const bookDirectory = (node.finalFields.BookDirectory || node.newFields.BookDirectory);
     const qualityHex = bookDirectory.substring(bookDirectory.length - 16);
     return (0, orderbook_quality_1.parseOrderbookQuality)(qualityHex, takerGetsCurrency, takerPaysCurrency);
 }
@@ -87,7 +87,7 @@ function parseOrderChange(node) {
         taker_pays: parseChangeAmount(node, "TakerPays"),
         taker_gets: parseChangeAmount(node, "TakerGets"),
         sell: (node.finalFields.Flags & xrpl_1.LedgerEntry.OfferFlags.lsfSell) !== 0,
-        sequence: node.finalFields.Sequence || node.newFields.Sequence,
+        sequence: (node.finalFields.Sequence || node.newFields.Sequence),
         status: parseOrderStatus(node),
         quality: getQuality(node),
         expiration: getExpirationTime(node),
@@ -103,9 +103,13 @@ function groupByAddress(orderChanges) {
     });
 }
 function parseOrderbookChanges(metadata) {
-    const nodes = (0, utils_1.normalizeNodes)(metadata);
-    const orderChanges = lodash_1.default.map(lodash_1.default.filter(nodes, function (node) {
-        return node.entryType === "Offer";
-    }), parseOrderChange);
+    const affectedNodes = metadata.AffectedNodes.filter((affectedNode) => {
+        const node = affectedNode.CreatedNode || affectedNode.ModifiedNode || affectedNode.DeletedNode;
+        return node.LedgerEntryType === "Offer";
+    });
+    const orderChanges = affectedNodes.map((affectedNode) => {
+        const normalizedNode = (0, utils_1.normalizeNode)(affectedNode);
+        return parseOrderChange(normalizedNode);
+    });
     return groupByAddress(orderChanges);
 }

package/lib/parse/outcome/unl_report_changes.js

@@ -36,8 +36,13 @@ function summarizeUNLReport(tx, node) {
     return undefined;
 }
 function parseUNLReportChanges(tx) {
-    const escrows = (0, utils_1.normalizeNodes)(tx.meta).filter((n) => {
-        return n.entryType === "UNLReport";
+    const affectedNodes = tx.meta.AffectedNodes.filter((affectedNode) => {
+        const node = affectedNode.CreatedNode || affectedNode.ModifiedNode || affectedNode.DeletedNode;
+        return node.LedgerEntryType === "UNLReport";
     });
-    return escrows.length === 1 ? summarizeUNLReport(tx, escrows[0]) : undefined;
+    if (affectedNodes.length !== 1) {
+        return undefined;
+    }
+    const normalizedNode = (0, utils_1.normalizeNode)(affectedNodes[0]);
+    return summarizeUNLReport(tx, normalizedNode);
 }

package/lib/parse/utils.d.ts

@@ -1,15 +1,32 @@
-import { TransactionMetadata } from "xrpl";
+import { Node, TransactionMetadata } from "xrpl";
 import { IssuedCurrencyAmount, FormattedIssuedCurrencyAmount, FormattedIssuedMPTAmount } from "../types";
+type NormalizedNode = {
+    diffType: string;
+    entryType: string;
+    ledgerIndex: string;
+    newFields: {
+        [field: string]: unknown;
+    };
+    finalFields: {
+        [field: string]: unknown;
+    };
+    previousFields: {
+        [field: string]: unknown;
+    };
+    PreviousTxnID?: string;
+    PreviousTxnLgrSeq?: number;
+};
 declare function adjustQualityForXRP(quality: string, takerGetsCurrency: string, takerPaysCurrency: string): string;
 declare function parseQuality(quality?: number | null): number | undefined;
 declare function parseTimestamp(rippleTime?: number | null): string | undefined;
 declare function isPartialPayment(tx: any): boolean;
 declare function removeGenericCounterparty(amount: IssuedCurrencyAmount | FormattedIssuedCurrencyAmount | FormattedIssuedMPTAmount, address: string): FormattedIssuedCurrencyAmount | FormattedIssuedMPTAmount;
-declare function normalizeNodes(metadata: TransactionMetadata): any[];
+declare function normalizeNode(affectedNode: Node): NormalizedNode;
+declare function normalizeNodes(metadata: TransactionMetadata): NormalizedNode[];
 declare function hexToString(hex: string | undefined): string | undefined;
 declare function stringToHex(value: string | undefined): string | undefined;
 declare function bytesToHex(value: Uint8Array | ArrayBufferLike): string;
 declare function hexToBytes(value: string): Uint8Array;
 declare function parseUint32(buf: Buffer, cur: number): string;
 declare function parseUint64(buf: Buffer, cur: number): string;
-export { parseQuality, parseTimestamp, adjustQualityForXRP, isPartialPayment, removeGenericCounterparty, normalizeNodes, hexToString, stringToHex, bytesToHex, hexToBytes, parseUint32, parseUint64, };
+export { NormalizedNode, parseQuality, parseTimestamp, adjustQualityForXRP, isPartialPayment, removeGenericCounterparty, normalizeNodes, normalizeNode, hexToString, stringToHex, bytesToHex, hexToBytes, parseUint32, parseUint64, };

package/lib/parse/utils.js

@@ -9,6 +9,7 @@ exports.adjustQualityForXRP = adjustQualityForXRP;
 exports.isPartialPayment = isPartialPayment;
 exports.removeGenericCounterparty = removeGenericCounterparty;
 exports.normalizeNodes = normalizeNodes;
+exports.normalizeNode = normalizeNode;
 exports.hexToString = hexToString;
 exports.stringToHex = stringToHex;
 exports.bytesToHex = bytesToHex;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "3.2.10",
+  "version": "3.2.11",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",