View Source Stellar.Horizon.Effects (Elixir Stellar SDK v0.22.0)

Exposes functions to interact with Effects in Horizon.

You can:

  • List all effects.

Horizon API reference: https://developers.stellar.org/api/resources/effects/

Summary

Types

options()
resource()
response()
server()

Functions

all(server, options \\ [])

Lists all effects.

Types

Link to this type

options()

View Source 
@type options() :: Keyword.t()
Link to this type

resource()

View Source 
@type resource() :: Stellar.Horizon.Effect.t() | Stellar.Horizon.Collection.t()
Link to this type

response()

View Source 
@type response() :: {:ok, resource()} | {:error, Stellar.Horizon.Error.t()}
Link to this type

server()

View Source 
@type server() :: Stellar.Horizon.Server.t()

Functions

Link to this function

all(server, options \\ [])

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

Lists all effects.

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.

Examples 

iex> Effects.all(Stellar.Horizon.Server.testnet(), limit: 10, order: :asc)
{:ok, %Collection{records: [%Effect{}, ...]}}