123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272 |
- /// <reference types="node" />
- import { EventEmitter } from 'events';
- import { Connection, errors, validate, xrpToDrops, dropsToXrp, rippleTimeToISO8601, iso8601ToRippleTime } from './common';
- import { connect, disconnect, isConnected, getLedgerVersion } from './server/server';
- import getTransaction from './ledger/transaction';
- import getTransactions from './ledger/transactions';
- import getTrustlines from './ledger/trustlines';
- import getBalances from './ledger/balances';
- import getBalanceSheet from './ledger/balance-sheet';
- import getPaths from './ledger/pathfind';
- import getOrders from './ledger/orders';
- import { getOrderbook, formatBidsAndAsks } from './ledger/orderbook';
- import { getSettings, parseAccountFlags } from './ledger/settings';
- import getAccountInfo from './ledger/accountinfo';
- import getAccountObjects from './ledger/accountobjects';
- import getPaymentChannel from './ledger/payment-channel';
- import preparePayment from './transaction/payment';
- import prepareTrustline from './transaction/trustline';
- import prepareOrder from './transaction/order';
- import prepareOrderCancellation from './transaction/ordercancellation';
- import prepareEscrowCreation from './transaction/escrow-creation';
- import prepareEscrowExecution from './transaction/escrow-execution';
- import prepareEscrowCancellation from './transaction/escrow-cancellation';
- import preparePaymentChannelCreate from './transaction/payment-channel-create';
- import preparePaymentChannelFund from './transaction/payment-channel-fund';
- import preparePaymentChannelClaim from './transaction/payment-channel-claim';
- import prepareCheckCreate from './transaction/check-create';
- import prepareCheckCancel from './transaction/check-cancel';
- import prepareCheckCash from './transaction/check-cash';
- import prepareSettings from './transaction/settings';
- import prepareTicketCreate from './transaction/ticket';
- import sign from './transaction/sign';
- import combine from './transaction/combine';
- import submit from './transaction/submit';
- import { generateXAddress } from './offline/utils';
- import { deriveXAddress } from './offline/derive';
- import computeLedgerHash from './offline/ledgerhash';
- import signPaymentChannelClaim from './offline/sign-payment-channel-claim';
- import verifyPaymentChannelClaim from './offline/verify-payment-channel-claim';
- import getLedger from './ledger/ledger';
- import { AccountObjectsRequest, AccountObjectsResponse, AccountOffersRequest, AccountOffersResponse, AccountInfoRequest, AccountInfoResponse, AccountLinesRequest, AccountLinesResponse, BookOffersRequest, BookOffersResponse, GatewayBalancesRequest, GatewayBalancesResponse, LedgerRequest, LedgerResponse, LedgerDataRequest, LedgerDataResponse, LedgerEntryRequest, LedgerEntryResponse, ServerInfoRequest, ServerInfoResponse } from './common/types/commands';
- import RangeSet from './common/rangeset';
- import * as ledgerUtils from './ledger/utils';
- import * as schemaValidator from './common/schema-validator';
- import { TransactionJSON, Instructions, Prepare } from './transaction/types';
- import { ConnectionUserOptions } from './common/connection';
- import { classicAddressToXAddress, xAddressToClassicAddress, isValidXAddress, isValidClassicAddress, encodeSeed, decodeSeed, encodeAccountID, decodeAccountID, encodeNodePublic, decodeNodePublic, encodeAccountPublic, decodeAccountPublic, encodeXAddress, decodeXAddress } from 'ripple-address-codec';
- import generateFaucetWallet from './wallet/wallet-generation';
- export interface APIOptions extends ConnectionUserOptions {
- server?: string;
- feeCushion?: number;
- maxFeeXRP?: string;
- proxy?: string;
- timeout?: number;
- }
- declare class RippleAPI extends EventEmitter {
- _feeCushion: number;
- _maxFeeXRP: string;
- connection: Connection;
- static _PRIVATE: {
- validate: typeof validate;
- RangeSet: typeof RangeSet;
- ledgerUtils: typeof ledgerUtils;
- schemaValidator: typeof schemaValidator;
- };
- static renameCounterpartyToIssuer: typeof ledgerUtils.renameCounterpartyToIssuer;
- static formatBidsAndAsks: typeof formatBidsAndAsks;
- constructor(options?: APIOptions);
- request(command: 'account_info', params: AccountInfoRequest): Promise<AccountInfoResponse>;
- request(command: 'account_lines', params: AccountLinesRequest): Promise<AccountLinesResponse>;
- request(command: 'account_objects', params: AccountObjectsRequest): Promise<AccountObjectsResponse>;
- request(command: 'account_offers', params: AccountOffersRequest): Promise<AccountOffersResponse>;
- request(command: 'book_offers', params: BookOffersRequest): Promise<BookOffersResponse>;
- request(command: 'gateway_balances', params: GatewayBalancesRequest): Promise<GatewayBalancesResponse>;
- request(command: 'ledger', params: LedgerRequest): Promise<LedgerResponse>;
- request(command: 'ledger_data', params?: LedgerDataRequest): Promise<LedgerDataResponse>;
- request(command: 'ledger_entry', params: LedgerEntryRequest): Promise<LedgerEntryResponse>;
- request(command: 'server_info', params?: ServerInfoRequest): Promise<ServerInfoResponse>;
- request(command: string, params: any): Promise<any>;
- hasNextPage<T extends {
- marker?: string;
- }>(currentResponse: T): boolean;
- requestNextPage<T extends {
- marker?: string;
- }>(command: string, params: object, currentResponse: T): Promise<T>;
- prepareTransaction(txJSON: TransactionJSON, instructions?: Instructions): Promise<Prepare>;
- convertStringToHex(string: string): string;
- _requestAll(command: 'account_offers', params: AccountOffersRequest): Promise<AccountOffersResponse[]>;
- _requestAll(command: 'book_offers', params: BookOffersRequest): Promise<BookOffersResponse[]>;
- _requestAll(command: 'account_lines', params: AccountLinesRequest): Promise<AccountLinesResponse[]>;
- generateAddress: (options?: import("./offline/generate-address").GenerateAddressOptions) => import("./offline/generate-address").GeneratedAddress;
- generateXAddress: typeof generateXAddress;
- connect: typeof connect;
- disconnect: typeof disconnect;
- isConnected: typeof isConnected;
- getServerInfo: typeof ledgerUtils.common.serverInfo.getServerInfo;
- getFee: typeof ledgerUtils.common.serverInfo.getFee;
- getLedgerVersion: typeof getLedgerVersion;
- getTransaction: typeof getTransaction;
- getTransactions: typeof getTransactions;
- getTrustlines: typeof getTrustlines;
- getBalances: typeof getBalances;
- getBalanceSheet: typeof getBalanceSheet;
- getPaths: typeof getPaths;
- getOrderbook: typeof getOrderbook;
- getOrders: typeof getOrders;
- getSettings: typeof getSettings;
- getAccountInfo: typeof getAccountInfo;
- getAccountObjects: typeof getAccountObjects;
- getPaymentChannel: typeof getPaymentChannel;
- getLedger: typeof getLedger;
- parseAccountFlags: typeof parseAccountFlags;
- preparePayment: typeof preparePayment;
- prepareTrustline: typeof prepareTrustline;
- prepareOrder: typeof prepareOrder;
- prepareOrderCancellation: typeof prepareOrderCancellation;
- prepareEscrowCreation: typeof prepareEscrowCreation;
- prepareEscrowExecution: typeof prepareEscrowExecution;
- prepareEscrowCancellation: typeof prepareEscrowCancellation;
- preparePaymentChannelCreate: typeof preparePaymentChannelCreate;
- preparePaymentChannelFund: typeof preparePaymentChannelFund;
- preparePaymentChannelClaim: typeof preparePaymentChannelClaim;
- prepareCheckCreate: typeof prepareCheckCreate;
- prepareCheckCash: typeof prepareCheckCash;
- prepareCheckCancel: typeof prepareCheckCancel;
- prepareTicketCreate: typeof prepareTicketCreate;
- prepareSettings: typeof prepareSettings;
- sign: typeof sign;
- combine: typeof combine;
- submit: typeof submit;
- deriveKeypair: (seed: string, options?: object) => {
- publicKey: string;
- privateKey: string;
- };
- deriveAddress: (publicKey: any) => string;
- computeLedgerHash: typeof computeLedgerHash;
- signPaymentChannelClaim: typeof signPaymentChannelClaim;
- verifyPaymentChannelClaim: typeof verifyPaymentChannelClaim;
- generateFaucetWallet: typeof generateFaucetWallet;
- errors: typeof errors;
- static deriveXAddress: typeof deriveXAddress;
- static deriveClassicAddress: (publicKey: any) => string;
- static classicAddressToXAddress: typeof classicAddressToXAddress;
- static xAddressToClassicAddress: typeof xAddressToClassicAddress;
- static isValidXAddress: typeof isValidXAddress;
- static isValidClassicAddress: typeof isValidClassicAddress;
- static encodeSeed: typeof encodeSeed;
- static decodeSeed: typeof decodeSeed;
- static encodeAccountID: typeof encodeAccountID;
- static decodeAccountID: typeof decodeAccountID;
- static encodeNodePublic: typeof encodeNodePublic;
- static decodeNodePublic: typeof decodeNodePublic;
- static encodeAccountPublic: typeof encodeAccountPublic;
- static decodeAccountPublic: typeof decodeAccountPublic;
- static encodeXAddress: typeof encodeXAddress;
- static decodeXAddress: typeof decodeXAddress;
- static computeBinaryTransactionHash: (txBlobHex: string) => string;
- static computeTransactionHash: (txJSON: any) => string;
- static computeBinaryTransactionSigningHash: (txBlobHex: string) => string;
- static computeAccountLedgerObjectID: (address: string) => string;
- static computeSignerListLedgerObjectID: (address: string) => string;
- static computeOrderID: (address: string, sequence: number) => string;
- static computeTrustlineHash: (address1: string, address2: string, currency: string) => string;
- static computeTransactionTreeHash: (transactions: any[]) => string;
- static computeStateTreeHash: (entries: any[]) => string;
- static computeLedgerHash: typeof computeLedgerHash;
- static computeEscrowHash: (address: any, sequence: any) => string;
- static computePaymentChannelHash: (address: any, dstAddress: any, sequence: any) => string;
- xrpToDrops: typeof xrpToDrops;
- dropsToXrp: typeof dropsToXrp;
- rippleTimeToISO8601: typeof rippleTimeToISO8601;
- iso8601ToRippleTime: typeof iso8601ToRippleTime;
- txFlags: {
- Universal: {
- FullyCanonicalSig: number;
- };
- AccountSet: {
- RequireDestTag: number;
- OptionalDestTag: number;
- RequireAuth: number;
- OptionalAuth: number;
- DisallowXRP: number;
- AllowXRP: number;
- };
- TrustSet: {
- SetAuth: number;
- NoRipple: number;
- SetNoRipple: number;
- ClearNoRipple: number;
- SetFreeze: number;
- ClearFreeze: number;
- };
- OfferCreate: {
- Passive: number;
- ImmediateOrCancel: number;
- FillOrKill: number;
- Sell: number;
- };
- Payment: {
- NoRippleDirect: number;
- PartialPayment: number;
- LimitQuality: number;
- };
- PaymentChannelClaim: {
- Renew: number;
- Close: number;
- };
- };
- static txFlags: {
- Universal: {
- FullyCanonicalSig: number;
- };
- AccountSet: {
- RequireDestTag: number;
- OptionalDestTag: number;
- RequireAuth: number;
- OptionalAuth: number;
- DisallowXRP: number;
- AllowXRP: number;
- };
- TrustSet: {
- SetAuth: number;
- NoRipple: number;
- SetNoRipple: number;
- ClearNoRipple: number;
- SetFreeze: number;
- ClearFreeze: number;
- };
- OfferCreate: {
- Passive: number;
- ImmediateOrCancel: number;
- FillOrKill: number;
- Sell: number;
- };
- Payment: {
- NoRippleDirect: number;
- PartialPayment: number;
- LimitQuality: number;
- };
- PaymentChannelClaim: {
- Renew: number;
- Close: number;
- };
- };
- accountSetFlags: {
- requireDestinationTag: number;
- requireAuthorization: number;
- depositAuth: number;
- disallowIncomingXRP: number;
- disableMasterKey: number;
- enableTransactionIDTracking: number;
- noFreeze: number;
- globalFreeze: number;
- defaultRipple: number;
- };
- static accountSetFlags: {
- requireDestinationTag: number;
- requireAuthorization: number;
- depositAuth: number;
- disallowIncomingXRP: number;
- disableMasterKey: number;
- enableTransactionIDTracking: number;
- noFreeze: number;
- globalFreeze: number;
- defaultRipple: number;
- };
- isValidAddress: typeof schemaValidator.isValidAddress;
- isValidSecret: typeof schemaValidator.isValidSecret;
- }
- export { RippleAPI };
- export type { AccountObjectsRequest, AccountObjectsResponse, AccountOffersRequest, AccountOffersResponse, AccountInfoRequest, AccountInfoResponse, AccountLinesRequest, AccountLinesResponse, BookOffersRequest, BookOffersResponse, GatewayBalancesRequest, GatewayBalancesResponse, LedgerRequest, LedgerResponse, LedgerDataRequest, LedgerDataResponse, LedgerEntryRequest, LedgerEntryResponse, ServerInfoRequest, ServerInfoResponse };
- //# sourceMappingURL=api.d.ts.map
|