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

Lists all successful operations.

Parameters:

• server: The Horizon server to query.

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> Operations.all(Stellar.Horizon.Server.testnet(), limit: 10, order: :asc)
{:ok, %Collection{records: [%Operation{}, ...]}}

# include failed
iex> Operations.all(Stellar.Horizon.Server.testnet(), limit: 10, include_failed: true)
{:ok, %Collection{records: [%Operation{}, ...]}}

# join transactions
iex> Operations.all(Stellar.Horizon.Server.testnet(), limit: 10, join: "transactions")
{:ok, %Collection{records: [%Operation{transaction: %Transaction{}}, ...]}}

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

Lists the effects of a specific operation.

Parameters

• server: The Horizon server to query.
• operation_id: The ID number for the operation.

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> Operations.list_effects(Stellar.Horizon.Server.testnet(), 121693057904021505, limit: 20)
{:ok, %Collection{records: [%Effect{}, ...]}}

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

Lists successful payment-related operations.

Parameters

• server: The Horizon server to query.

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> Operations.list_payments(Stellar.Horizon.Server.testnet(), limit: 20)
{:ok, %Collection{records: [%Operation{body: %Payment{}}, ...]}}

@spec retrieve(
  server :: server(),
  operation_id :: operation_id(),
  options :: options()
) :: response()

Retrieves information of a specific operation.

Parameters:

• server: The Horizon server to query.
• operation_id: The ID number for the operation.

Examples

iex> Operations.retrieve(Stellar.Horizon.Server.testnet(), 121693057904021505)
{:ok, %Operation{}}