@bithomp/xrpl-api 3.0.9 → 3.1.0

package/lib/connection.d.ts

@@ -1,10 +1,12 @@
 import { EventEmitter } from "events";
-import { Request, Response } from "xrpl";
+import { Request, Response, APIVersion } from "xrpl";
+export declare const DEFAULT_API_VERSION = 1;
 export interface ConnectionOptions {
     logger?: any;
     timeout?: number;
     connectionTimeout?: number;
     networkID?: number;
+    apiVersion?: APIVersion;
 }
 export interface LatencyInfo {
     timestamp: Date;
@@ -34,6 +36,7 @@ declare class Connection extends EventEmitter {
     readonly connectionTimeout: number;
     readonly hash?: string;
     private networkID?;
+    private apiVersion;
     private serverInfoUpdating;
     serverInfo: any;
     private shutdown;

package/lib/connection.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Connection = void 0;
+exports.Connection = exports.DEFAULT_API_VERSION = void 0;
 const crypto_1 = __importDefault(require("crypto"));
 const events_1 = require("events");
 const xrpl_1 = require("xrpl");
@@ -14,6 +14,7 @@ const RECONNECT_TIMEOUT = 1000 * 5;
 const LEDGER_CLOSED_TIMEOUT = 1000 * 15;
 const SERVER_INFO_UPDATE_INTERVAL = 1000 * 60 * 5;
 const AVAILABLE_LEDGER_INDEX_WINDOW = 1000;
+exports.DEFAULT_API_VERSION = xrpl_1.RIPPLED_API_V1;
 class Connection extends events_1.EventEmitter {
     constructor(url, type, options = {}) {
         super();
@@ -38,6 +39,7 @@ class Connection extends events_1.EventEmitter {
         if (typeof options.networkID === "number") {
             this.networkID = options.networkID;
         }
+        this.apiVersion = options.apiVersion || exports.DEFAULT_API_VERSION;
         this.serverInfoUpdating = false;
         this.serverInfo = null;
         this.streams = {
@@ -56,6 +58,7 @@ class Connection extends events_1.EventEmitter {
             });
             await this.removeClient();
             this.client = new xrpl_1.Client(this.url, (0, common_1.removeUndefined)({ timeout: this.timeout, connectionTimeout: this.connectionTimeout }));
+            this.client.apiVersion = this.apiVersion;
             this.setupEmitter();
             await this.client.connect();
             await this.updateServerInfo();

package/lib/parse/ledger/genesis-mints.d.ts

@@ -0,0 +1,2 @@
+import { FormattedGenesisMint } from "../../types/genesis_mint";
+export declare function parseGenesisMints(tx: any): FormattedGenesisMint[] | undefined;

package/lib/parse/ledger/genesis-mints.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseGenesisMints = parseGenesisMints;
+const amount_1 = __importDefault(require("./amount"));
+function parseGenesisMints(tx) {
+    if (tx && tx.GenesisMints) {
+        return tx.GenesisMints.map((m) => {
+            return {
+                amount: (0, amount_1.default)(m.GenesisMint.Amount),
+                destination: m.GenesisMint.Destination,
+            };
+        });
+    }
+}

package/lib/parse/specification/genesis-mint.d.ts

@@ -0,0 +1,3 @@
+import { FormattedGenesisMintSpecification } from "../../types/genesis_mint";
+declare function parseGenesisMint(tx: any): FormattedGenesisMintSpecification;
+export default parseGenesisMint;

package/lib/parse/specification/genesis-mint.js

@@ -0,0 +1,39 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert = __importStar(require("assert"));
+const common_1 = require("../../common");
+const emit_details_1 = require("../ledger/emit_details");
+const memos_1 = require("../ledger/memos");
+const genesis_mints_1 = require("../ledger/genesis-mints");
+function parseGenesisMint(tx) {
+    assert.ok(tx.TransactionType === "GenesisMint");
+    return (0, common_1.removeUndefined)({
+        genesisMints: (0, genesis_mints_1.parseGenesisMints)(tx),
+        emittedDetails: (0, emit_details_1.parseEmittedDetails)(tx),
+        memos: (0, memos_1.parseMemos)(tx),
+    });
+}
+exports.default = parseGenesisMint;

package/lib/parse/transaction.d.ts

@@ -18,10 +18,11 @@ import { FormattedUNLReportSpecification } from "../types/unl_reports";
 import { FormattedRemitsSpecification } from "../types/remits";
 import { FormattedClawbackSpecification } from "../types/clawback";
 import { FormattedAmmBidSpecification, FormattedAmmCreateSpecification, FormattedAmmDeleteSpecification, FormattedAmmDepositSpecification, FormattedAmmWithdrawSpecification, FormattedAmmVoteSpecification } from "../types/amm";
+import { FormattedGenesisMintSpecification } from "../types/genesis_mint";
 import { FormattedAmendmentSpecification } from "../types/amendments";
 import { FormattedFeeUpdateSpecification } from "../types/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 | FormattedUNLReportSpecification | FormattedRemitsSpecification | FormattedClawbackSpecification | FormattedAmmBidSpecification | FormattedAmmCreateSpecification | FormattedAmmDeleteSpecification | FormattedAmmDepositSpecification | FormattedAmmWithdrawSpecification | FormattedAmmVoteSpecification | 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 | FormattedRemitsSpecification | FormattedClawbackSpecification | FormattedAmmBidSpecification | FormattedAmmCreateSpecification | FormattedAmmDeleteSpecification | FormattedAmmDepositSpecification | FormattedAmmWithdrawSpecification | FormattedAmmVoteSpecification | FormattedGenesisMintSpecification | FormattedAmendmentSpecification | FormattedFeeUpdateSpecification;
 export interface FormattedTransaction {
     type: string;
     address: string;

package/lib/parse/transaction.js

@@ -46,6 +46,7 @@ const amm_delete_1 = __importDefault(require("./specification/amm-delete"));
 const amm_deposit_1 = __importDefault(require("./specification/amm-deposit"));
 const amm_withdraw_1 = __importDefault(require("./specification/amm-withdraw"));
 const amm_vote_1 = __importDefault(require("./specification/amm-vote"));
+const genesis_mint_1 = __importDefault(require("./specification/genesis-mint"));
 const amendment_1 = __importDefault(require("./specification/amendment"));
 const fee_update_1 = __importDefault(require("./specification/fee-update"));
 const transactionTypeToType = {
@@ -89,6 +90,7 @@ const transactionTypeToType = {
     AMMDeposit: "ammDeposit",
     AMMWithdraw: "ammWithdraw",
     AMMVote: "ammVote",
+    GenesisMint: "genesisMint",
     EnableAmendment: "amendment",
     SetFee: "feeUpdate",
 };
@@ -134,6 +136,7 @@ const parserTypeFunc = {
     ammDeposit: amm_deposit_1.default,
     ammWithdraw: amm_withdraw_1.default,
     ammVote: amm_vote_1.default,
+    genesisMint: genesis_mint_1.default,
     amendment: amendment_1.default,
     feeUpdate: fee_update_1.default,
 };

package/lib/types/genesis_mint.d.ts

@@ -0,0 +1,9 @@
+import { FormattedAmount } from "./amounts";
+import { FormattedBaseSpecification } from "./specification";
+export type FormattedGenesisMint = {
+    amount: FormattedAmount;
+    destination: string;
+};
+export type FormattedGenesisMintSpecification = {
+    genesisMints?: FormattedGenesisMint[];
+} & FormattedBaseSpecification;

package/lib/types/genesis_mint.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "3.0.9",
+  "version": "3.1.0",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -11,19 +11,23 @@
     "url": "git+https://github.com/Bithomp/xrpl-api.git"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
   "keywords": [
     "xrpl",
-    "ws",
+    "rippled",
+    "clio",
     "xrp",
-    "xah",
     "nft",
     "xls20",
     "xls35",
     "unl",
     "bithomp",
-    "xahau"
+    "xahau",
+    "xahaud",
+    "xah",
+    "hooks",
+    "ws"
   ],
   "funding": {
     "type": "individual",
@@ -51,21 +55,21 @@
     "axios": "^1.7.2",
     "base-x": "^5.0.0",
     "bignumber.js": "^9.1.2",
-    "elliptic": "^6.5.5",
+    "elliptic": "^6.5.6",
     "lodash": "^4.17.21",
     "ripple-address-codec": "^5.0.0",
     "ripple-binary-codec": "^2.1.0",
-    "xrpl": "^3.1.0"
+    "xrpl": "^4.0.0"
   },
   "devDependencies": {
     "@types/chai": "^4.3.16",
     "@types/chai-as-promised": "^7.1.8",
-    "@types/lodash": "^4.17.6",
+    "@types/lodash": "^4.17.7",
     "@types/mocha": "^10.0.7",
     "@types/nconf": "^0.10.6",
-    "@types/node": "^20.14.10",
-    "@typescript-eslint/eslint-plugin": "^7.16.0",
-    "@typescript-eslint/parser": "^7.16.0",
+    "@types/node": "^20.14.11",
+    "@typescript-eslint/eslint-plugin": "^7.16.1",
+    "@typescript-eslint/parser": "^7.16.1",
     "chai": "^4.4.1",
     "chai-as-promised": "^7.1.2",
     "eslint": "^8.57.0",