@bithomp/xrpl-api 2.3.6

package/lib/v1/common/types/commands/ledger.d.ts

@@ -0,0 +1,18 @@
+import { Ledger, QueueData } from '../objects';
+export interface LedgerRequest {
+    ledger_hash?: string;
+    ledger_index?: number | ('validated' | 'closed' | 'current');
+    full?: boolean;
+    accounts?: boolean;
+    transactions?: boolean;
+    expand?: boolean;
+    owner_funds?: boolean;
+    binary?: boolean;
+    queue?: boolean;
+}
+export interface LedgerResponse {
+    ledger_index: number;
+    ledger_hash: string;
+    ledger: Ledger;
+    queue_data?: QueueData;
+}

package/lib/v1/common/types/commands/ledger.js

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

package/lib/v1/common/types/commands/ledger_data.d.ts

@@ -0,0 +1,10 @@
+import { LedgerData } from '../objects';
+export interface LedgerDataRequest {
+    id?: any;
+    ledger_hash?: string;
+    ledger_index?: string;
+    binary?: boolean;
+    limit?: number;
+    marker?: string;
+}
+export type LedgerDataResponse = LedgerData;

package/lib/v1/common/types/commands/ledger_data.js

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

package/lib/v1/common/types/commands/ledger_entry.d.ts

@@ -0,0 +1,29 @@
+import { LedgerEntry } from '../objects';
+export interface LedgerEntryRequest {
+    ledger_hash?: string;
+    ledger_index?: number | ('validated' | 'closed' | 'current');
+    index?: string;
+    account_root?: string;
+    directory?: string | {
+        sub_index?: number;
+        dir_root: string;
+    } | {
+        sub_index?: number;
+        owner: string;
+    };
+    offer?: string | {
+        account: string;
+        seq: number;
+    };
+    ripple_state?: {
+        accounts: [string, string];
+        currency: string;
+    };
+    binary?: boolean;
+}
+export interface LedgerEntryResponse {
+    index: string;
+    ledger_index: number;
+    node_binary?: string;
+    node?: LedgerEntry;
+}

package/lib/v1/common/types/commands/ledger_entry.js

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

package/lib/v1/common/types/commands/path_find.d.ts

@@ -0,0 +1,33 @@
+import { Amount } from "../objects";
+export type PathFindRequest = {
+    command: string;
+    source_account: string;
+    destination_amount: Amount;
+    destination_account: string;
+    source_currencies?: {
+        currency: string;
+        issuer?: string;
+    }[];
+    send_max?: Amount;
+};
+export type RippledPathsResponse = {
+    alternatives: Array<{
+        paths_computed: Array<Array<{
+            type: number;
+            type_hex: string;
+            account?: string;
+            issuer?: string;
+            currency?: string;
+        }>>;
+        source_amount: Amount;
+    }>;
+    type: string;
+    destination_account: string;
+    destination_amount: Amount;
+    destination_currencies?: Array<string>;
+    source_account: string;
+    source_currencies?: Array<{
+        currency: string;
+    }>;
+    full_reply?: boolean;
+};

package/lib/v1/common/types/commands/path_find.js

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

package/lib/v1/common/types/commands/server_info.d.ts

@@ -0,0 +1,49 @@
+export interface ServerInfoRequest {
+    id?: number;
+}
+export interface ServerInfoResponse {
+    info: {
+        amendment_blocked?: boolean;
+        build_version: string;
+        closed_ledger?: LedgerInfo;
+        complete_ledgers: string;
+        hostid: string;
+        io_latency_ms: number;
+        last_close: {
+            converge_time_s: number;
+            proposers: number;
+        };
+        load?: {
+            job_types: {
+                job_type: string;
+                per_second: number;
+                in_progress: number;
+            }[];
+            threads: number;
+        };
+        load_factor: number;
+        load_factor_local?: number;
+        load_factor_net?: number;
+        load_factor_cluster?: number;
+        load_factor_fee_escalation?: number;
+        load_factor_fee_queue?: number;
+        load_factor_server?: number;
+        peers: number;
+        pubkey_node: string;
+        pubkey_validator: string;
+        server_state: string;
+        state_accounting: any;
+        uptime: number;
+        validated_ledger?: LedgerInfo;
+        validation_quorum: number;
+        validator_list_expires: string;
+    };
+}
+export interface LedgerInfo {
+    age: number;
+    base_fee_xrp: number;
+    hash: string;
+    reserve_base_xrp: number;
+    reserve_inc_xrp: number;
+    seq: number;
+}

package/lib/v1/common/types/commands/server_info.js

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

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

@@ -0,0 +1,6 @@
+import { FormattedBaseSpecification } from "./specification";
+export type FormattedAccountDeleteSpecification = {
+    destination: string;
+    destinationTag?: number;
+    destinationXAddress: string;
+} & FormattedBaseSpecification;

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

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

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

@@ -0,0 +1,16 @@
+import { FormattedIssuedCurrencyAmount } from "../../../../types";
+export type Adjustment = {
+    address: string;
+    amount: FormattedIssuedCurrencyAmount;
+    tag?: number;
+};
+export type MaxAdjustment = {
+    address: string;
+    maxAmount: FormattedIssuedCurrencyAmount;
+    tag?: number;
+};
+export type MinAdjustment = {
+    address: string;
+    minAmount: FormattedIssuedCurrencyAmount;
+    tag?: number;
+};

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

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

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

@@ -0,0 +1,4 @@
+import { FormattedBaseSpecification } from "./specification";
+export type FormattedAmendmentSpecification = {
+    amendment: string;
+} & FormattedBaseSpecification;

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

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

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

@@ -0,0 +1,13 @@
+export interface Amount extends Issue {
+    value: string;
+}
+export type RippledAmount = string | Amount;
+export interface TakerRequestAmount {
+    currency: string;
+    issuer?: string;
+}
+export interface Issue {
+    currency: string;
+    issuer?: string;
+    counterparty?: string;
+}

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

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

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

@@ -0,0 +1,17 @@
+import { FormattedBaseSpecification } from "./specification";
+import { FormattedIssuedCurrencyAmount } from "../../../../types";
+export type FormattedCheckCancelSpecification = {
+    checkID: string;
+} & FormattedBaseSpecification;
+export type FormattedCheckCashSpecification = {
+    checkID: string;
+    amount: FormattedIssuedCurrencyAmount;
+    deliverMin: FormattedIssuedCurrencyAmount;
+} & FormattedBaseSpecification;
+export type FormattedCheckCreateSpecification = {
+    destination: string;
+    sendMax: FormattedIssuedCurrencyAmount;
+    destinationTag?: string;
+    expiration?: string;
+    invoiceID?: string;
+} & FormattedBaseSpecification;

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

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

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

@@ -0,0 +1,5 @@
+import { FormattedBaseSpecification } from "./specification";
+export type FormattedDepositPreauthSpecification = {
+    authorize: string;
+    unauthorize: string;
+} & FormattedBaseSpecification;

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

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

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

@@ -0,0 +1,21 @@
+import { FormattedBaseSpecification } from "./specification";
+import { FormattedAmount } from "../../../../types";
+export type FormattedEscrowCancelSpecification = {
+    owner: string;
+    escrowSequence: number;
+} & FormattedBaseSpecification;
+export type FormattedEscrowCreateSpecification = {
+    amount?: FormattedAmount;
+    destination: string;
+    condition: string;
+    allowCancelAfter?: string;
+    allowExecuteAfter?: string;
+    sourceTag?: number;
+    destinationTag?: number;
+} & FormattedBaseSpecification;
+export type FormattedEscrowFinishSpecification = {
+    owner: string;
+    escrowSequence: number;
+    condition?: string;
+    fulfillment?: string;
+} & FormattedBaseSpecification;

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

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

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

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

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

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

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

@@ -0,0 +1,5 @@
+declare const orderFlags: {
+    Passive: number;
+    Sell: number;
+};
+export { orderFlags };

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.orderFlags = void 0;
+const orderFlags = {
+    Passive: 0x00010000,
+    Sell: 0x00020000,
+};
+exports.orderFlags = orderFlags;

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

@@ -0,0 +1,15 @@
+export * from "./adjustments";
+export * from "./ledger";
+export * from "./ledger_data";
+export * from "./ledger_entries";
+export * from "./memos";
+export * from "./checks";
+export * from "./deposits";
+export * from "./escrows";
+export * from "./offers";
+export * from "./queue_data";
+export * from "./settings";
+export * from "./signers";
+export * from "./transactions";
+export * from "./trustlines";
+export * from "../../../../types";

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

@@ -0,0 +1,31 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./adjustments"), exports);
+__exportStar(require("./ledger"), exports);
+__exportStar(require("./ledger_data"), exports);
+__exportStar(require("./ledger_entries"), exports);
+__exportStar(require("./memos"), exports);
+__exportStar(require("./checks"), exports);
+__exportStar(require("./deposits"), exports);
+__exportStar(require("./escrows"), exports);
+__exportStar(require("./offers"), exports);
+__exportStar(require("./queue_data"), exports);
+__exportStar(require("./settings"), exports);
+__exportStar(require("./signers"), exports);
+__exportStar(require("./transactions"), exports);
+__exportStar(require("./trustlines"), exports);
+__exportStar(require("../../../../types"), exports);

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

@@ -0,0 +1,45 @@
+export interface Ledger {
+    account_hash: string;
+    close_time: number;
+    close_time_human: string;
+    close_time_resolution: number;
+    closed: boolean;
+    ledger_hash: string;
+    ledger_index: string;
+    parent_hash: string;
+    total_coins: string;
+    transaction_hash: string;
+    transactions: string[] | object[];
+    close_flags?: number;
+    parent_close_time?: number;
+    accountState?: any[];
+    validated?: boolean;
+}
+export type FormattedLedger = {
+    stateHash: string;
+    closeTime: string;
+    closeTimeResolution: number;
+    closeFlags: number;
+    ledgerHash: string;
+    ledgerVersion: number;
+    parentLedgerHash: string;
+    parentCloseTime: string;
+    totalDrops: string;
+    transactionHash: string;
+    transactions?: Array<object>;
+    transactionHashes?: Array<string>;
+    rawState?: string;
+    stateHashes?: Array<string>;
+};
+export type LedgerClosedEvent = {
+    type: "ledgerClosed";
+    fee_base: number;
+    fee_ref: number;
+    ledger_hash: string;
+    ledger_index: number;
+    ledger_time: number;
+    reserve_base: number;
+    reserve_inc: number;
+    txn_count: number;
+    validated_ledgers: string;
+};

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

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

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

@@ -0,0 +1,10 @@
+export interface LedgerData {
+    ledger_index: string;
+    ledger_hash: string;
+    marker: string;
+    state: ({
+        data?: string;
+        LedgerEntryType?: string;
+        index: string;
+    } & any)[];
+}

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

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

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

@@ -0,0 +1,158 @@
+import { SignerEntry } from "./index";
+import { Amount } from "../../../../types";
+export interface AccountRootLedgerEntry {
+    LedgerEntryType: "AccountRoot";
+    Account: string;
+    Balance: string;
+    Flags: number;
+    OwnerCount: number;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+    Sequence: number;
+    AccountTxnID?: string;
+    Domain?: string;
+    EmailHash?: string;
+    MessageKey?: string;
+    RegularKey?: string;
+    TickSize?: number;
+    TransferRate?: number;
+    WalletLocator?: string;
+    WalletSize?: number;
+}
+export interface AmendmentsLedgerEntry {
+    LedgerEntryType: "Amendments";
+    Amendments?: string[];
+    Majorities?: any[];
+    Flags: 0;
+}
+export interface CheckLedgerEntry {
+    LedgerEntryType: "Check";
+    Account: string;
+    Destination: any;
+    string: any;
+    Flags: 0;
+    OwnerNode: string;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+    SendMax: string | object;
+    Sequence: number;
+    DestinationNode: string;
+    DestinationTag: number;
+    Expiration: number;
+    InvoiceID: string;
+    SourceTag: number;
+}
+export interface DepositPreauthLedgerEntry {
+    LedgerEntryType: "DepositPreauth";
+    Account: string;
+    Authorize: string;
+    OwnerNode: string;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+}
+export interface DirectoryNodeLedgerEntry {
+    LedgerEntryType: "DirectoryNode";
+    Flags: number;
+    RootIndex: string;
+    Indexes: string[];
+    IndexNext?: number;
+    IndexPrevious?: number;
+}
+export interface OfferDirectoryNodeLedgerEntry extends DirectoryNodeLedgerEntry {
+    TakerPaysCurrency: string;
+    TakerPaysIssuer: string;
+    TakerGetsCurrency: string;
+    TakerGetsIssuer: string;
+    ExchangeRate?: number;
+}
+export interface OwnerDirectoryNodeLedgerEntry extends DirectoryNodeLedgerEntry {
+    Owner: string;
+}
+export interface EscrowLedgerEntry {
+    LedgerEntryType: "Escrow";
+    Account: string;
+    Destination: string;
+    Amount: string;
+    Condition?: string;
+    CancelAfter?: number;
+    FinishAfter?: number;
+    Flags: number;
+    SourceTag?: number;
+    DestinationTag?: number;
+    OwnerNode: string;
+    DestinationNode?: string;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+}
+export interface FeeSettingsLedgerEntry {
+    LedgerEntryType: "FeeSettings";
+    BaseFee: string;
+    ReferenceFeeUnits: number;
+    ReserveBase: number;
+    ReserveIncrement: number;
+    Flags: number;
+}
+export interface LedgerHashesLedgerEntry {
+    LedgerEntryType: "LedgerHashes";
+    Hashes: string[];
+    Flags: number;
+    FirstLedgerSequence?: number;
+    LastLedgerSequence?: number;
+}
+export interface OfferLedgerEntry {
+    LedgerEntryType: "Offer";
+    Flags: number;
+    Account: string;
+    Sequence: number;
+    TakerPays: Amount;
+    TakerGets: Amount;
+    BookDirectory: string;
+    BookNode: string;
+    OwnerNode: string;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+    Expiration?: number;
+}
+export interface PayChannelLedgerEntry {
+    LedgerEntryType: "PayChannel";
+    Sequence: number;
+    Account: string;
+    Amount: string;
+    Balance: string;
+    PublicKey: string;
+    Destination: string;
+    SettleDelay: number;
+    Expiration?: number;
+    CancelAfter?: number;
+    SourceTag?: number;
+    DestinationTag?: number;
+    OwnerNode: string;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+    index: string;
+}
+export interface RippleStateLedgerEntry {
+    LedgerEntryType: "RippleState";
+    Flags: number;
+    Balance: Amount;
+    LowLimit: Amount;
+    HighLimit: Amount;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+    LowNode?: string;
+    HighNode?: string;
+    LowQualityIn?: number;
+    LowQualityOut?: number;
+    HighQualityIn?: number;
+    HighQualityOut?: number;
+}
+export interface SignerListLedgerEntry {
+    LedgerEntryType: "SignerList";
+    OwnerNode: string;
+    SignerQuorum: number;
+    SignerEntries: SignerEntry[];
+    SignerListID: number;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+}
+export type LedgerEntry = AccountRootLedgerEntry | AmendmentsLedgerEntry | CheckLedgerEntry | DepositPreauthLedgerEntry | DirectoryNodeLedgerEntry | OfferDirectoryNodeLedgerEntry | OwnerDirectoryNodeLedgerEntry | EscrowLedgerEntry | FeeSettingsLedgerEntry | LedgerHashesLedgerEntry | OfferLedgerEntry | PayChannelLedgerEntry | RippleStateLedgerEntry | SignerListLedgerEntry;

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

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

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

@@ -0,0 +1,12 @@
+export type Memo = {
+    Memo: {
+        MemoData?: string;
+        MemoType?: string;
+        MemoFormat?: string;
+    };
+};
+export type FormattedMemo = {
+    type?: string;
+    format?: string;
+    data?: string;
+};

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

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

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

@@ -0,0 +1,47 @@
+import { NFTokenMintFlags, NFTokenCreateOfferFlags } from "xrpl";
+import { FormattedBaseSpecification } from "./specification";
+export declare const NFTokenFlagsKeys: {
+    burnable: NFTokenMintFlags;
+    onlyXRP: NFTokenMintFlags;
+    trustLine: NFTokenMintFlags;
+    transferable: NFTokenMintFlags;
+};
+export interface NFTokenFlagsKeysInterface {
+    burnable?: boolean;
+    onlyXRP?: boolean;
+    trustLine?: boolean;
+    transferable?: boolean;
+}
+export declare const NFTokenOfferFlagsKeys: {
+    sellToken: NFTokenCreateOfferFlags;
+};
+export interface NFTokenOfferFlagsKeysInterface {
+    sellToken?: boolean;
+}
+export type FormattedNFTokenBurnSpecification = {
+    account: string;
+    nftokenID: string;
+} & FormattedBaseSpecification;
+export type FormattedNFTokenMintSpecification = {
+    nftokenTaxon: number;
+    issuer?: string;
+    transferFee?: number;
+    uri?: string;
+    flags?: NFTokenFlagsKeysInterface;
+} & FormattedBaseSpecification;
+export type FormattedNFTokenCancelOfferSpecification = {
+    nftokenOffers: string[];
+} & FormattedBaseSpecification;
+export type FormattedNFTokenCreateOfferSpecification = {
+    nftokenID: string;
+    amount: string;
+    owner?: string;
+    destination?: string;
+    expiration?: number;
+    flags?: NFTokenOfferFlagsKeysInterface;
+} & FormattedBaseSpecification;
+export type FormattedNFTokenAcceptOfferSpecification = {
+    nftokenSellOffer?: string;
+    nftokenBuyOffer?: string;
+    nftokenBrokerFee?: string;
+} & FormattedBaseSpecification;