@bithomp/xrpl-api 3.7.31 → 3.7.37

package/lib/src/ledger/ledger_entry.d.ts

@@ -0,0 +1,16 @@
+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;
+}
+export declare function getLedgerEntry(ledgerEntry: string, options?: GetLedgerEntryOptions): Promise<any | ErrorResponse>;
+export declare function getLedgerEntryAmendments(options?: GetLedgerEntryOptions): Promise<any | ErrorResponse>;
+export declare function getLedgerEntryURIToken(uriTokenID: string, options?: GetLedgerEntryOptions): Promise<URITokenInterface | ErrorResponse>;

package/lib/src/ledger/ledger_entry.js

@@ -0,0 +1,118 @@
+"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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+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;
+exports.getLedgerEntry = getLedgerEntry;
+exports.getLedgerEntryAmendments = getLedgerEntryAmendments;
+exports.getLedgerEntryURIToken = getLedgerEntryURIToken;
+const Client = __importStar(require("../client"));
+const common_1 = require("../common");
+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) {
+        throw new Error("There is no connection");
+    }
+    const response = await connection.request({
+        command: "ledger_entry",
+        index: ledgerEntry,
+        ledger_index: options.ledgerIndex || "validated",
+    });
+    if (!response) {
+        return {
+            ledger_entry: ledgerEntry,
+            status: "error",
+            error: "invalidResponse",
+        };
+    }
+    if (response.error) {
+        const { error, error_code, error_message, error_exception, status, validated } = response;
+        return (0, common_1.removeUndefined)({
+            ledger_entry: ledgerEntry,
+            error,
+            error_code,
+            error_message,
+            error_exception,
+            status,
+            validated,
+        });
+    }
+    return response?.result;
+}
+async function getLedgerEntryAmendments(options = {}) {
+    const response = await getLedgerEntry(exports.LEDGER_ENTRY_AMENDMENTS, options);
+    if (!response || !response.node) {
+        return {
+            status: "error",
+            error: "invalidResponse",
+        };
+    }
+    if (response.error) {
+        return response;
+    }
+    return response?.node;
+}
+async function getLedgerEntryURIToken(uriTokenID, options = {}) {
+    const response = await getLedgerEntry(uriTokenID, options);
+    if (!response || !response.node) {
+        return {
+            status: "error",
+            error: "invalidResponse",
+        };
+    }
+    if (response.error) {
+        return response;
+    }
+    if (response.node.LedgerEntryType !== "URIToken") {
+        return {
+            status: "error",
+            error: "invalidLedgerEntry",
+        };
+    }
+    return (0, common_1.removeUndefined)({
+        Digest: response.node.Digest,
+        Flags: response.node.Flags,
+        Issuer: response.node.Issuer,
+        Owner: response.node.Owner,
+        URITokenID: response.node.index,
+        URI: response.node.URI,
+        Amount: response.node.Amount,
+        Destination: response.node.Destination,
+    });
+}

package/lib/src/ledger/manifest.d.ts

@@ -0,0 +1,8 @@
+import { Connection } from "../connection";
+import { LedgerIndex } from "../models/ledger";
+import { ErrorResponse } from "../models/base_model";
+export interface GetManifestOptions {
+    ledgerIndex?: LedgerIndex;
+    connection?: Connection;
+}
+export declare function getManifest(publicKey: string, options?: GetManifestOptions): Promise<object | ErrorResponse>;

package/lib/src/ledger/manifest.js

@@ -0,0 +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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getManifest = getManifest;
+const Client = __importStar(require("../client"));
+const utils_1 = require("../common/utils");
+async function getManifest(publicKey, options = {}) {
+    const connection = options.connection || Client.findConnection("manifest");
+    if (!connection) {
+        throw new Error("There is no connection");
+    }
+    const response = await connection.request({
+        command: "manifest",
+        public_key: publicKey,
+    });
+    if (!response) {
+        return {
+            public_key: publicKey,
+            status: "error",
+            error: "invalidResponse",
+        };
+    }
+    if (response.error) {
+        const { error, error_code, error_message, error_exception, status, validated } = response;
+        return (0, utils_1.removeUndefined)({
+            error,
+            error_code,
+            error_message,
+            error_exception,
+            status,
+            validated,
+        });
+    }
+    return response?.result;
+}

package/lib/src/ledger/nft_info.d.ts

@@ -0,0 +1,4 @@
+import { ErrorResponse } from "../models/base_model";
+export interface GetNftInfoOptions {
+}
+export declare function getNftInfo(nft_id: string, _options?: GetNftInfoOptions): Promise<object | ErrorResponse>;

package/lib/src/ledger/nft_info.js

@@ -0,0 +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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNftInfo = getNftInfo;
+const Client = __importStar(require("../client"));
+const utils_1 = require("../common/utils");
+async function getNftInfo(nft_id, _options = {}) {
+    const connection = Client.findConnection("clio", undefined, true);
+    if (!connection) {
+        throw new Error("There is no connection");
+    }
+    const response = await connection.request({
+        command: "nft_info",
+        nft_id,
+    });
+    if (!response) {
+        return {
+            nft_id,
+            status: "error",
+            error: "invalidResponse",
+        };
+    }
+    if (response.error) {
+        const { error, error_code, error_message, error_exception, status, validated } = response;
+        return (0, utils_1.removeUndefined)({
+            error,
+            error_code,
+            error_message,
+            error_exception,
+            status,
+            validated,
+        });
+    }
+    return response?.result;
+}

package/lib/src/ledger/server_definitions.d.ts

@@ -0,0 +1,7 @@
+import { Connection } from "../connection";
+import { ErrorResponse } from "../models/base_model";
+import { ServerDefinitionsResponseResult } from "../models/server_definitions";
+export interface GetServerDefinitionsOptions {
+    connection?: Connection;
+}
+export declare function getServerDefinitions(options?: GetServerDefinitionsOptions): Promise<ServerDefinitionsResponseResult | ErrorResponse>;

package/lib/src/ledger/server_definitions.js

@@ -0,0 +1,65 @@
+"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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getServerDefinitions = getServerDefinitions;
+const Client = __importStar(require("../client"));
+const utils_1 = require("../common/utils");
+async function getServerDefinitions(options = {}) {
+    const connection = options.connection || Client.findConnection();
+    if (!connection) {
+        throw new Error("There is no connection");
+    }
+    const response = await connection.request({
+        command: "server_definitions",
+    });
+    if (!response) {
+        return {
+            status: "error",
+            error: "invalidResponse",
+        };
+    }
+    if (response.error) {
+        const { error, error_code, error_message, error_exception, status, validated } = response;
+        return (0, utils_1.removeUndefined)({
+            error,
+            error_code,
+            error_message,
+            error_exception,
+            status,
+            validated,
+        });
+    }
+    return response?.result;
+}

package/lib/src/ledger/server_info.d.ts

@@ -0,0 +1,8 @@
+import { Connection } from "../connection";
+import { ErrorResponse } from "../models/base_model";
+export interface GetServerInfoOptions {
+    url?: string;
+    type?: string;
+    connection?: Connection;
+}
+export declare function getServerInfo(options?: GetServerInfoOptions): Promise<object | ErrorResponse>;

package/lib/src/ledger/server_info.js

@@ -0,0 +1,65 @@
+"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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getServerInfo = getServerInfo;
+const Client = __importStar(require("../client"));
+const utils_1 = require("../common/utils");
+async function getServerInfo(options = {}) {
+    const connection = options.connection || Client.findConnection(options.type, options.url, true);
+    if (!connection) {
+        throw new Error("There is no connection");
+    }
+    const response = await connection.request({
+        command: "server_info",
+    });
+    if (!response) {
+        return {
+            status: "error",
+            error: "invalidResponse",
+        };
+    }
+    if (response.error) {
+        const { error, error_code, error_message, error_exception, status, validated } = response;
+        return (0, utils_1.removeUndefined)({
+            error,
+            error_code,
+            error_message,
+            error_exception,
+            status,
+            validated,
+        });
+    }
+    return response?.result;
+}

package/lib/src/ledger/transaction.d.ts

@@ -0,0 +1,47 @@
+import { XrplDefinitionsBase } from "ripple-binary-codec";
+import { Connection } from "../connection";
+import { FormattedMemo } from "../types";
+import { ErrorResponse } from "../models/base_model";
+import { TransactionResponse, FormattedTransaction, AccountPaymentParamsInterface } from "../models/transaction";
+export interface GetTransactionOptions {
+    binary?: boolean;
+    minLedger?: number;
+    maxLedger?: number;
+    balanceChanges?: boolean;
+    specification?: boolean;
+    legacy?: boolean;
+    formatted?: boolean;
+    includeRawTransaction?: boolean;
+    definitions?: XrplDefinitionsBase;
+}
+export declare function getTransaction(transaction: string, options?: GetTransactionOptions): Promise<TransactionResponse | FormattedTransaction | ErrorResponse>;
+export declare function getTransactionByCTID(ctid: string, options?: GetTransactionOptions): Promise<TransactionResponse | FormattedTransaction | ErrorResponse>;
+interface SubmitPaymentTransactionV1Interface {
+    sourceAddress: string;
+    sourceTag?: number;
+    sourceValue: string;
+    sourceCurrency: string;
+    destinationAddress: string;
+    destinationTag?: number;
+    destinationValue: string;
+    destinationCurrency: string;
+    networkID?: number;
+    memos?: FormattedMemo[];
+    secret: string;
+    fee?: string;
+    sequence?: number;
+    lastLedgerSequence?: number;
+}
+export declare function submitPaymentTransactionV1(data: SubmitPaymentTransactionV1Interface, definitions?: XrplDefinitionsBase, validateTx?: boolean): Promise<TransactionResponse | FormattedTransaction | ErrorResponse>;
+export declare function getAccountPaymentParams(account: string, connection?: Connection): Promise<AccountPaymentParamsInterface | ErrorResponse>;
+export declare function getTxSubmitParams(account: string, tx?: string | any, definitions?: XrplDefinitionsBase, connection?: Connection, skip?: {
+    fee?: boolean;
+    sequence?: boolean;
+    lastLedgerSequence?: boolean;
+}): Promise<AccountPaymentParamsInterface | ErrorResponse>;
+export interface SubmitOptionsInterface {
+    connection?: Connection;
+    definitions?: XrplDefinitionsBase;
+}
+export declare function submit(signedTransaction: string, options?: SubmitOptionsInterface): Promise<TransactionResponse | FormattedTransaction | ErrorResponse>;
+export {};