radixir v0.0.3

View Source Radixir.Gateway.API (radixir v0.0.3)

Submits requests to Gateway API.

Link to this section Summary

Types

body()
options()

Functions

build_transaction(body, options \\ [])

Submits request to /transaction/build.

derive_account_identifier(body, options \\ [])

Submits request to /account/derive.

derive_token_identifier(body, options \\ [])

Submits request to /token/derive.

derive_validator_identifier(body, options \\ [])

Submits request to /validator/derive.

finalize_transaction(body, options \\ [])

Submits request to /transaction/finalize.

get_account_balances(body, options \\ [])

Submits request to /account/balances.

get_account_transactions(body, options \\ [])

Submits request to /account/transactions.

get_info(options \\ [])

Submits request to /gateway.

get_native_token_info(body, options \\ [])

Submits request to /token/native.

get_stake_positions(body, options \\ [])

Submits request to /account/stakes.

get_token_info(body, options \\ [])

Submits request to /token.

get_transaction_rules(body, options \\ [])

Submits request to /transaction/rules.

get_transaction_status(body, options \\ [])

Submits request to /transaction/status.

get_unstake_positions(body, options \\ [])

Submits request to /account/unstakes.

get_validator(body, options \\ [])

Submits request to /validator.

get_validator_stakes(body, options \\ [])

Submits request to /validator/stakes.

get_validators(body, options \\ [])

Submits request to /validators.

submit_transaction(body, options \\ [])

Submits request to /transaction/submit.

Link to this section Types

Link to this type

body()

View Source

Specs

body() :: map()
Link to this type

options()

View Source

Specs

options() :: keyword()

Link to this section Functions

Link to this function

build_transaction(body, options \\ [])

View Source

Specs

build_transaction(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /transaction/build.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

derive_account_identifier(body, options \\ [])

View Source

Specs

derive_account_identifier(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /account/derive.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

derive_token_identifier(body, options \\ [])

View Source

Specs

derive_token_identifier(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /token/derive.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

derive_validator_identifier(body, options \\ [])

View Source

Specs

derive_validator_identifier(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /validator/derive.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

finalize_transaction(body, options \\ [])

View Source

Specs

finalize_transaction(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /transaction/finalize.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

get_account_balances(body, options \\ [])

View Source

Specs

get_account_balances(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /account/balances.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

get_account_transactions(body, options \\ [])

View Source

Specs

get_account_transactions(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /account/transactions.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

get_info(options \\ [])

View Source

Specs

get_info(options()) :: {:ok, map()} | {:error, map()}

Submits request to /gateway.

Parameters

  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

get_native_token_info(body, options \\ [])

View Source

Specs

get_native_token_info(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /token/native.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

get_stake_positions(body, options \\ [])

View Source

Specs

get_stake_positions(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /account/stakes.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

get_token_info(body, options \\ [])

View Source

Specs

get_token_info(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /token.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

get_transaction_rules(body, options \\ [])

View Source

Specs

get_transaction_rules(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /transaction/rules.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

get_transaction_status(body, options \\ [])

View Source

Specs

get_transaction_status(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /transaction/status.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

get_unstake_positions(body, options \\ [])

View Source

Specs

get_unstake_positions(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /account/unstakes.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

get_validator(body, options \\ [])

View Source

Specs

get_validator(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /validator.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

get_validator_stakes(body, options \\ [])

View Source

Specs

get_validator_stakes(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /validator/stakes.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

get_validators(body, options \\ [])

View Source

Specs

get_validators(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /validators.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation

Link to this function

submit_transaction(body, options \\ [])

View Source

Specs

submit_transaction(body(), options()) :: {:ok, map()} | {:error, map()}

Submits request to /transaction/submit.

Parameters

  • body: Request body.
  • options: Keyword list that contains
    • url (optional, string): If url is not found in options then the url set in the configs will be used.

Gateway API Documentation