ripple-lib/dist/npm/transaction/types.d.ts

Deprecated - consider migrating to xrpl.js: https://xrpl.org/xrpljs2-migration-guide.html

import { FormattedOrderSpecification, FormattedTrustlineSpecification, Adjustment, RippledAmount, Memo, FormattedSettings } from '../common/types/objects';
import { ApiMemo } from './utils';
export declare type TransactionJSON = {
    Account: string;
    TransactionType: string;
    Memos?: {
        Memo: ApiMemo;
    }[];
    Flags?: number;
    Fulfillment?: string;
    [Field: string]: string | number | Array<any> | RippledAmount | undefined;
};
export declare type Instructions = {
    sequence?: number;
    ticketSequence?: number;
    fee?: string;
    maxFee?: string;
    maxLedgerVersion?: number;
    maxLedgerVersionOffset?: number;
    signersCount?: number;
};
export declare type Prepare = {
    txJSON: string;
    instructions: {
        fee: string;
        sequence?: number;
        ticketSequence?: number;
        maxLedgerVersion?: number;
    };
};
export declare type Submit = {
    success: boolean;
    engineResult: string;
    engineResultCode: number;
    engineResultMessage?: string;
    txBlob?: string;
    txJson?: object;
};
export interface OfferCreateTransaction extends TransactionJSON {
    TransactionType: 'OfferCreate';
    Account: string;
    Fee: string;
    Flags: number;
    LastLedgerSequence: number;
    Sequence: number;
    TakerGets: RippledAmount;
    TakerPays: RippledAmount;
    Expiration?: number;
    OfferSequence?: number;
    Memos?: {
        Memo: ApiMemo;
    }[];
}
export interface SettingsTransaction extends TransactionJSON {
    TransferRate?: number;
}
export declare type KeyPair = {
    publicKey: string;
    privateKey: string;
};
export declare type SignOptions = {
    signAs: string;
};
export declare type Outcome = {
    result: string;
    ledgerVersion: number;
    indexInLedger: number;
    fee: string;
    balanceChanges: {
        [key: string]: {
            currency: string;
            counterparty?: string;
            value: string;
        }[];
    };
    orderbookChanges: object;
    deliveredAmount?: {
        currency: string;
        counterparty?: string;
        value: string;
    };
    timestamp?: string;
};
export declare type FormattedOrderCancellation = {
    orderSequence: number;
};
export declare type FormattedPayment = {
    source: Adjustment;
    destination: Adjustment;
    paths?: string;
    memos?: Array<Memo>;
    invoiceID?: string;
    allowPartialPayment?: boolean;
    noDirectRipple?: boolean;
    limitQuality?: boolean;
};
export declare type FormattedPaymentTransaction = {
    type: string;
    specification: FormattedPayment;
    outcome: Outcome;
    id: string;
    address: string;
    sequence: number;
};
export declare type FormattedOrderTransaction = {
    type: string;
    specification: FormattedOrderSpecification;
    outcome: Outcome;
    id: string;
    address: string;
    sequence: number;
};
export declare type FormattedOrderCancellationTransaction = {
    type: string;
    specification: FormattedOrderCancellation;
    outcome: Outcome;
    id: string;
    address: string;
    sequence: number;
};
export declare type FormattedTrustlineTransaction = {
    type: string;
    specification: FormattedTrustlineSpecification;
    outcome: Outcome;
    id: string;
    address: string;
    sequence: number;
};
export declare type FormattedSettingsTransaction = {
    type: string;
    specification: FormattedSettings;
    outcome: Outcome;
    id: string;
    address: string;
    sequence: number;
};
export declare type FormattedTransactionType = FormattedPaymentTransaction | FormattedOrderTransaction | FormattedOrderCancellationTransaction | FormattedTrustlineTransaction | FormattedSettingsTransaction;
//# sourceMappingURL=types.d.ts.map