@nextrope/xrpl/dist/npm/models/methods/index.d.ts

A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser

import type { APIVersion, DEFAULT_API_VERSION } from '../common';
import { AccountChannelsRequest, AccountChannelsResponse, Channel } from './accountChannels';
import { AccountCurrenciesRequest, AccountCurrenciesResponse } from './accountCurrencies';
import { AccountInfoAccountFlags, AccountInfoRequest, AccountInfoResponse, AccountInfoV1Response, AccountInfoVersionResponseMap, AccountQueueData, AccountQueueTransaction } from './accountInfo';
import { AccountLinesRequest, AccountLinesResponse, AccountLinesTrustline } from './accountLines';
import { AccountNFToken, AccountNFTsRequest, AccountNFTsResponse } from './accountNFTs';
import { AccountObject, AccountObjectsRequest, AccountObjectsResponse, AccountObjectType } from './accountObjects';
import { AccountOffer, AccountOffersRequest, AccountOffersResponse } from './accountOffers';
import { AccountTxRequest, AccountTxResponse, AccountTxV1Response, AccountTxVersionResponseMap, AccountTxTransaction } from './accountTx';
import { AMMInfoRequest, AMMInfoResponse } from './ammInfo';
import { BaseRequest, BaseResponse, ErrorResponse, ResponseWarning } from './baseMethod';
import { BookOffersRequest, BookOffer, BookOffersResponse, BookOfferCurrency } from './bookOffers';
import { ChannelVerifyRequest, ChannelVerifyResponse } from './channelVerify';
import { DepositAuthorizedRequest, DepositAuthorizedResponse } from './depositAuthorized';
import { FeatureAllRequest, FeatureAllResponse, FeatureOneRequest, FeatureOneResponse, FeatureRequest, FeatureResponse } from './feature';
import { FeeRequest, FeeResponse } from './fee';
import { GatewayBalance, GatewayBalancesRequest, GatewayBalancesResponse } from './gatewayBalances';
import { GetAggregatePriceRequest, GetAggregatePriceResponse } from './getAggregatePrice';
import { LedgerBinary, LedgerModifiedOfferCreateTransaction, LedgerQueueData, LedgerRequest, LedgerResponse, LedgerV1Response, LedgerRequestExpandedTransactionsOnly, LedgerResponseExpanded, LedgerRequestExpandedAccountsAndTransactions, LedgerRequestExpandedAccountsOnly, LedgerRequestExpandedTransactionsBinary, LedgerVersionResponseMap } from './ledger';
import { LedgerClosedRequest, LedgerClosedResponse } from './ledgerClosed';
import { LedgerCurrentRequest, LedgerCurrentResponse } from './ledgerCurrent';
import { LedgerDataBinaryLedgerEntry, LedgerDataLabeledLedgerEntry, LedgerDataLedgerState, LedgerDataRequest, LedgerDataResponse } from './ledgerData';
import { LedgerEntryRequest, LedgerEntryResponse } from './ledgerEntry';
import { ManifestRequest, ManifestResponse } from './manifest';
import { NFTBuyOffersRequest, NFTBuyOffersResponse } from './nftBuyOffers';
import { NFTHistoryRequest, NFTHistoryResponse, NFTHistoryTransaction } from './nftHistory';
import { NFTInfoRequest, NFTInfoResponse } from './nftInfo';
import { NFTsByIssuerRequest, NFTsByIssuerResponse } from './nftsByIssuer';
import { NFTSellOffersRequest, NFTSellOffersResponse } from './nftSellOffers';
import { NoRippleCheckRequest, NoRippleCheckResponse } from './norippleCheck';
import { PathFindRequest, PathFindCloseRequest, PathFindCreateRequest, PathFindStatusRequest, PathFindResponse, PathFindPathOption } from './pathFind';
import { PingRequest, PingResponse } from './ping';
import { RandomRequest, RandomResponse } from './random';
import { RipplePathFindPathOption, RipplePathFindRequest, RipplePathFindResponse, SourceCurrencyAmount } from './ripplePathFind';
import { ServerDefinitionsRequest, ServerDefinitionsResponse } from './serverDefinitions';
import { JobType, ServerInfoRequest, ServerInfoResponse, ServerState, StateAccounting, StateAccountingFinal } from './serverInfo';
import { ServerStateRequest, ServerStateResponse } from './serverState';
import { SimulateBinaryRequest, SimulateBinaryResponse, SimulateJsonRequest, SimulateJsonResponse, SimulateRequest, SimulateResponse } from './simulate';
import { SubmitRequest, SubmitResponse } from './submit';
import { SubmitMultisignedRequest, SubmitMultisignedResponse, SubmitMultisignedV1Response, SubmitMultisignedVersionResponseMap } from './submitMultisigned';
import { BooksSnapshot, ConsensusStream, LedgerStream, LedgerStreamResponse, OrderBookStream, PathFindStream, PeerStatusStream, Stream, SubscribeBook, SubscribeRequest, SubscribeResponse, TransactionStream, TransactionV1Stream, ValidationStream } from './subscribe';
import { TransactionEntryRequest, TransactionEntryResponse } from './transactionEntry';
import { TxRequest, TxResponse, TxV1Response, TxVersionResponseMap } from './tx';
import { UnsubscribeBook, UnsubscribeRequest, UnsubscribeResponse } from './unsubscribe';
import { VaultInfoRequest, VaultInfoResponse } from './vaultInfo';
type Request = AccountChannelsRequest | AccountCurrenciesRequest | AccountInfoRequest | AccountLinesRequest | AccountNFTsRequest | AccountObjectsRequest | AccountOffersRequest | AccountTxRequest | GatewayBalancesRequest | NoRippleCheckRequest | LedgerRequest | LedgerClosedRequest | LedgerCurrentRequest | LedgerDataRequest | LedgerEntryRequest | SimulateRequest | SubmitRequest | SubmitMultisignedRequest | TransactionEntryRequest | TxRequest | BookOffersRequest | DepositAuthorizedRequest | PathFindRequest | RipplePathFindRequest | ChannelVerifyRequest | SubscribeRequest | UnsubscribeRequest | FeeRequest | ManifestRequest | ServerDefinitionsRequest | ServerInfoRequest | ServerStateRequest | FeatureRequest | PingRequest | RandomRequest | NFTBuyOffersRequest | NFTSellOffersRequest | NFTInfoRequest | NFTHistoryRequest | NFTsByIssuerRequest | AMMInfoRequest | GetAggregatePriceRequest | VaultInfoRequest;
type Response<Version extends APIVersion = typeof DEFAULT_API_VERSION> = AccountChannelsResponse | AccountCurrenciesResponse | AccountInfoVersionResponseMap<Version> | AccountLinesResponse | AccountNFTsResponse | AccountObjectsResponse | AccountOffersResponse | AccountTxVersionResponseMap<Version> | GatewayBalancesResponse | NoRippleCheckResponse | LedgerVersionResponseMap<Version> | LedgerClosedResponse | LedgerCurrentResponse | LedgerDataResponse | LedgerEntryResponse | SimulateResponse | SubmitResponse | SubmitMultisignedVersionResponseMap<Version> | TransactionEntryResponse | TxResponse | BookOffersResponse | DepositAuthorizedResponse | PathFindResponse | RipplePathFindResponse | ChannelVerifyResponse | SubscribeResponse | UnsubscribeResponse | FeeResponse | ManifestResponse | ServerDefinitionsResponse | ServerInfoResponse | ServerStateResponse | FeatureResponse | PingResponse | RandomResponse | NFTBuyOffersResponse | NFTSellOffersResponse | NFTInfoResponse | NFTHistoryResponse | NFTsByIssuerResponse | AMMInfoResponse | GetAggregatePriceResponse | VaultInfoResponse;
export type RequestResponseMap<T, Version extends APIVersion = typeof DEFAULT_API_VERSION> = T extends AccountChannelsRequest ? AccountChannelsResponse : T extends AccountCurrenciesRequest ? AccountCurrenciesResponse : T extends AccountInfoRequest ? AccountInfoVersionResponseMap<Version> : T extends AccountLinesRequest ? AccountLinesResponse : T extends AccountNFTsRequest ? AccountNFTsResponse : T extends AccountObjectsRequest ? AccountObjectsResponse : T extends AccountOffersRequest ? AccountOffersResponse : T extends AccountTxRequest ? AccountTxVersionResponseMap<Version> : T extends AMMInfoRequest ? AMMInfoResponse : T extends GatewayBalancesRequest ? GatewayBalancesResponse : T extends GetAggregatePriceRequest ? GetAggregatePriceResponse : T extends NoRippleCheckRequest ? NoRippleCheckResponse : T extends LedgerRequestExpandedTransactionsBinary ? LedgerVersionResponseMap<Version> : T extends LedgerRequestExpandedAccountsAndTransactions ? LedgerResponseExpanded<Version> : T extends LedgerRequestExpandedTransactionsOnly ? LedgerResponseExpanded<Version> : T extends LedgerRequestExpandedAccountsOnly ? LedgerResponseExpanded<Version> : T extends LedgerRequest ? LedgerVersionResponseMap<Version> : T extends LedgerClosedRequest ? LedgerClosedResponse : T extends LedgerCurrentRequest ? LedgerCurrentResponse : T extends LedgerDataRequest ? LedgerDataResponse : T extends LedgerEntryRequest ? LedgerEntryResponse : T extends SimulateBinaryRequest ? SimulateBinaryResponse : T extends SimulateJsonRequest ? SimulateJsonResponse : T extends SimulateRequest ? SimulateJsonResponse : T extends SubmitRequest ? SubmitResponse : T extends SubmitMultisignedRequest ? SubmitMultisignedVersionResponseMap<Version> : T extends TransactionEntryRequest ? TransactionEntryResponse : T extends TxRequest ? TxVersionResponseMap<Version> : T extends BookOffersRequest ? BookOffersResponse : T extends DepositAuthorizedRequest ? DepositAuthorizedResponse : T extends PathFindRequest ? PathFindResponse : T extends RipplePathFindRequest ? RipplePathFindResponse : T extends ChannelVerifyRequest ? ChannelVerifyResponse : T extends SubscribeRequest ? SubscribeResponse : T extends UnsubscribeRequest ? UnsubscribeResponse : T extends FeeRequest ? FeeResponse : T extends ManifestRequest ? ManifestResponse : T extends ServerInfoRequest ? ServerInfoResponse : T extends ServerStateRequest ? ServerStateResponse : T extends ServerDefinitionsRequest ? ServerDefinitionsResponse : T extends FeatureAllRequest ? FeatureAllResponse : T extends FeatureOneRequest ? FeatureOneResponse : T extends PingRequest ? PingResponse : T extends RandomRequest ? RandomResponse : T extends NFTBuyOffersRequest ? NFTBuyOffersResponse : T extends NFTSellOffersRequest ? NFTSellOffersResponse : T extends NFTInfoRequest ? NFTInfoResponse : T extends NFTsByIssuerRequest ? NFTsByIssuerResponse : T extends NFTHistoryRequest ? NFTHistoryResponse : T extends VaultInfoRequest ? VaultInfoResponse : Response<Version>;
export type MarkerRequest = Request & {
    limit?: number;
    marker?: unknown;
};
export type MarkerResponse<Version extends APIVersion = typeof DEFAULT_API_VERSION> = Response<Version> & {
    result: {
        marker?: unknown;
    };
};
export type RequestAllResponseMap<T, Version extends APIVersion = typeof DEFAULT_API_VERSION> = T extends AccountChannelsRequest ? AccountChannelsResponse : T extends AccountLinesRequest ? AccountLinesResponse : T extends AccountObjectsRequest ? AccountObjectsResponse : T extends AccountOffersRequest ? AccountOffersResponse : T extends AccountTxRequest ? AccountTxVersionResponseMap<Version> : T extends LedgerDataRequest ? LedgerDataResponse : T extends BookOffersRequest ? BookOffersResponse : MarkerResponse<Version>;
export { BaseRequest, BaseResponse, Request, Response, ResponseWarning, Channel, AccountChannelsRequest, AccountChannelsResponse, AccountCurrenciesRequest, AccountCurrenciesResponse, AccountInfoAccountFlags, AccountInfoRequest, AccountInfoResponse, AccountInfoV1Response, AccountQueueData, AccountQueueTransaction, AccountLinesRequest, AccountLinesResponse, AccountLinesTrustline, AccountNFToken, AccountNFTsRequest, AccountNFTsResponse, AccountObject, AccountObjectType, AccountObjectsRequest, AccountObjectsResponse, AccountOffer, AccountOffersRequest, AccountOffersResponse, AccountTxRequest, AccountTxResponse, AccountTxV1Response, AccountTxTransaction, GatewayBalance, GatewayBalancesRequest, GatewayBalancesResponse, GetAggregatePriceRequest, GetAggregatePriceResponse, NoRippleCheckRequest, NoRippleCheckResponse, LedgerRequest, LedgerResponse, LedgerV1Response, LedgerQueueData, LedgerBinary, LedgerModifiedOfferCreateTransaction, LedgerClosedRequest, LedgerClosedResponse, LedgerCurrentRequest, LedgerCurrentResponse, LedgerDataRequest, LedgerDataLabeledLedgerEntry, LedgerDataBinaryLedgerEntry, LedgerDataResponse, LedgerDataLedgerState, LedgerEntryRequest, LedgerEntryResponse, SimulateRequest, SimulateResponse, SubmitRequest, SubmitResponse, SubmitMultisignedRequest, SubmitMultisignedResponse, SubmitMultisignedV1Response, TransactionEntryRequest, TransactionEntryResponse, TxRequest, TxResponse, TxV1Response, BookOffersRequest, BookOffer, BookOfferCurrency, BookOffersResponse, DepositAuthorizedRequest, DepositAuthorizedResponse, PathFindRequest, PathFindCreateRequest, PathFindCloseRequest, PathFindPathOption, PathFindStatusRequest, PathFindResponse, RipplePathFindPathOption, RipplePathFindRequest, RipplePathFindResponse, SourceCurrencyAmount, ChannelVerifyRequest, ChannelVerifyResponse, SubscribeRequest, SubscribeResponse, SubscribeBook, Stream, BooksSnapshot, LedgerStream, LedgerStreamResponse, ValidationStream, TransactionStream, TransactionV1Stream, PathFindStream, PeerStatusStream, OrderBookStream, ConsensusStream, UnsubscribeRequest, UnsubscribeResponse, UnsubscribeBook, FeeRequest, FeeResponse, ManifestRequest, ManifestResponse, ServerDefinitionsRequest, ServerDefinitionsResponse, ServerInfoRequest, ServerInfoResponse, ServerStateRequest, ServerStateResponse, JobType, ServerState, StateAccountingFinal, StateAccounting, FeatureRequest, FeatureResponse, PingRequest, PingResponse, RandomRequest, RandomResponse, ErrorResponse, NFTBuyOffersRequest, NFTBuyOffersResponse, NFTSellOffersRequest, NFTSellOffersResponse, NFTInfoRequest, NFTInfoResponse, NFTHistoryRequest, NFTHistoryResponse, NFTHistoryTransaction, NFTsByIssuerRequest, NFTsByIssuerResponse, AMMInfoRequest, AMMInfoResponse, VaultInfoRequest, VaultInfoResponse, };
//# sourceMappingURL=index.d.ts.map