@bithomp/xrpl-api 3.7.6 → 3.7.9

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

@@ -0,0 +1,8 @@
+type AmendmentStatus = "majority" | "enabled" | "lostMajority" | "obsolete";
+interface FormattedAmendmentSummaryInterface {
+    status?: AmendmentStatus;
+    amendment?: string;
+    closeTime?: number;
+}
+declare function parseAmendmentChanges(tx: any): FormattedAmendmentSummaryInterface | undefined;
+export { parseAmendmentChanges };

package/lib/parse/outcome/amendment_changes.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseAmendmentChanges = parseAmendmentChanges;
+const utils_1 = require("../utils");
+const ledger_1 = require("../../models/ledger");
+function parseAmendmentStatus(tx, node) {
+    const amendment = tx.Amendment;
+    const final = node.diffType === "CreatedNode" ? node.newFields : node.finalFields;
+    const prev = node.previousFields;
+    const amendments = final.Amendments || [];
+    const majority = final.Majorities || [];
+    if (amendments.includes(amendment)) {
+        return "enabled";
+    }
+    for (const maj of majority) {
+        if (maj.Majority.Amendment === amendment) {
+            return "majority";
+        }
+    }
+    if (prev && prev.Majorities) {
+        const prevMajority = prev.Majorities;
+        for (const maj of prevMajority) {
+            if (maj.Majority.Amendment === amendment) {
+                return "lostMajority";
+            }
+        }
+    }
+    if (node.diffType === "DeletedNode") {
+        const prevFinal = node.finalFields;
+        const prevAmendments = prevFinal.Amendments || [];
+        if (!prevAmendments.includes(amendment)) {
+            return "obsolete";
+        }
+    }
+    return undefined;
+}
+function summarizeAmendment(tx, node) {
+    const summary = {
+        amendment: tx.Amendment,
+        status: parseAmendmentStatus(tx, node),
+    };
+    if (summary.status === "majority") {
+        const final = node.diffType === "CreatedNode" ? node.newFields : node.finalFields;
+        const majority = final.Majorities || [];
+        for (const maj of majority) {
+            if (maj.Majority.Amendment === tx.Amendment) {
+                if (maj.Majority.CloseTime) {
+                    summary.closeTime = (0, ledger_1.ledgerTimeToTimestamp)(maj.Majority.CloseTime);
+                }
+                break;
+            }
+        }
+    }
+    else if (summary.status === "lostMajority") {
+        const prev = node.previousFields;
+        if (prev && prev.Majorities) {
+            const prevMajority = prev.Majorities;
+            for (const maj of prevMajority) {
+                if (maj.Majority.Amendment === tx.Amendment) {
+                    if (maj.Majority.CloseTime) {
+                        summary.closeTime = (0, ledger_1.ledgerTimeToTimestamp)(maj.Majority.CloseTime);
+                    }
+                    break;
+                }
+            }
+        }
+    }
+    return summary;
+}
+function parseAmendmentChanges(tx) {
+    const amendment = tx.Amendment;
+    if (!amendment) {
+        return undefined;
+    }
+    const affectedNodes = tx.meta.AffectedNodes.filter((affectedNode) => {
+        const node = affectedNode.CreatedNode || affectedNode.ModifiedNode || affectedNode.DeletedNode;
+        return node.LedgerEntryType === "Amendments";
+    });
+    if (affectedNodes.length !== 1) {
+        return undefined;
+    }
+    const normalizedNode = (0, utils_1.normalizeNode)(affectedNodes[0]);
+    return summarizeAmendment(tx, normalizedNode);
+}

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

@@ -21,3 +21,4 @@ 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";

package/lib/parse/outcome/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+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");
@@ -47,3 +47,5 @@ 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; } });

package/lib/parse/outcome.js

@@ -42,6 +42,7 @@ const MPTOKEN_TYPES = [
 const CREDENTIAL_TYPES = ["CredentialCreate", "CredentialAccept", "CredentialDelete"];
 const DELEGATE_TYPES = ["DelegateSet"];
 const REMARKS_TYPES = ["SetRemarks"];
+const AMENDMENT_TYPES = ["EnableAmendment"];
 function parseOutcome(tx, nativeCurrency, definitions) {
     const metadata = tx.meta || tx.metaData;
     if (!metadata) {
@@ -58,6 +59,7 @@ function parseOutcome(tx, nativeCurrency, definitions) {
         channelChanges: getChannelChanges(tx),
         checkChanges: getCheckChanges(tx),
         escrowChanges: getEscrowChanges(tx),
+        amendmentChanges: getAmendmentChanges(tx),
         nftokenChanges: getNFTokenChanges(tx),
         nftokenOfferChanges: getNFTokenOfferChanges(tx),
         uritokenChanges: getURITokenChanges(tx),
@@ -114,6 +116,12 @@ function getEscrowChanges(tx) {
     }
     return (0, index_1.parseEscrowChanges)(tx);
 }
+function getAmendmentChanges(tx) {
+    if (!AMENDMENT_TYPES.includes(tx.TransactionType)) {
+        return undefined;
+    }
+    return (0, index_1.parseAmendmentChanges)(tx);
+}
 function getAffectedObjects(tx) {
     if (!NFTOKEN_TYPES.includes(tx.TransactionType) && !URITOKEN_TYPES.includes(tx.TransactionType)) {
         return undefined;

package/lib/parse/specification/fee-update.js

@@ -1,21 +1,67 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const assert = __importStar(require("assert"));
 const bignumber_js_1 = __importDefault(require("bignumber.js"));
 const common_1 = require("../../common");
 const emit_details_1 = require("../ledger/emit_details");
 const memos_1 = require("../ledger/memos");
 const source_1 = require("../ledger/source");
 function parseFeeUpdate(tx) {
-    const baseFeeDrops = new bignumber_js_1.default(tx.BaseFee, 16).toString();
+    assert.ok(tx.TransactionType === "SetFee");
+    let baseFeeDrops = "0";
+    if (tx.BaseFeeDrops) {
+        baseFeeDrops = tx.BaseFeeDrops;
+    }
+    else if (tx.BaseFee) {
+        baseFeeDrops = new bignumber_js_1.default(tx.BaseFee, 16).toString();
+    }
+    const baseFeeNativeCurrency = (0, common_1.dropsToXrp)(baseFeeDrops);
+    const reserveBaseNativeCurrency = (0, common_1.dropsToXrp)(tx.ReserveBase || tx.ReserveBaseDrops);
+    const reserveIncrementNativeCurrency = (0, common_1.dropsToXrp)(tx.ReserveIncrement || tx.ReserveIncrementDrops);
     return {
         source: (0, source_1.parseSource)(tx),
-        baseFeeXRP: (0, common_1.dropsToXrp)(baseFeeDrops),
-        referenceFeeUnits: tx.ReferenceFeeUnits,
-        reserveBaseXRP: (0, common_1.dropsToXrp)(tx.ReserveBase),
-        reserveIncrementXRP: (0, common_1.dropsToXrp)(tx.ReserveIncrement),
+        baseFeeXRP: baseFeeNativeCurrency,
+        reserveBaseXRP: reserveBaseNativeCurrency,
+        reserveIncrementXRP: reserveIncrementNativeCurrency,
+        baseFeeNativeCurrency,
+        reserveBaseNativeCurrency,
+        reserveIncrementNativeCurrency,
         emittedDetails: (0, emit_details_1.parseEmittedDetails)(tx),
         memos: (0, memos_1.parseMemos)(tx),
     };

package/lib/types/fees.d.ts

@@ -1,7 +1,9 @@
 import { FormattedBaseSpecification } from "./specification";
 export type FormattedFeeUpdateSpecification = {
+    baseFeeNativeCurrency: string;
+    reserveBaseNativeCurrency: string;
+    reserveIncrementNativeCurrency: string;
     baseFeeXRP: string;
-    referenceFeeUnits: number;
     reserveBaseXRP: string;
     reserveIncrementXRP: string;
 } & FormattedBaseSpecification;

package/lib/types/ledger_entries.d.ts

@@ -18,10 +18,16 @@ export interface AccountRootLedgerEntry {
     TransferRate?: number;
     WalletLocator?: string;
 }
+export interface AmendmentsMajority {
+    Majority: {
+        Amendment?: string;
+        CloseTime?: number;
+    };
+}
 export interface AmendmentsLedgerEntry {
     LedgerEntryType: "Amendments";
     Amendments?: string[];
-    Majorities?: any[];
+    Majorities?: AmendmentsMajority[];
     Flags: 0;
 }
 export interface CheckLedgerEntry {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "3.7.6",
+  "version": "3.7.9",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -42,7 +42,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"