Documentation GitHub npm

Class

PathCallBuilder

(private) PathCallBuilder(serverUrl, source, destination, destinationAsset, destinationAmount)

The Stellar Network allows payments to be made across assets through path payments. A path payment specifies a series of assets to route a payment through, from source asset (the asset debited from the payer) to destination asset (the asset credited to the payee).

A path search is specified using:

  • The destination address
  • The source address
  • The asset and amount that the destination account should receive

As part of the search, horizon will load a list of assets available to the source address and will find any payment paths from those source assets to the desired destination asset. The search's amount parameter will be used to determine if there a given path can satisfy a payment of the desired amount.

Do not create this object directly, use Horizon.Server#paths.

Constructor

# private new PathCallBuilder(serverUrl, source, destination, destinationAsset, destinationAmount)

Parameters:
Name Type Description
serverUrl string

Horizon server URL.
source string

The sender's account ID. Any returned path must use a source that the sender can hold.
destination string

The destination account ID that any returned path should use.
destinationAsset Asset

The destination asset.
destinationAmount string

The amount, denominated in the destination asset, that any returned path should be able to satisfy.
See:

View Source lib/horizon/path_call_builder.js, line 37

Extends

Members

# private _handleNetworkError

Overrides:

View Source lib/horizon/call_builder.d.ts, line 127

# private _parseRecord

Given the json response, find and convert each link into a function that calls that link.

Overrides:

View Source lib/horizon/call_builder.d.ts, line 106

# private _parseResponse

Overrides:

View Source lib/horizon/call_builder.d.ts, line 113

# private _requestFnForLink

Convert a link object to a function that fetches that link.

Overrides:

View Source lib/horizon/call_builder.d.ts, line 97

# private _toCollectionPage

Overrides:

View Source lib/horizon/call_builder.d.ts, line 120

# private checkFilter

Overrides:

View Source lib/horizon/call_builder.d.ts, line 87

Methods

# call() → {Promise}

Triggers a HTTP request using this builder's current configuration.

Overrides:

View Source lib/horizon/call_builder.d.ts, line 14

a Promise that resolves to the server's response.

Promise

# cursor(cursor) → {object}

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters:
Name Type Description
cursor string

A cursor is a value that points to a specific location in a collection of resources.
Overrides:
See:

View Source lib/horizon/call_builder.d.ts, line 35

current CallBuilder instance

object

# protected forEndpoint(endpoint, param) → {CallBuilder}

A helper method to craft queries to "neighbor" endpoints.

For example, we have an /effects suffix endpoint on many different "root" endpoints, such as /transactions/:id and /accounts/:id. So, it's helpful to be able to conveniently create queries to the /accounts/:id/effects endpoint:

this.forEndpoint("accounts", accountId)`.

Parameters:
Name Type Description
endpoint string

neighbor endpoint in question, like /operations
param string

filter parameter, like an operation ID
Overrides:

View Source lib/horizon/call_builder.d.ts, line 81

this CallBuilder instance

CallBuilder

# join("include") → {object}

Sets join parameter for the current call. The join parameter includes the requested resource in the response. Currently, the only valid value for the parameter is transactions and is only supported on the operations and payments endpoints. The response will include a transaction field for each operation in the response.

Parameters:
Name Type Description
"include"

join Records to be included in the response.
Overrides:

View Source lib/horizon/call_builder.d.ts, line 63

current CallBuilder instance.

object

# limit(recordsNumber) → {object}

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters:
Name Type Description
recordsNumber number

Number of records the server should return.
Overrides:
See:

View Source lib/horizon/call_builder.d.ts, line 43

current CallBuilder instance

object

# order(direction) → {object}

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters:
Name Type Description
direction "asc" | "desc"

Sort direction
Overrides:

View Source lib/horizon/call_builder.d.ts, line 50

current CallBuilder instance

object

# stream(optionsopt) → {function}

Creates an EventSource that listens for incoming messages from the server. To stop listening for new events call the function returned by this method.

Parameters:
Name Type Attributes Description
options object <optional>

EventSource options.
onmessage function <optional>

Callback function to handle incoming messages.
onerror function <optional>

Callback function to handle errors.
reconnectTimeout number <optional>

Custom stream connection timeout in ms, default is 15 seconds.
Overrides:
See:

View Source lib/horizon/call_builder.d.ts, line 27

Close function. Run to close the connection and stop listening for new events.

function