UNPKG

@bithomp/xrpl-api

Version:

A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger

48 lines (47 loc) 2.29 kB
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 {};