LiquidityPoolCallBuilder

LiquidityPoolCallBuilder

LiquidityPoolCallBuilder

Constructor

new LiquidityPoolCallBuilder(serverUrl)

Source:
Parameters:
Name Type Description
serverUrl string

Horizon server URL.

Extends

Methods

call() → {Promise}

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

Inherited From:
Source:
Returns:
Type:
Promise

a Promise that resolves to the server's response.

cursor(cursor) → {object}

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

Inherited From:
Source:
See:
Parameters:
Name Type Description
cursor string

A cursor is a value that points to a specific location in a collection of resources.
Returns:
Type:
object

current CallBuilder instance

forAccount(id) → {LiquidityPoolCallBuilder}

Retrieves all pools an account is participating in.

Source:
Parameters:
Name Type Description
id string

the participant account to filter by
Returns:
Type:
LiquidityPoolCallBuilder

current LiquidityPoolCallBuilder instance

forAssets(…assets) → {LiquidityPoolCallBuilder}

Filters out pools whose reserves don't exactly match these assets.

Source:
See:
Parameters:
Name Type Attributes Description
assets <repeatable>
Returns:
Type:
LiquidityPoolCallBuilder

current LiquidityPoolCallBuilder instance

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)`.

Inherited From:
Source:
Parameters:
Name Type Description
endpoint string

neighbor endpoint in question, like /operations
param string

filter parameter, like an operation ID
Returns:
Type:
CallBuilder

this CallBuilder instance

join(join) → {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.

Inherited From:
Source:
Parameters:
Name Type Description
join "transactions"

Records to be included in the response.
Returns:
Type:
object

current CallBuilder instance.

limit(number) → {object}

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

Inherited From:
Source:
See:
Parameters:
Name Type Description
number number

Number of records the server should return.
Returns:
Type:
object

current CallBuilder instance

liquidityPoolId(id) → {CallBuilder}

Retrieves a specific liquidity pool by ID.

Source:
Parameters:
Name Type Description
id string

the hash/ID of the liquidity pool
Returns:
Type:
CallBuilder

a new CallBuilder instance for the /liquidity_pools/:id endpoint

order(direction) → {object}

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

Inherited From:
Source:
Parameters:
Name Type Description
direction "asc" | "desc"

Sort direction
Returns:
Type:
object

current CallBuilder instance

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.

Inherited From:
Source:
See:
Parameters:
Name Type Attributes Description
options object <optional>

EventSource options.

Name Type Attributes Description
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.
Returns:
Type:
function

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