@bithomp/xrpl-api 3.7.30 → 3.7.37

package/lib/src/parse/outcome/index.d.ts

@@ -0,0 +1,26 @@
+export { parseAffectedObjects } from "./affected_objects";
+export { parseNFTokenChanges } from "./nftoken_changes";
+export { parseNFTokenOfferChanges } from "./nftoken_offer_changes";
+export { parseURITokenChanges } from "./uritoken_changes";
+export { parseURITokenSellOfferChanges } from "./uritoken_sell_offer_changes";
+export { parseBalanceChanges } from "./balance_changes";
+export { parseLockedBalanceChanges } from "./locked_balance_changes";
+export { parseChannelChanges } from "./channel_changes";
+export { parseCheckChanges } from "./check_changes";
+export { parseOrderbookChanges } from "./orderbook_changes";
+export { parseHooksExecutions } from "./hooks_executions";
+export { parseEmittedTxns } from "./emitted_txns";
+export { parseEscrowChanges } from "./escrow_changes";
+export { parseUNLReportChanges } from "./unl_report_changes";
+export { parseAmmChanges } from "./amm_changes";
+export { parseDIDChanges } from "./did_changes";
+export { parseOracleChanges } from "./oracle_changes";
+export { parseDeliveredAmount } from "./delivered_amount";
+export { parseMPTokenIssuanceChanges } from "./mptoken_issuance_changes";
+export { parseMPTokenChanges } from "./mptoken_changes";
+export { parseCredentialChanges } from "./credential_changes";
+export { parseDelegateChanges } from "./delegate_changes";
+export { parseRemarksChanges } from "./remarks_changes";
+export { parseAmendmentChanges } from "./amendment_changes";
+export { parseCronChanges } from "./cron_changes";
+export { parseAccountSettingChanges } from "./account_setting_changes";

package/lib/src/parse/outcome/index.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseAccountSettingChanges = exports.parseCronChanges = exports.parseAmendmentChanges = exports.parseRemarksChanges = exports.parseDelegateChanges = exports.parseCredentialChanges = exports.parseMPTokenChanges = exports.parseMPTokenIssuanceChanges = exports.parseDeliveredAmount = exports.parseOracleChanges = exports.parseDIDChanges = exports.parseAmmChanges = exports.parseUNLReportChanges = exports.parseEscrowChanges = exports.parseEmittedTxns = exports.parseHooksExecutions = exports.parseOrderbookChanges = exports.parseCheckChanges = exports.parseChannelChanges = exports.parseLockedBalanceChanges = exports.parseBalanceChanges = exports.parseURITokenSellOfferChanges = exports.parseURITokenChanges = exports.parseNFTokenOfferChanges = exports.parseNFTokenChanges = exports.parseAffectedObjects = void 0;
+var affected_objects_1 = require("./affected_objects");
+Object.defineProperty(exports, "parseAffectedObjects", { enumerable: true, get: function () { return affected_objects_1.parseAffectedObjects; } });
+var nftoken_changes_1 = require("./nftoken_changes");
+Object.defineProperty(exports, "parseNFTokenChanges", { enumerable: true, get: function () { return nftoken_changes_1.parseNFTokenChanges; } });
+var nftoken_offer_changes_1 = require("./nftoken_offer_changes");
+Object.defineProperty(exports, "parseNFTokenOfferChanges", { enumerable: true, get: function () { return nftoken_offer_changes_1.parseNFTokenOfferChanges; } });
+var uritoken_changes_1 = require("./uritoken_changes");
+Object.defineProperty(exports, "parseURITokenChanges", { enumerable: true, get: function () { return uritoken_changes_1.parseURITokenChanges; } });
+var uritoken_sell_offer_changes_1 = require("./uritoken_sell_offer_changes");
+Object.defineProperty(exports, "parseURITokenSellOfferChanges", { enumerable: true, get: function () { return uritoken_sell_offer_changes_1.parseURITokenSellOfferChanges; } });
+var balance_changes_1 = require("./balance_changes");
+Object.defineProperty(exports, "parseBalanceChanges", { enumerable: true, get: function () { return balance_changes_1.parseBalanceChanges; } });
+var locked_balance_changes_1 = require("./locked_balance_changes");
+Object.defineProperty(exports, "parseLockedBalanceChanges", { enumerable: true, get: function () { return locked_balance_changes_1.parseLockedBalanceChanges; } });
+var channel_changes_1 = require("./channel_changes");
+Object.defineProperty(exports, "parseChannelChanges", { enumerable: true, get: function () { return channel_changes_1.parseChannelChanges; } });
+var check_changes_1 = require("./check_changes");
+Object.defineProperty(exports, "parseCheckChanges", { enumerable: true, get: function () { return check_changes_1.parseCheckChanges; } });
+var orderbook_changes_1 = require("./orderbook_changes");
+Object.defineProperty(exports, "parseOrderbookChanges", { enumerable: true, get: function () { return orderbook_changes_1.parseOrderbookChanges; } });
+var hooks_executions_1 = require("./hooks_executions");
+Object.defineProperty(exports, "parseHooksExecutions", { enumerable: true, get: function () { return hooks_executions_1.parseHooksExecutions; } });
+var emitted_txns_1 = require("./emitted_txns");
+Object.defineProperty(exports, "parseEmittedTxns", { enumerable: true, get: function () { return emitted_txns_1.parseEmittedTxns; } });
+var escrow_changes_1 = require("./escrow_changes");
+Object.defineProperty(exports, "parseEscrowChanges", { enumerable: true, get: function () { return escrow_changes_1.parseEscrowChanges; } });
+var unl_report_changes_1 = require("./unl_report_changes");
+Object.defineProperty(exports, "parseUNLReportChanges", { enumerable: true, get: function () { return unl_report_changes_1.parseUNLReportChanges; } });
+var amm_changes_1 = require("./amm_changes");
+Object.defineProperty(exports, "parseAmmChanges", { enumerable: true, get: function () { return amm_changes_1.parseAmmChanges; } });
+var did_changes_1 = require("./did_changes");
+Object.defineProperty(exports, "parseDIDChanges", { enumerable: true, get: function () { return did_changes_1.parseDIDChanges; } });
+var oracle_changes_1 = require("./oracle_changes");
+Object.defineProperty(exports, "parseOracleChanges", { enumerable: true, get: function () { return oracle_changes_1.parseOracleChanges; } });
+var delivered_amount_1 = require("./delivered_amount");
+Object.defineProperty(exports, "parseDeliveredAmount", { enumerable: true, get: function () { return delivered_amount_1.parseDeliveredAmount; } });
+var mptoken_issuance_changes_1 = require("./mptoken_issuance_changes");
+Object.defineProperty(exports, "parseMPTokenIssuanceChanges", { enumerable: true, get: function () { return mptoken_issuance_changes_1.parseMPTokenIssuanceChanges; } });
+var mptoken_changes_1 = require("./mptoken_changes");
+Object.defineProperty(exports, "parseMPTokenChanges", { enumerable: true, get: function () { return mptoken_changes_1.parseMPTokenChanges; } });
+var credential_changes_1 = require("./credential_changes");
+Object.defineProperty(exports, "parseCredentialChanges", { enumerable: true, get: function () { return credential_changes_1.parseCredentialChanges; } });
+var delegate_changes_1 = require("./delegate_changes");
+Object.defineProperty(exports, "parseDelegateChanges", { enumerable: true, get: function () { return delegate_changes_1.parseDelegateChanges; } });
+var remarks_changes_1 = require("./remarks_changes");
+Object.defineProperty(exports, "parseRemarksChanges", { enumerable: true, get: function () { return remarks_changes_1.parseRemarksChanges; } });
+var amendment_changes_1 = require("./amendment_changes");
+Object.defineProperty(exports, "parseAmendmentChanges", { enumerable: true, get: function () { return amendment_changes_1.parseAmendmentChanges; } });
+var cron_changes_1 = require("./cron_changes");
+Object.defineProperty(exports, "parseCronChanges", { enumerable: true, get: function () { return cron_changes_1.parseCronChanges; } });
+var account_setting_changes_1 = require("./account_setting_changes");
+Object.defineProperty(exports, "parseAccountSettingChanges", { enumerable: true, get: function () { return account_setting_changes_1.parseAccountSettingChanges; } });

package/lib/src/parse/outcome/locked_balance_changes.d.ts

@@ -0,0 +1,20 @@
+import { TransactionMetadata } from "xrpl";
+interface LockedBalanceChangeQuantity {
+    issuer?: string;
+    currency?: string;
+    value: string;
+    counterparty?: string;
+    mpt_issuance_id?: string;
+}
+export interface AddressLockedBalanceChangeQuantity {
+    address: string;
+    lockedBalance: LockedBalanceChangeQuantity;
+}
+export interface LockedBalanceChanges {
+    [key: string]: LockedBalanceChangeQuantity[];
+}
+declare function parseLockedBalanceChanges(metadata: TransactionMetadata): LockedBalanceChanges;
+declare function parseFinalLockedBalances(metadata: TransactionMetadata): {
+    [x: string]: LockedBalanceChangeQuantity[];
+};
+export { parseLockedBalanceChanges, parseFinalLockedBalances };

package/lib/src/parse/outcome/locked_balance_changes.js

@@ -0,0 +1,117 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseLockedBalanceChanges = parseLockedBalanceChanges;
+exports.parseFinalLockedBalances = parseFinalLockedBalances;
+const lodash_1 = __importDefault(require("lodash"));
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const utils_1 = require("../utils");
+function groupByAddress(lockedBalanceChanges) {
+    const grouped = lodash_1.default.groupBy(lockedBalanceChanges, function (node) {
+        return node.address;
+    });
+    return lodash_1.default.mapValues(grouped, function (group) {
+        return lodash_1.default.map(group, function (node) {
+            return node.lockedBalance;
+        });
+    });
+}
+function parseValue(value) {
+    if (typeof value === "string" || typeof value === "number") {
+        return new bignumber_js_1.default(value);
+    }
+    return new bignumber_js_1.default(value.value ?? 0);
+}
+function computeBalanceChange(node) {
+    let value = null;
+    if (node.newFields.LockedBalance) {
+        value = parseValue(node.newFields.LockedBalance);
+    }
+    else if (node.previousFields.LockedBalance && node.finalFields.LockedBalance) {
+        value = parseValue(node.finalFields.LockedBalance).minus(parseValue(node.previousFields.LockedBalance));
+    }
+    else if (node.previousFields.LockedBalance) {
+        value = parseValue(node.previousFields.LockedBalance).negated();
+    }
+    else if (node.finalFields.LockedAmount || node.previousFields.LockedAmount) {
+        value = parseValue(node.finalFields.LockedAmount ?? 0).minus(parseValue(node.previousFields.LockedAmount ?? 0));
+    }
+    return value === null ? null : value.isZero() ? null : value;
+}
+function parseFinalBalance(node) {
+    if (node.newFields.LockedBalance) {
+        return parseValue(node.newFields.LockedBalance);
+    }
+    else if (node.finalFields.LockedBalance) {
+        return parseValue(node.finalFields.LockedBalance);
+    }
+    return null;
+}
+function parseTrustlineQuantity(node, valueParser) {
+    const value = valueParser(node);
+    if (value === null) {
+        return null;
+    }
+    const fields = lodash_1.default.isEmpty(node.newFields) ? node.finalFields : node.newFields;
+    const previousFields = node.previousFields;
+    let viewLowest = true;
+    if (previousFields && previousFields.Balance && previousFields.Balance.value !== "0") {
+        viewLowest = previousFields.Balance.value[0] !== "-";
+    }
+    else {
+        viewLowest = fields.Balance.value[0] !== "-";
+    }
+    const sign = viewLowest ? 1 : -1;
+    const currency = fields.Balance.currency;
+    const issuer = viewLowest ? fields.HighLimit.issuer : fields.LowLimit.issuer;
+    const holder = viewLowest ? fields.LowLimit.issuer : fields.HighLimit.issuer;
+    const result = {
+        address: holder,
+        lockedBalance: {
+            issuer,
+            currency,
+            value: value.times(sign).toString(),
+            counterparty: issuer,
+        },
+    };
+    return [result];
+}
+function parseMPTQuantity(node, valueParser) {
+    const value = valueParser(node);
+    if (value === null) {
+        return null;
+    }
+    const fields = lodash_1.default.isEmpty(node.newFields) ? node.finalFields : node.newFields;
+    return {
+        address: fields.Account,
+        lockedBalance: {
+            value: value.toString(),
+            mpt_issuance_id: fields.MPTokenIssuanceID,
+        },
+    };
+}
+function parseQuantities(metadata, valueParser) {
+    const values = metadata.AffectedNodes.map(function (affectedNode) {
+        const node = affectedNode.CreatedNode || affectedNode.ModifiedNode || affectedNode.DeletedNode;
+        if (!["RippleState", "MPToken"].includes(node.LedgerEntryType)) {
+            return [];
+        }
+        const normalizedNode = (0, utils_1.normalizeNode)(affectedNode);
+        if (node.LedgerEntryType === "RippleState") {
+            return parseTrustlineQuantity(normalizedNode, valueParser);
+        }
+        else if (node.LedgerEntryType === "MPToken") {
+            return [parseMPTQuantity(normalizedNode, valueParser)];
+        }
+        return [];
+    });
+    return groupByAddress(lodash_1.default.compact(lodash_1.default.flatten(values)));
+}
+function parseLockedBalanceChanges(metadata) {
+    return parseQuantities(metadata, computeBalanceChange);
+}
+function parseFinalLockedBalances(metadata) {
+    return parseQuantities(metadata, parseFinalBalance);
+}

package/lib/src/parse/outcome/mptoken_changes.d.ts

@@ -0,0 +1 @@
+export declare function parseMPTokenChanges(tx: object): object;

package/lib/src/parse/outcome/mptoken_changes.js

@@ -0,0 +1,113 @@
+"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 = __importDefault(require("bignumber.js"));
+const common_1 = require("../../common");
+const mptoken_flags_1 = __importDefault(require("../ledger/mptoken-flags"));
+function parseMPTokenChanges(tx) {
+    return new MPTokenChanges(tx).call();
+}
+class MPTokenChanges {
+    constructor(tx) {
+        this.tx = tx;
+        this.changes = {};
+    }
+    call() {
+        if (this.hasAffectedNodes() === false) {
+            return this.changes;
+        }
+        this.parseAffectedNodes();
+        return this.changes;
+    }
+    hasAffectedNodes() {
+        if (this.tx.meta?.AffectedNodes === undefined) {
+            return false;
+        }
+        if (this.tx.meta?.AffectedNodes?.length === 0) {
+            return false;
+        }
+        return true;
+    }
+    addChange(mptIssuanceID, account, change) {
+        if (!this.changes[mptIssuanceID]) {
+            this.changes[mptIssuanceID] = {};
+        }
+        this.changes[mptIssuanceID][account] = (0, common_1.removeUndefined)(change);
+    }
+    parseAffectedNodes() {
+        for (const affectedNode of this.tx.meta.AffectedNodes) {
+            const node = affectedNode.CreatedNode || affectedNode.ModifiedNode || affectedNode.DeletedNode;
+            if (node?.LedgerEntryType === "MPToken" && node?.LedgerIndex) {
+                if (affectedNode.CreatedNode) {
+                    const mptIssuanceID = node.NewFields.MPTokenIssuanceID;
+                    const account = node.NewFields.Account;
+                    this.addChange(mptIssuanceID, account, {
+                        status: "added",
+                        flags: (0, mptoken_flags_1.default)(node.NewFields.Flags),
+                        mptIssuanceID,
+                        account,
+                        amount: node.NewFields.MPTAmount || "0",
+                        lockedAmount: node.NewFields.LockedAmount,
+                    });
+                }
+                if (affectedNode.ModifiedNode) {
+                    const mptIssuanceID = node.FinalFields.MPTokenIssuanceID;
+                    const account = node.FinalFields.Account;
+                    let amountChange = undefined;
+                    if (node.PreviousFields.MPTAmount !== undefined) {
+                        amountChange = new bignumber_js_1.default(node.FinalFields.MPTAmount ?? 0)
+                            .minus(node.PreviousFields.MPTAmount ?? 0)
+                            .toString();
+                        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;
+                        }
+                    }
+                    if (amountChange &&
+                        lockedAmountChange &&
+                        new bignumber_js_1.default(amountChange).abs().isEqualTo(new bignumber_js_1.default(lockedAmountChange).abs())) {
+                        amountChange = undefined;
+                    }
+                    let flagsChange;
+                    if (node.PreviousFields?.Flags !== undefined) {
+                        flagsChange = (0, mptoken_flags_1.default)(node.PreviousFields.Flags);
+                    }
+                    this.addChange(mptIssuanceID, account, {
+                        status: "modified",
+                        flags: (0, mptoken_flags_1.default)(node.FinalFields.Flags),
+                        mptIssuanceID,
+                        account,
+                        amount: node.FinalFields.MPTAmount || "0",
+                        lockedAmount: node.FinalFields.LockedAmount,
+                        amountChange,
+                        lockedAmountChange,
+                        flagsChange,
+                    });
+                }
+                if (affectedNode.DeletedNode) {
+                    const mptIssuanceID = node.FinalFields.MPTokenIssuanceID;
+                    const account = node.FinalFields.Account;
+                    this.addChange(mptIssuanceID, account, {
+                        status: "removed",
+                        flags: (0, mptoken_flags_1.default)(node.FinalFields.Flags),
+                        mptIssuanceID,
+                        account,
+                        amount: node.FinalFields.MPTAmount,
+                        lockedAmount: node.FinalFields.LockedAmount,
+                    });
+                }
+            }
+        }
+    }
+}

package/lib/src/parse/outcome/mptoken_issuance_changes.d.ts

@@ -0,0 +1 @@
+export declare function parseMPTokenIssuanceChanges(tx: object): object;

package/lib/src/parse/outcome/mptoken_issuance_changes.js

@@ -0,0 +1,119 @@
+"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 = __importDefault(require("bignumber.js"));
+const common_1 = require("../../common");
+const mptoken_1 = require("../../models/mptoken");
+const mptoken_issuance_flags_1 = __importDefault(require("../ledger/mptoken-issuance-flags"));
+function parseMPTokenIssuanceChanges(tx) {
+    return new MPTokenIssuanceChanges(tx).call();
+}
+class MPTokenIssuanceChanges {
+    constructor(tx) {
+        this.tx = tx;
+        this.changes = {};
+    }
+    call() {
+        if (this.hasAffectedNodes() === false) {
+            return this.changes;
+        }
+        this.parseAffectedNodes();
+        return this.changes;
+    }
+    hasAffectedNodes() {
+        if (this.tx.meta?.AffectedNodes === undefined) {
+            return false;
+        }
+        if (this.tx.meta?.AffectedNodes?.length === 0) {
+            return false;
+        }
+        return true;
+    }
+    addChange(mptIssuanceID, change) {
+        this.changes[mptIssuanceID] = (0, common_1.removeUndefined)(change);
+    }
+    parseAffectedNodes() {
+        for (const affectedNode of this.tx.meta.AffectedNodes) {
+            const node = affectedNode.CreatedNode || affectedNode.ModifiedNode || affectedNode.DeletedNode;
+            if (node?.LedgerEntryType === "MPTokenIssuance" && node?.LedgerIndex) {
+                if (affectedNode.CreatedNode) {
+                    const mptIssuanceID = (0, mptoken_1.buildMPTokenIssuanceID)(node.NewFields.Sequence, node.NewFields.Issuer);
+                    this.addChange(mptIssuanceID, {
+                        status: "added",
+                        flags: (0, mptoken_issuance_flags_1.default)(node.NewFields.Flags),
+                        mptIssuanceID,
+                        issuer: node.NewFields.Issuer,
+                        sequence: node.NewFields.Sequence,
+                        transferFee: node.NewFields.TransferFee,
+                        maximumAmount: node.NewFields.MaximumAmount,
+                        outstandingAmount: node.NewFields.OutstandingAmount,
+                        lockedAmount: node.NewFields.LockedAmount,
+                        metadata: node.NewFields.Metadata,
+                        scale: node.NewFields.AssetScale,
+                    });
+                }
+                if (affectedNode.ModifiedNode) {
+                    const mptIssuanceID = (0, mptoken_1.buildMPTokenIssuanceID)(node.FinalFields.Sequence, node.FinalFields.Issuer);
+                    let outstandingAmountChange = new bignumber_js_1.default(node.FinalFields.OutstandingAmount ?? 0)
+                        .minus(node.PreviousFields.OutstandingAmount ?? 0)
+                        .toString();
+                    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),
+                        mptIssuanceID,
+                        issuer: node.FinalFields.Issuer,
+                        sequence: node.FinalFields.Sequence,
+                        transferFee: node.FinalFields.TransferFee,
+                        maximumAmount: node.FinalFields.MaximumAmount,
+                        outstandingAmount: node.FinalFields.OutstandingAmount,
+                        lockedAmount,
+                        metadata: node.FinalFields.Metadata,
+                        scale: node.FinalFields.AssetScale,
+                        outstandingAmountChange,
+                        lockedAmountChange,
+                        flagsChange,
+                    });
+                }
+                if (affectedNode.DeletedNode) {
+                    const mptIssuanceID = (0, mptoken_1.buildMPTokenIssuanceID)(node.FinalFields.Sequence, node.FinalFields.Issuer);
+                    this.addChange(mptIssuanceID, {
+                        status: "removed",
+                        flags: (0, mptoken_issuance_flags_1.default)(node.FinalFields.Flags),
+                        mptIssuanceID,
+                        issuer: node.FinalFields.Issuer,
+                        sequence: node.FinalFields.Sequence,
+                        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/src/parse/outcome/nftoken_changes.d.ts

@@ -0,0 +1 @@
+export declare function parseNFTokenChanges(tx: object): object;