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

Exposes functions to interact with Assets in Horizon.

You can:

List all assets.
List assets by asset_code.
List assets by asset_issuer.

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

Summary

Types

asset_code()

asset_issuer()

options()

resource()

response()

server()

Functions

all(server, options \\ [])

Lists all assets or by one of these filters: asset_code or asset_issuer.

list_by_asset_code(server, asset_code, options \\ [])

Lists assets matching the given asset code.

list_by_asset_issuer(server, asset_issuer, options \\ [])

Lists assets matching the given asset issuer.

Types

asset_code()

@type asset_code() :: String.t()

asset_issuer()

@type asset_issuer() :: String.t()

options()

@type options() :: Keyword.t()

resource()

@type resource() :: Stellar.Horizon.Asset.t() | Stellar.Horizon.Collection.t()

response()

@type response() :: {:ok, resource()} | {:error, Stellar.Horizon.Error.t()}

server()

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

Functions

all(server, options \\ [])

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

Lists all assets or by one of these filters: asset_code or asset_issuer.

Parameters

server: The Horizon server to query.

Options

asset_code: The code of the asset you would like to filter by.
asset_issuer: The issuer's Account ID for the asset you would like to filter by.
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> Assets.all(Stellar.Horizon.Server.testnet(), limit: 20, order: :desc)
{:ok, %Collection{records: [%Asset{}, ...]}}

# list by asset_code
iex> Assets.all(Stellar.Horizon.Server.testnet(), asset_code: "TEST")
{:ok, %Collection{records: [%Asset{}, ...]}}

# list by asset_issuer
iex> Assets.all(Stellar.Horizon.Server.testnet(), asset_issuer: "GCXMWUAUF37IWOOV2FRDKWEX3O2IHLM2FYH4WPI4PYUKAIFQEUU5X3TD")
{:ok, %Collection{records: [%Asset{}, ...]}}

list_by_asset_code(server, asset_code, options \\ [])

@spec list_by_asset_code(
  server :: server(),
  asset_code :: asset_code(),
  options :: options()
) :: response()

Lists assets matching the given asset code.

Parameters:

server: The Horizon server to query.
asset_code: The code of the asset you would like to filter by.

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> Assets.list_by_asset_code(Stellar.Horizon.Server.testnet(), "TEST")
{:ok, %Collection{records: [%Asset{asset_code: "TEST"}, ...]}}

list_by_asset_issuer(server, asset_issuer, options \\ [])

@spec list_by_asset_issuer(
  server :: server(),
  asset_issuer :: asset_issuer(),
  options :: options()
) :: response()

Lists assets matching the given asset issuer.

Parameters:

server: The Horizon server to query.
asset_issuer: The issuer's Account ID for the asset you would like to filter by.

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> Assets.list_by_asset_issuer(Stellar.Horizon.Server.testnet(), "GCXMWUAUF37IWOOV2FRDKWEX3O2IHLM2FYH4WPI4PYUKAIFQEUU5X3TD")
{:ok, %Collection{records: [%Asset{asset_issuer: "GCXMWUAUF37IWOOV2FRDKWEX3O2IHLM2FYH4WPI4PYUKAIFQEUU5X3TD"}, ...]}}