@bithomp/xrpl-api/lib/models/transaction.d.ts

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

import { Transaction, TransactionMetadata } from "xrpl";
import { XrplDefinitionsBase } from "ripple-binary-codec";
import { FormattedSpecification, FormattedTransaction } from "../parse/transaction";
export { FormattedTransaction } from "../parse/transaction";
import { Outcome } from "../types/outcome";
import { BalanceChanges } from "../parse/outcome/balance_changes";
export interface TransactionBaseResponse {
    hash: string;
    ledger_index?: number;
    meta?: TransactionMetadata | string;
    validated?: boolean;
    date?: number;
    balanceChanges?: BalanceChanges;
    specification?: FormattedSpecification;
    outcome?: Outcome;
    rawTransaction?: string;
}
export type TransactionResponse = TransactionBaseResponse & Transaction;
export type AccountTransaction = {
    tx: TransactionResponse;
    meta: TransactionMetadata;
    validated: boolean;
};
export type LedgerTransaction = TransactionBaseResponse & {
    metaData?: TransactionMetadata;
};
export type StreamTransaction = TransactionBaseResponse & {
    transaction: TransactionResponse;
    meta: TransactionMetadata;
};
export interface AccountPaymentParamsInterface {
    fee?: string;
    sequence?: number;
    lastLedgerSequence?: number;
    networkID?: number;
}
export declare function getTxDetails(tx: TransactionResponse, includeRawTransaction?: boolean, nativeCurrency?: string, definitions?: XrplDefinitionsBase): FormattedTransaction;
export declare function getAccountTxDetails(tx: AccountTransaction, includeRawTransaction?: boolean, nativeCurrency?: string): FormattedTransaction;
export declare function getLedgerTxDetails(tx: LedgerTransaction, ledgerIndex: number, closeTime: number, includeRawTransaction?: boolean, nativeCurrency?: string, definitions?: XrplDefinitionsBase): FormattedTransaction;
export declare function getStreamTxDetails(tx: StreamTransaction, includeRawTransaction?: boolean, nativeCurrency?: string, definitions?: XrplDefinitionsBase): FormattedTransaction;
export declare function accountTxToTx(accountTx: AccountTransaction): TransactionResponse;
export declare function ledgerTxToTx(ledgerTx: LedgerTransaction, ledgerIndex: number, closeTime: number): TransactionResponse;
export declare function streamTxToTx(streamTx: StreamTransaction): TransactionResponse;
export declare function isCTID(ctid: string | bigint): boolean;
export declare function encodeCTIDforTransaction(transaction: TransactionResponse, networkID: number): string | undefined;
export declare function encodeCTID(ledgerIndex: number, txIndex: number, networkID: number): string;
export interface DecodeCTIDInterface {
    ledgerIndex: number;
    txIndex: number;
    networkID: number;
}
export declare function decodeCTID(ctid: string | bigint): DecodeCTIDInterface;