@bithomp/xrpl-api 3.7.31 → 3.7.37

package/lib/src/faucet.d.ts

@@ -0,0 +1,58 @@
+interface FaucetNetworkInterface {
+    url: string;
+    format?: string;
+}
+interface AxiosFaucetOptionsDataInterface {
+    destination: string;
+}
+interface AxiosFaucetOptionsInterface {
+    method: string;
+    url: string;
+    data?: AxiosFaucetOptionsDataInterface;
+}
+interface XrplLabsSuccessResponseInterface {
+    address: string;
+    secret: string;
+    xrp: number;
+    hash: string;
+    code: string;
+}
+interface XrplSuccessResponseAccountInterface {
+    xAddress: string;
+    secret?: string;
+    classicAddress: string;
+    address: string;
+}
+interface XrplSuccessResponseInterface {
+    account: XrplSuccessResponseAccountInterface;
+    amount: number;
+    balance: number;
+    hash?: string;
+}
+export declare const FaucetNetworks: {
+    test: {
+        url: string;
+        format: string;
+    };
+    dev: {
+        url: string;
+        format: string;
+    };
+    alphanet: {
+        url: string;
+        format: string;
+    };
+    "xahau-test": {
+        url: string;
+        format: string;
+    };
+    "xahau-jshooks": {
+        url: string;
+        format: string;
+    };
+};
+export declare function getFaucetNetwork(network: string): FaucetNetworkInterface | undefined;
+export declare function foundWallet(network: string | FaucetNetworkInterface, account?: string): Promise<any>;
+export declare function getAxiosFaucetOptions(network: FaucetNetworkInterface, account?: string): AxiosFaucetOptionsInterface;
+export declare function xrplLabsToXrplResponse(data: XrplLabsSuccessResponseInterface): XrplSuccessResponseInterface;
+export {};

package/lib/src/faucet.js

@@ -0,0 +1,129 @@
+"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 });
+exports.FaucetNetworks = void 0;
+exports.getFaucetNetwork = getFaucetNetwork;
+exports.foundWallet = foundWallet;
+exports.getAxiosFaucetOptions = getAxiosFaucetOptions;
+exports.xrplLabsToXrplResponse = xrplLabsToXrplResponse;
+const axios_1 = __importDefault(require("axios"));
+const AddressCodec = __importStar(require("ripple-address-codec"));
+exports.FaucetNetworks = {
+    test: {
+        url: "https://faucet.altnet.rippletest.net/accounts",
+        format: "xrpl",
+    },
+    dev: {
+        url: "https://faucet.devnet.rippletest.net/accounts",
+        format: "xrpl",
+    },
+    alphanet: {
+        url: "https://alphanet.faucet.nerdnest.xyz/accounts",
+        format: "xrpl",
+    },
+    "xahau-test": {
+        url: "https://xahau-test.net/newcreds",
+        format: "xrpl-labs",
+    },
+    "xahau-jshooks": {
+        url: "https://jshooks.xahau-test.net/newcreds",
+        format: "xrpl-labs",
+    },
+};
+function getFaucetNetwork(network) {
+    if (network in exports.FaucetNetworks) {
+        return exports.FaucetNetworks[network];
+    }
+    return undefined;
+}
+async function foundWallet(network, account) {
+    if (typeof network === "string") {
+        network = getFaucetNetwork(network);
+    }
+    if (!network) {
+        throw new Error("Invalid network");
+    }
+    const options = getAxiosFaucetOptions(network, account);
+    try {
+        const data = (await (0, axios_1.default)(options)).data;
+        if (network.format === "xrpl-labs" && data.code === "tesSUCCESS") {
+            return xrplLabsToXrplResponse(data);
+        }
+        return data;
+    }
+    catch (err) {
+        return {
+            error: err.message,
+        };
+    }
+}
+function getAxiosFaucetOptions(network, account) {
+    const options = {
+        method: "post",
+        url: network.url,
+    };
+    if (account) {
+        if (network.format === "xrpl-labs") {
+            options.url += `?account=${account}`;
+        }
+        else {
+            options.data = { destination: account };
+        }
+    }
+    return options;
+}
+function xrplLabsToXrplResponse(data) {
+    const secret = data.secret === "" ? undefined : data.secret;
+    const balance = secret ? data.xrp : undefined;
+    const response = {
+        account: {
+            xAddress: AddressCodec.classicAddressToXAddress(data.address, false, true),
+            classicAddress: data.address,
+            address: data.address,
+        },
+        amount: data.xrp,
+        hash: data.hash,
+    };
+    if (secret) {
+        response.account.secret = secret;
+    }
+    if (balance) {
+        response.balance = balance;
+    }
+    return response;
+}

package/lib/src/index.d.ts

@@ -0,0 +1,9 @@
+export * as xrpl from "xrpl";
+export * as Client from "./client";
+export * as Models from "./models";
+export * as Wallet from "./wallet";
+export * as Faucet from "./faucet";
+export * as Validator from "./validator";
+export * as Parse from "./parse";
+export * as Common from "./common";
+export * as Types from "./types";

package/lib/src/index.js

@@ -0,0 +1,45 @@
+"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.Types = exports.Common = exports.Parse = exports.Validator = exports.Faucet = exports.Wallet = exports.Models = exports.Client = exports.xrpl = void 0;
+exports.xrpl = __importStar(require("xrpl"));
+exports.Client = __importStar(require("./client"));
+exports.Models = __importStar(require("./models"));
+exports.Wallet = __importStar(require("./wallet"));
+exports.Faucet = __importStar(require("./faucet"));
+exports.Validator = __importStar(require("./validator"));
+exports.Parse = __importStar(require("./parse"));
+exports.Common = __importStar(require("./common"));
+exports.Types = __importStar(require("./types"));

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

@@ -0,0 +1,16 @@
+import { Connection } from "../connection";
+import { LedgerIndex } from "../models/ledger";
+import { AccountInfoResponse, AccountInfoDataResponse } from "../models/account_info";
+import { ErrorResponse } from "../models/base_model";
+import { FormattedAccountInfoData } from "../types";
+export interface GetAccountInfoOptions {
+    ledgerIndex?: LedgerIndex;
+    signerLists?: boolean;
+    connection?: Connection;
+}
+export declare function getAccountInfo(account: string, options?: GetAccountInfoOptions): Promise<AccountInfoResponse | ErrorResponse>;
+export interface GetAccountInfoDataOptions extends GetAccountInfoOptions {
+    formatted?: boolean;
+}
+export declare function getAccountInfoData(account: string, options?: GetAccountInfoDataOptions): Promise<AccountInfoDataResponse | FormattedAccountInfoData | ErrorResponse>;
+export declare function isActivated(account: string): Promise<boolean>;

package/lib/src/ledger/account_info.js

@@ -0,0 +1,112 @@
+"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.getAccountInfo = getAccountInfo;
+exports.getAccountInfoData = getAccountInfoData;
+exports.isActivated = isActivated;
+const Client = __importStar(require("../client"));
+const account_info_1 = require("../parse/ledger/account-info");
+const common_1 = require("../common");
+const utils_1 = require("../common/utils");
+async function getAccountInfo(account, options = {}) {
+    const connection = options.connection || Client.findConnection();
+    if (!connection) {
+        throw new Error("There is no connection");
+    }
+    const request = {
+        command: "account_info",
+        account,
+        ledger_index: options.ledgerIndex || "validated",
+        signer_lists: !!options.signerLists,
+    };
+    const response = await connection.request(request);
+    if (!response) {
+        return {
+            account,
+            status: "error",
+            error: "invalidResponse",
+        };
+    }
+    if (response.error) {
+        const { error, error_code, error_message, error_exception, status, validated } = response;
+        return (0, common_1.removeUndefined)({
+            account,
+            error,
+            error_code,
+            error_message,
+            error_exception,
+            status,
+            validated,
+        });
+    }
+    const result = response.result;
+    if (!result) {
+        return {
+            account,
+            status: "error",
+            error: "invalidResponse",
+        };
+    }
+    if (result.signer_lists) {
+        result.account_data.signer_lists = result.signer_lists.slice();
+    }
+    if (request.signer_lists === true && (0, utils_1.isClioResponse)(response)) {
+        if (result.account_data.signer_lists === undefined) {
+            result.account_data.signer_lists = [];
+        }
+    }
+    return result;
+}
+async function getAccountInfoData(account, options = {}) {
+    const formatted = options.formatted === true;
+    const response = await getAccountInfo(account, options);
+    if ("error" in response) {
+        return response;
+    }
+    if (formatted) {
+        return (0, account_info_1.parseAccountInfoData)(response);
+    }
+    return response.account_data;
+}
+async function isActivated(account) {
+    const response = await getAccountInfo(account);
+    if (!response) {
+        return false;
+    }
+    if ("error" in response) {
+        return false;
+    }
+    return true;
+}

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

@@ -0,0 +1,11 @@
+import { LedgerIndex } from "../models/ledger";
+import { AccountLinesResponse } from "../models/account_lines";
+import { ErrorResponse } from "../models/base_model";
+export interface GetAccountLinesOptions {
+    issuer?: string;
+    currency?: string;
+    ledgerIndex?: LedgerIndex;
+    limit?: number;
+    marker?: any;
+}
+export declare function getAccountLines(account: string, options?: GetAccountLinesOptions): Promise<AccountLinesResponse | ErrorResponse>;

package/lib/src/ledger/account_lines.js

@@ -0,0 +1,90 @@
+"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.getAccountLines = getAccountLines;
+const Client = __importStar(require("../client"));
+const utils_1 = require("../common/utils");
+const common_1 = require("../common");
+async function getAccountLines(account, options = {}) {
+    const { hash, marker } = (0, utils_1.parseMarker)(options.marker);
+    options.marker = marker;
+    const connection = Client.findConnection(undefined, undefined, undefined, hash);
+    if (!connection) {
+        throw new Error("There is no connection");
+    }
+    const response = await connection.request({
+        command: "account_lines",
+        account,
+        ledger_index: options.ledgerIndex || "validated",
+        limit: options.limit,
+        marker: options.marker,
+    });
+    if (!response) {
+        return {
+            account,
+            status: "error",
+            error: "invalidResponse",
+        };
+    }
+    if (response.error) {
+        const { error, error_code, error_message, error_exception, status, validated } = response;
+        return (0, common_1.removeUndefined)({
+            account,
+            error,
+            error_code,
+            error_message,
+            error_exception,
+            status,
+            validated,
+        });
+    }
+    const result = response.result;
+    if (options.currency || options.issuer) {
+        result.lines = result.lines.filter((line) => {
+            if (options.currency && line.currency !== options.currency) {
+                return false;
+            }
+            if (options.issuer && line.account !== options.issuer) {
+                return false;
+            }
+            return true;
+        });
+    }
+    const newMarker = (0, utils_1.createMarker)(connection.hash, result.marker);
+    if (newMarker) {
+        result.marker = newMarker;
+    }
+    return result;
+}

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

@@ -0,0 +1,7 @@
+import { LedgerIndex } from "../models/ledger";
+import { HookNamespaceResponse } from "../models/account_namespace";
+import { ErrorResponse } from "../models/base_model";
+export interface GetAccountNamespaceOptions {
+    ledgerIndex?: LedgerIndex;
+}
+export declare function getAccountNamespace(account: string, namespaceId: string, options?: GetAccountNamespaceOptions): Promise<HookNamespaceResponse | ErrorResponse>;

package/lib/src/ledger/account_namespace.js

@@ -0,0 +1,72 @@
+"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.getAccountNamespace = getAccountNamespace;
+const Client = __importStar(require("../client"));
+const common_1 = require("../common");
+async function getAccountNamespace(account, namespaceId, options = {}) {
+    const connection = Client.findConnection();
+    if (!connection) {
+        throw new Error("There is no connection");
+    }
+    const response = await connection.request({
+        command: "account_namespace",
+        account,
+        namespace_id: namespaceId,
+        ledger_index: options.ledgerIndex || "validated",
+    });
+    if (!response) {
+        return {
+            account,
+            status: "error",
+            error: "invalidResponse",
+        };
+    }
+    if (response.error) {
+        const { error, error_code, error_message, error_exception, status, validated } = response;
+        return (0, common_1.removeUndefined)({
+            account,
+            namespace_id: namespaceId,
+            error,
+            error_code,
+            error_message,
+            error_exception,
+            status,
+            validated,
+        });
+    }
+    const result = response.result;
+    return result;
+}

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

@@ -0,0 +1,21 @@
+import { LedgerIndex } from "../models/ledger";
+import { ErrorResponse } from "../models/base_model";
+export interface GetAccountNftsOptions {
+    ledgerIndex?: LedgerIndex;
+    limit?: number;
+    marker?: any;
+}
+export declare function getAccountNfts(account: string, options?: GetAccountNftsOptions): Promise<object[] | ErrorResponse>;
+interface FindAccountNftsOptions extends GetAccountNftsOptions {
+    timeout?: number;
+}
+export declare function findAccountNfts(account: string, options?: FindAccountNftsOptions): Promise<object[] | ErrorResponse>;
+export interface GetAccountNftSellOffersOptions {
+    ledgerIndex?: LedgerIndex;
+}
+export declare function getAccountNftSellOffers(nftID: string, options?: GetAccountNftSellOffersOptions): Promise<object[] | ErrorResponse>;
+export interface GetAccountNftBuyOffersOptions {
+    ledgerIndex?: LedgerIndex;
+}
+export declare function getAccountNftBuyOffers(nftID: string, options?: GetAccountNftBuyOffersOptions): Promise<object[] | object>;
+export {};