@spec all(server :: server(), options :: options()) :: response()

Lists all available claimable balances.

Parameters:

• server: The Horizon server to query.

Options

• reserves: Comma-separated list of assets in canonical form “Code:IssuerAccountID”.
• account: Account ID of the destination address.
• cursor: A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.
• order: A designation of the order in which records should appear. Options include asc (ascending) or desc (descending).
• limit: The maximum number of records returned. The limit can range from 1 to 200. Defaults to 10.

Examples

iex> LiquidityPools.all(Stellar.Horizon.Server.testnet(), limit: 2, order: :asc)
{:ok, %Collection{records: [%LiquidityPool{}, ...]}}

# list by reserves
iex> LiquidityPools.all(Stellar.Horizon.Server.testnet(), reserves: "TEST:GCXMW..., TEST2:GCXMW...")
{:ok, %Collection{records: [%LiquidityPool{}, ...]}}

# list by account
iex> LiquidityPools.all(Stellar.Horizon.Server.testnet(), account: "GCXMWUAUF37IWOOV2FRDKWEX3O2IHLM2FYH4WPI4PYUKAIFQEUU5X3TD", order: :desc)
{:ok, %Collection{records: [%LiquidityPool{}, ...]}}

@spec list_effects(
  server :: server(),
  liquidity_pool_id :: liquidity_pool_id(),
  options :: options()
) :: response()

Lists the effects of a specific liquidity pool.

Parameters

• server: The Horizon server to query.
• liquidity_pool_id: A liquidity pool’s id encoded in a hex string representation.

Options

• cursor: A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.
• order: A designation of the order in which records should appear. Options include asc (ascending) or desc (descending).
• limit: The maximum number of records returned. The limit can range from 1 to 200. Defaults to 10.

Examples

iex> LiquidityPools.list_effects(Stellar.Horizon.Server.testnet(), "001365fc79ca661f31ba3ee0849ae4ba36f5c377243242d37fad5b1bb8912dbc", limit: 20)
{:ok, %Collection{records: [%Effect{}, ...]}}

@spec list_operations(
  server :: server(),
  liquidity_pool_id :: liquidity_pool_id(),
  options :: options()
) :: response()

Lists successful operations referencing a given liquidity pool.

Parameters

• server: The Horizon server to query.
• liquidity_pool_id: A liquidity pool’s id encoded in a hex string representation.

Options

• cursor: A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.
• order: A designation of the order in which records should appear. Options include asc (ascending) or desc (descending).
• limit: The maximum number of records returned. The limit can range from 1 to 200. Defaults to 10.
• include_failed: Set to true to include failed operations in results.
• join: Set to transactions to include the transactions which created each of the operations in the response.

Examples

iex> LiquidityPools.list_operations(Stellar.Horizon.Server.testnet(), "001365fc79ca661f31ba3ee0849ae4ba36f5c377243242d37fad5b1bb8912dbc", limit: 20)
{:ok, %Collection{records: [%Operation{}, ...]}}

# join transactions
iex> LiquidityPools.list_operations(Stellar.Horizon.Server.testnet(), "001365fc79ca661f31ba3ee0849ae4ba36f5c377243242d37fad5b1bb8912dbc", join: "transactions")
{:ok, %Collection{records: [%Operation{transaction: %Transaction{}}, ...]}}

@spec list_trades(
  server :: server(),
  liquidity_pool_id :: liquidity_pool_id(),
  options :: options()
) :: response()

Lists the successful trades fulfilled by the given liquidity pool.

Parameters

• server: The Horizon server to query.
• liquidity_pool_id: A liquidity pool’s id encoded in a hex string representation.

Options

• cursor: A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.
• order: A designation of the order in which records should appear. Options include asc (ascending) or desc (descending).
• limit: The maximum number of records returned. The limit can range from 1 to 200. Defaults to 10.

Examples

iex> LiquidityPools.list_trades(Stellar.Horizon.Server.testnet(), "001365fc79ca661f31ba3ee0849ae4ba36f5c377243242d37fad5b1bb8912dbc", limit: 20)
{:ok, %Collection{records: [%Trade{}, ...]}}

@spec list_transactions(
  server :: server(),
  liquidity_pool_id :: liquidity_pool_id(),
  options :: options()
) :: response()

Lists successful transactions referencing a given liquidity pool.

Parameters

• server: The Horizon server to query.
• liquidity_pool_id: A liquidity pool’s id encoded in a hex string representation.

Options

• cursor: A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.
• order: A designation of the order in which records should appear. Options include asc (ascending) or desc (descending).
• limit: The maximum number of records returned. The limit can range from 1 to 200. Defaults to 10.
• include_failed: Set to true to include failed operations in results.

Examples

iex> LiquidityPools.list_transactions(Stellar.Horizon.Server.testnet(), "001365fc79ca661f31ba3ee0849ae4ba36f5c377243242d37fad5b1bb8912dbc", limit: 20)
{:ok, %Collection{records: [%Transaction{}, ...]}}

@spec retrieve(server :: server(), liquidity_pool_id :: liquidity_pool_id()) ::
  response()

Retrieves information of a specific liquidity pool.

Parameters:

• server: The Horizon server to query.
• liquidity_pool_id: A liquidity pool’s id encoded in a hex string representation.

Examples

iex> LiquidityPools.retrieve(Stellar.Horizon.Server.testnet(), "001365fc79ca661f31ba3ee0849ae4ba36f5c377243242d37fad5b1bb8912dbc")
{:ok, %LiquidityPool{}}