@bithomp/xrpl-api 2.7.4 → 2.7.5

package/lib/common/index.d.ts

@@ -3,4 +3,5 @@ import sha512Half from "./sha512Half";
 export * from "./utils";
 export { errors, sha512Half };
 export declare const dropsInXRP = 1000000;
+export declare const ACCOUNT_ZERO = "rrrrrrrrrrrrrrrrrrrrrhoLvTp";
 export declare const BLACKHOLE_ACCOUNTS: string[];

package/lib/common/index.js

@@ -29,15 +29,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BLACKHOLE_ACCOUNTS = exports.dropsInXRP = exports.sha512Half = exports.errors = void 0;
+exports.BLACKHOLE_ACCOUNTS = exports.ACCOUNT_ZERO = exports.dropsInXRP = exports.sha512Half = exports.errors = void 0;
 const errors = __importStar(require("./errors"));
 exports.errors = errors;
 const sha512Half_1 = __importDefault(require("./sha512Half"));
 exports.sha512Half = sha512Half_1.default;
 __exportStar(require("./utils"), exports);
 exports.dropsInXRP = 1000000;
+exports.ACCOUNT_ZERO = "rrrrrrrrrrrrrrrrrrrrrhoLvTp";
 exports.BLACKHOLE_ACCOUNTS = [
-    "rrrrrrrrrrrrrrrrrrrrrhoLvTp",
+    exports.ACCOUNT_ZERO,
     "rrrrrrrrrrrrrrrrrrrrBZbvji",
     "rrrrrrrrrrrrrrrrrNAMEtxvNvQ",
     "rrrrrrrrrrrrrrrrrrrn5RM1rHd",

package/lib/ledger/ledger_entry.d.ts

@@ -2,6 +2,11 @@ import { Connection } from "../connection";
 import { LedgerIndex } from "../models/ledger";
 import { URITokenInterface } from "../models/account_uritokens";
 import { ErrorResponse } from "../models/base_model";
+export declare const LEDGER_ENTRY_AMENDMENTS = "7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4";
+export declare const LEDGER_ENTRY_NEGATIVE_UNL = "2E8A59AA9D3B5B186B0B9E0F62E6C02587CA74A4D778938E957B6357D364B244";
+export declare const LEDGER_ENTRY_FEE_SETTINGS = "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A651";
+export declare const LEDGER_ENTRY_LEDGER_HASHES = "B4979A36CDC7F3D3D5C31A4EAE2AC7D7209DDA877588B9AFC66799692AB0D66B";
+export declare const LEDGER_ENTRY_UNL_REPORT = "61E32E7A24A238F1C619D5F9DDCC41A94B33B66C0163F7EFCC8A19C9FD6F28DC";
 export interface GetLedgerEntryOptions {
     ledgerIndex?: LedgerIndex;
     connection?: Connection;

package/lib/ledger/ledger_entry.js

@@ -23,10 +23,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLedgerEntryURIToken = exports.getLedgerEntryAmendments = exports.getLedgerEntry = void 0;
+exports.getLedgerEntryURIToken = exports.getLedgerEntryAmendments = exports.getLedgerEntry = exports.LEDGER_ENTRY_UNL_REPORT = exports.LEDGER_ENTRY_LEDGER_HASHES = exports.LEDGER_ENTRY_FEE_SETTINGS = exports.LEDGER_ENTRY_NEGATIVE_UNL = exports.LEDGER_ENTRY_AMENDMENTS = void 0;
 const Client = __importStar(require("../client"));
 const common_1 = require("../common");
-const LEDGER_ENTRY_AMENDMENTS = "7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4";
+exports.LEDGER_ENTRY_AMENDMENTS = "7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4";
+exports.LEDGER_ENTRY_NEGATIVE_UNL = "2E8A59AA9D3B5B186B0B9E0F62E6C02587CA74A4D778938E957B6357D364B244";
+exports.LEDGER_ENTRY_FEE_SETTINGS = "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A651";
+exports.LEDGER_ENTRY_LEDGER_HASHES = "B4979A36CDC7F3D3D5C31A4EAE2AC7D7209DDA877588B9AFC66799692AB0D66B";
+exports.LEDGER_ENTRY_UNL_REPORT = "61E32E7A24A238F1C619D5F9DDCC41A94B33B66C0163F7EFCC8A19C9FD6F28DC";
 async function getLedgerEntry(ledgerEntry, options = {}) {
     const connection = options.connection || Client.findConnection();
     if (!connection) {
@@ -59,7 +63,7 @@ async function getLedgerEntry(ledgerEntry, options = {}) {
 }
 exports.getLedgerEntry = getLedgerEntry;
 async function getLedgerEntryAmendments(options = {}) {
-    const response = await getLedgerEntry(LEDGER_ENTRY_AMENDMENTS, options);
+    const response = await getLedgerEntry(exports.LEDGER_ENTRY_AMENDMENTS, options);
     if (!response || !response.node) {
         return {
             status: "error",

package/lib/models/ledger.d.ts

@@ -1,3 +1,4 @@
+export declare const RIPPLE_UNIX_DIFF = 946684800;
 export type LedgerIndex = number | ("validated" | "closed" | "current");
 export type StreamType = "consensus" | "ledger" | "manifests" | "peer_status" | "transactions" | "transactions_proposed" | "server" | "validations";
 export declare function unixTimeToLedgerTime(time: number): number;

package/lib/models/ledger.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ledgerTimeToISO8601 = exports.ledgerTimeToTimestamp = exports.ledgerTimeToUnixTime = exports.unixTimeToLedgerTime = void 0;
-const RIPPLE_UNIX_DIFF = 946684800;
+exports.ledgerTimeToISO8601 = exports.ledgerTimeToTimestamp = exports.ledgerTimeToUnixTime = exports.unixTimeToLedgerTime = exports.RIPPLE_UNIX_DIFF = void 0;
+exports.RIPPLE_UNIX_DIFF = 946684800;
 function unixTimeToLedgerTime(time) {
-    return time - RIPPLE_UNIX_DIFF;
+    return time - exports.RIPPLE_UNIX_DIFF;
 }
 exports.unixTimeToLedgerTime = unixTimeToLedgerTime;
 function ledgerTimeToUnixTime(ledgerTime) {
-    return ledgerTime + RIPPLE_UNIX_DIFF;
+    return ledgerTime + exports.RIPPLE_UNIX_DIFF;
 }
 exports.ledgerTimeToUnixTime = ledgerTimeToUnixTime;
 function ledgerTimeToTimestamp(ledgerTime) {

package/lib/parse/ledger/account.d.ts

@@ -0,0 +1 @@
+export declare function parseAccount(account: string): string;

package/lib/parse/ledger/account.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseAccount = void 0;
+const common_1 = require("../../common");
+function parseAccount(account) {
+    return account === "" ? common_1.ACCOUNT_ZERO : account;
+}
+exports.parseAccount = parseAccount;

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

@@ -1,5 +1,5 @@
 import { FormattedSourceAddress, FormattedDestinationAddress } from "../../v1/common/types/objects/account";
-interface FormattedEscrowInterface {
+interface FormattedEscrowSummaryInterface {
     status?: string;
     escrowIndex?: number;
     escrowSequence?: number;
@@ -12,5 +12,5 @@ interface FormattedEscrowInterface {
     previousTxnID?: string;
     previousTxnLgrSeq?: number;
 }
-declare function parseEscrowChanges(tx: any): FormattedEscrowInterface | undefined;
+declare function parseEscrowChanges(tx: any): FormattedEscrowSummaryInterface | undefined;
 export { parseEscrowChanges };

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

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

package/lib/parse/outcome/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseEscrowChanges = exports.parseEmittedTxns = exports.parseHooksExecutions = exports.parseOrderbookChanges = exports.parseChannelChanges = exports.parseLockedBalanceChanges = exports.parseBalanceChanges = exports.parseURITokenSellOfferChanges = exports.parseURITokenChanges = exports.parseNFTokenOfferChanges = exports.parseNFTokenChanges = exports.parseAffectedObjects = void 0;
+exports.parseUNLReportChanges = exports.parseEscrowChanges = exports.parseEmittedTxns = exports.parseHooksExecutions = exports.parseOrderbookChanges = 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");
@@ -25,3 +25,5 @@ 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; } });

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

@@ -0,0 +1,13 @@
+interface FormattedUNLReportSummaryInterface {
+    status: "added";
+    activeValidator?: {
+        account: string;
+        publicKey: string;
+    };
+    importVLKey?: {
+        account: string;
+        publicKey: string;
+    };
+}
+declare function parseUNLReportChanges(tx: any): FormattedUNLReportSummaryInterface | undefined;
+export { parseUNLReportChanges };

package/lib/parse/outcome/unl_report_changes.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseUNLReportChanges = void 0;
+const common_1 = require("../../common");
+const utils_1 = require("../../v1/common/utils");
+function summarizeUNLReport(tx, node) {
+    const final = node.diffType === "CreatedNode" ? node.newFields : node.finalFields;
+    if (tx.ImportVLKey && final.ImportVLKeys) {
+        for (const vlKey of final.ImportVLKeys) {
+            if (vlKey.ImportVLKey.PublicKey === tx.ImportVLKey.PublicKey) {
+                const summary = {
+                    status: "added",
+                    importVLKey: {
+                        account: vlKey.ImportVLKey.Account,
+                        publicKey: vlKey.ImportVLKey.PublicKey,
+                    },
+                };
+                return (0, common_1.removeUndefined)(summary);
+            }
+        }
+    }
+    if (tx.ActiveValidator && final.ActiveValidators) {
+        for (const activeValidator of final.ActiveValidators) {
+            if (activeValidator.ActiveValidator.PublicKey === tx.ActiveValidator.PublicKey) {
+                const summary = {
+                    status: "added",
+                    activeValidator: {
+                        account: activeValidator.ActiveValidator.Account,
+                        publicKey: activeValidator.ActiveValidator.PublicKey,
+                    },
+                };
+                return (0, common_1.removeUndefined)(summary);
+            }
+        }
+    }
+    return undefined;
+}
+function parseUNLReportChanges(tx) {
+    const escrows = (0, utils_1.normalizeNodes)(tx.meta).filter((n) => {
+        return n.entryType === "UNLReport";
+    });
+    return escrows.length === 1 ? summarizeUNLReport(tx, escrows[0]) : undefined;
+}
+exports.parseUNLReportChanges = parseUNLReportChanges;

package/lib/parse/outcome.js

@@ -77,6 +77,7 @@ function parseOutcome(tx, nativeCurrency, definitions) {
     const affectedObjects = (0, index_1.parseAffectedObjects)(tx);
     const hooksExecutions = (0, index_1.parseHooksExecutions)(tx);
     const emittedTxns = (0, index_1.parseEmittedTxns)(tx, definitions);
+    const unlReportChanges = (0, index_1.parseUNLReportChanges)(tx);
     removeEmptyCounterpartyInBalanceChanges(balanceChanges);
     removeEmptyCounterpartyInBalanceChanges(lockedBalanceChanges);
     removeEmptyCounterpartyInOrderbookChanges(orderbookChanges);
@@ -94,6 +95,7 @@ function parseOutcome(tx, nativeCurrency, definitions) {
         uritokenChanges: Object.keys(uritokenChanges).length > 0 ? uritokenChanges : undefined,
         uritokenSellOfferChanges: Object.keys(uritokenSellOfferChanges).length > 0 ? uritokenSellOfferChanges : undefined,
         affectedObjects: affectedObjects ? (0, common_1.removeUndefined)(affectedObjects) : undefined,
+        unlReportChanges,
         hooksExecutions,
         emittedTxns,
         ledgerVersion: tx.ledger_index,

package/lib/parse/specification/unl-report.d.ts

@@ -0,0 +1,3 @@
+import { FormattedUNLReportSpecification } from "../../v1/common/types/objects/unl_report";
+declare function parseImport(tx: any): FormattedUNLReportSpecification;
+export default parseImport;

package/lib/parse/specification/unl-report.js

@@ -0,0 +1,47 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __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 common_1 = require("../../common");
+const memos_1 = __importDefault(require("../ledger/memos"));
+const account_1 = require("../ledger/account");
+function parseImport(tx) {
+    assert.ok(tx.TransactionType === "UNLReport");
+    const source = {
+        address: (0, account_1.parseAccount)(tx.Account),
+    };
+    const activeValidator = tx.ActiveValidator?.PublicKey;
+    const importVLKey = tx.ImportVLKey?.PublicKey;
+    return (0, common_1.removeUndefined)({
+        source: (0, common_1.removeUndefined)(source),
+        activeValidator,
+        importVLKey,
+        memos: (0, memos_1.default)(tx),
+    });
+}
+exports.default = parseImport;

package/lib/parse/transaction.d.ts

@@ -14,10 +14,11 @@ import { FormattedNFTokenBurnSpecification, FormattedNFTokenMintSpecification, F
 import { FormattedURITokenBurnSpecification, FormattedURITokenBuySpecification, FormattedURITokenCreateSellOfferSpecification, FormattedURITokenCancelSellOfferSpecification, FormattedURITokenMintSpecification } from "../v1/common/types/objects/uritokens";
 import { FormattedImportSpecification } from "../v1/common/types/objects/import";
 import { FormattedInvokeSpecification } from "../v1/common/types/objects/invoke";
+import { FormattedUNLReportSpecification } from "../v1/common/types/objects/unl_report";
 import { FormattedAmendmentSpecification } from "../v1/common/types/objects/amendments";
 import { FormattedFeeUpdateSpecification } from "../v1/common/types/objects/fees";
 declare function parseTransactionType(type: string): string;
-export type FormattedSpecification = FormattedSettingsSpecification | FormattedAccountDeleteSpecification | FormattedCheckCancelSpecification | FormattedCheckCashSpecification | FormattedCheckCreateSpecification | FormattedDepositPreauthSpecification | FormattedEscrowCancelSpecification | FormattedEscrowCreateSpecification | FormattedEscrowFinishSpecification | FormattedOfferCancelSpecification | FormattedOfferCreateSpecification | FormattedPaymentSpecification | FormattedPaymentChannelClaimSpecification | FormattedPaymentChannelCreateSpecification | FormattedPaymentChannelFundSpecification | FormattedTicketCreateSpecification | FormattedTrustlineSpecification | FormattedNFTokenBurnSpecification | FormattedNFTokenMintSpecification | FormattedNFTokenCancelOfferSpecification | FormattedNFTokenCreateOfferSpecification | FormattedNFTokenAcceptOfferSpecification | FormattedURITokenBurnSpecification | FormattedURITokenBuySpecification | FormattedURITokenCreateSellOfferSpecification | FormattedURITokenCancelSellOfferSpecification | FormattedURITokenMintSpecification | FormattedImportSpecification | FormattedInvokeSpecification | FormattedAmendmentSpecification | FormattedFeeUpdateSpecification;
+export type FormattedSpecification = FormattedSettingsSpecification | FormattedAccountDeleteSpecification | FormattedCheckCancelSpecification | FormattedCheckCashSpecification | FormattedCheckCreateSpecification | FormattedDepositPreauthSpecification | FormattedEscrowCancelSpecification | FormattedEscrowCreateSpecification | FormattedEscrowFinishSpecification | FormattedOfferCancelSpecification | FormattedOfferCreateSpecification | FormattedPaymentSpecification | FormattedPaymentChannelClaimSpecification | FormattedPaymentChannelCreateSpecification | FormattedPaymentChannelFundSpecification | FormattedTicketCreateSpecification | FormattedTrustlineSpecification | FormattedNFTokenBurnSpecification | FormattedNFTokenMintSpecification | FormattedNFTokenCancelOfferSpecification | FormattedNFTokenCreateOfferSpecification | FormattedNFTokenAcceptOfferSpecification | FormattedURITokenBurnSpecification | FormattedURITokenBuySpecification | FormattedURITokenCreateSellOfferSpecification | FormattedURITokenCancelSellOfferSpecification | FormattedURITokenMintSpecification | FormattedImportSpecification | FormattedInvokeSpecification | FormattedUNLReportSpecification | FormattedAmendmentSpecification | FormattedFeeUpdateSpecification;
 export interface FormattedTransaction {
     type: string;
     address: string;

package/lib/parse/transaction.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseTransaction = exports.parseTransactionType = void 0;
 const common_1 = require("../common");
+const account_1 = require("./ledger/account");
 const outcome_1 = require("./outcome");
 const settings_1 = __importDefault(require("./specification/settings"));
 const account_delete_1 = __importDefault(require("./specification/account-delete"));
@@ -35,6 +36,7 @@ const uritoken_create_sell_offer_1 = __importDefault(require("./specification/ur
 const uritoken_mint_1 = __importDefault(require("./specification/uritoken-mint"));
 const import_1 = __importDefault(require("./specification/import"));
 const invoke_1 = __importDefault(require("./specification/invoke"));
+const unl_report_1 = __importDefault(require("./specification/unl-report"));
 const amendment_1 = __importDefault(require("./specification/amendment"));
 const fee_update_1 = __importDefault(require("./specification/fee-update"));
 const transactionTypeToType = {
@@ -69,6 +71,7 @@ const transactionTypeToType = {
     URITokenBuy: "uritokenBuy",
     Import: "import",
     Invoke: "invoke",
+    UNLReport: "unlReport",
     EnableAmendment: "amendment",
     SetFee: "feeUpdate",
 };
@@ -106,6 +109,7 @@ const parserTypeFunc = {
     uritokenMint: uritoken_mint_1.default,
     import: import_1.default,
     invoke: invoke_1.default,
+    unlReport: unl_report_1.default,
     amendment: amendment_1.default,
     feeUpdate: fee_update_1.default,
 };
@@ -124,7 +128,7 @@ function parseTransaction(tx, includeRawTransaction, nativeCurrency, definitions
     const outcome = (0, outcome_1.parseOutcome)(tx, nativeCurrency, definitions);
     return (0, common_1.removeUndefined)({
         type: type,
-        address: tx.Account,
+        address: (0, account_1.parseAccount)(tx.Account),
         sequence: tx.Sequence,
         id: tx.hash,
         specification: (0, common_1.removeUndefined)(specification),

package/lib/v1/common/types/objects/unl_report.d.ts

@@ -0,0 +1,7 @@
+import { FormattedBaseSpecification } from "./specification";
+import { FormattedSourceAddress } from "./account";
+export type FormattedUNLReportSpecification = {
+    source: FormattedSourceAddress;
+    activeValidator?: string;
+    importVLKey?: string;
+} & FormattedBaseSpecification;

package/lib/v1/common/types/objects/unl_report.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/v1/transaction/types.d.ts

@@ -30,6 +30,8 @@ export type Outcome = {
     channelChanges?: object;
     nftokenChanges?: object;
     nftokenOfferChanges?: object;
+    uritokenChanges?: object;
+    uritokenSellOfferChanges?: object;
     affectedObjects?: object;
     deliveredAmount?: {
         currency: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "2.7.4",
+  "version": "2.7.5",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -22,7 +22,8 @@
     "xls20",
     "xls35",
     "unl",
-    "bithomp"
+    "bithomp",
+    "xahau"
   ],
   "funding": {
     "type": "individual",
@@ -53,8 +54,8 @@
     "elliptic": "^6.5.4",
     "lodash": "^4.17.21",
     "ripple-address-codec": "^4.3.1",
-    "ripple-binary-codec": "^1.10.0",
-    "xrpl": "^2.13.0"
+    "ripple-binary-codec": "^1.11.0",
+    "xrpl": "^2.14.0"
   },
   "devDependencies": {
     "@types/chai": "^4.3.10",