Interface ClientOptions

interface ClientOptions {
    agent?: Agent;
    authorization?: string;
    connectionTimeout?: number;
    feeCushion?: number;
    headers?: { [key: string]: string };
    maxFeeXRP?: string;
    timeout?: number;
    trace?: boolean | (id: string, message: string) => void;
}

Hierarchy

  • ConnectionUserOptions
    • ClientOptions

Fee

feeCushion? maxFeeXRP?

Other

agent? authorization? connectionTimeout? headers? timeout? trace?

Fee

OptionalfeeCushion

feeCushion?: number

Multiplication factor to multiply estimated fee by to provide a cushion in case the required fee rises during submission of a transaction. Defaults to 1.2.

OptionalmaxFeeXRP

maxFeeXRP?: string

Maximum transaction cost to allow, in decimal XRP. Must be a string-encoded number. Defaults to '2'.

Other

Optionalagent

agent?: Agent

Optionalauthorization

authorization?: string

OptionalconnectionTimeout

connectionTimeout?: number

Optionalheaders

headers?: { [key: string]: string }

Optionaltimeout

timeout?: number

Duration to wait for a request to timeout.

Optionaltrace

trace?: boolean | (id: string, message: string) => void

Settings

Member Visibility

On This Page

Fee
Other