Interface PathFindResponse

Response expected from a PathFindRequest.



api_version?: number
forwarded?: boolean
id: string | number
result: {
    alternatives: PathFindPathOption[];
    closed?: true;
    destination_account: string;
    destination_amount: Amount;
    full_reply: boolean;
    id?: string | number;
    source_account: string;
    status?: true;

Type declaration

  • alternatives: PathFindPathOption[]

    Array of objects with suggested paths to take, as described below. If empty, then no paths were found connecting the source and destination accounts.

  • Optional closed?: true

    The value true indicates this reply is in response to a path_find close command.

  • destination_account: string

    Unique address of the account that would receive a transaction.

  • destination_amount: Amount

    Currency amount provided in the WebSocket request.

  • full_reply: boolean

    If false, this is the result of an incomplete search. A later reply may have a better path. If true, then this is the best path found. (It is still theoretically possible that a better path could exist, but rippled won't find it.) Until you close the pathfinding request, rippled. Continues to send updates each time a new ledger closes.

  • Optional id?: string | number

    The ID provided in the WebSocket request is included again at this level.

  • source_account: string

    Unique address that would send a transaction.

  • Optional status?: true

    The value true indicates this reply is in response to a path_find status command.

status?: string
type: string
warning?: "load"
warnings?: ResponseWarning[]

Generated using TypeDoc