radixir v0.0.2

View Source Radixir.Core.API (radixir v0.0.2)

Submits requests to Core API.

Link to this section Summary

Types

body()
options()

Functions

build_transaction(body, options \\ [])

Submits request to /construction/build.

derive_entity_identifier(body, options \\ [])

Submits request to /construction/derive.

finalize_transaction(body, options \\ [])

Submits request to /construction/finalize.

get_committed_transactions(body, options \\ [])

Submits request to /transactions.

get_entity_information(body, options \\ [])

Submits request to /entity.

get_mempool_transaction(body, options \\ [])

Submits request to /mempool/transaction.

get_mempool_transactions(body, options \\ [])

Submits request to /mempool.

get_network_configuration(options \\ [])

Submits request to /network/configuration.

get_network_status(body, options \\ [])

Submits request to /network/status.

get_public_keys(body, options \\ [])

Submits request to /key/list.

get_transaction_hash(body, options \\ [])

Submits request to /construction/hash.

parse_transaction(body, options \\ [])

Submits request to /construction/parse.

sign_transaction(body, options \\ [])

Submits request to /key/sign.

submit_transaction(body, options \\ [])

Submits request to /construction/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 /construction/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.
    • auth_index (optional, string): auth_index is the index of the username + password combo to be used for endpoint authentication.
    • username: (optional, string): username to be used for endpoint authentication.
    • password: (optional, string): password to be used for endpoint authentication.

Note

  • Either username and password or auth_index must be provided.
  • If all three are provided auth_index is used.

Example

If the following usernames and passwords are exported:

export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'

then passing auth_index: 0 would lead to admin being used as the username and funny cats very Jack 21! being used as the password for endpoint authentication.

Core API Documentation

Link to this function

derive_entity_identifier(body, options \\ [])

View Source

Specs

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

Submits request to /construction/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.
    • auth_index (optional, string): auth_index is the index of the username + password combo to be used for endpoint authentication.
    • username: (optional, string): username to be used for endpoint authentication.
    • password: (optional, string): password to be used for endpoint authentication.

Note

  • Either username and password or auth_index must be provided.
  • If all three are provided auth_index is used.

Example

If the following usernames and passwords are exported:

export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'

then passing auth_index: 0 would lead to admin being used as the username and funny cats very Jack 21! being used as the password for endpoint authentication.

Core API Documentation

Link to this function

finalize_transaction(body, options \\ [])

View Source

Specs

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

Submits request to /construction/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.
    • auth_index (optional, string): auth_index is the index of the username + password combo to be used for endpoint authentication.
    • username: (optional, string): username to be used for endpoint authentication.
    • password: (optional, string): password to be used for endpoint authentication.

Note

  • Either username and password or auth_index must be provided.
  • If all three are provided auth_index is used.

Example

If the following usernames and passwords are exported:

export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'

then passing auth_index: 0 would lead to admin being used as the username and funny cats very Jack 21! being used as the password for endpoint authentication.

Core API Documentation

Link to this function

get_committed_transactions(body, options \\ [])

View Source

Specs

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

Submits request to /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.
    • auth_index (optional, string): auth_index is the index of the username + password combo to be used for endpoint authentication.
    • username: (optional, string): username to be used for endpoint authentication.
    • password: (optional, string): password to be used for endpoint authentication.

Note

  • Either username and password or auth_index must be provided.
  • If all three are provided auth_index is used.

Example

If the following usernames and passwords are exported:

export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'

then passing auth_index: 0 would lead to admin being used as the username and funny cats very Jack 21! being used as the password for endpoint authentication.

Core API Documentation

Link to this function

get_entity_information(body, options \\ [])

View Source

Specs

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

Submits request to /entity.

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.
    • auth_index (optional, string): auth_index is the index of the username + password combo to be used for endpoint authentication.
    • username: (optional, string): username to be used for endpoint authentication.
    • password: (optional, string): password to be used for endpoint authentication.

Note

  • Either username and password or auth_index must be provided.
  • If all three are provided auth_index is used.

Example

If the following usernames and passwords are exported:

export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'

then passing auth_index: 0 would lead to admin being used as the username and funny cats very Jack 21! being used as the password for endpoint authentication.

Core API Documentation

Link to this function

get_mempool_transaction(body, options \\ [])

View Source

Specs

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

Submits request to /mempool/transaction.

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.
    • auth_index (optional, string): auth_index is the index of the username + password combo to be used for endpoint authentication.
    • username: (optional, string): username to be used for endpoint authentication.
    • password: (optional, string): password to be used for endpoint authentication.

Note

  • Either username and password or auth_index must be provided.
  • If all three are provided auth_index is used.

Example

If the following usernames and passwords are exported:

export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'

then passing auth_index: 0 would lead to admin being used as the username and funny cats very Jack 21! being used as the password for endpoint authentication.

Core API Documentation

Link to this function

get_mempool_transactions(body, options \\ [])

View Source

Specs

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

Submits request to /mempool.

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.
    • auth_index (optional, string): auth_index is the index of the username + password combo to be used for endpoint authentication.
    • username: (optional, string): username to be used for endpoint authentication.
    • password: (optional, string): password to be used for endpoint authentication.

Note

  • Either username and password or auth_index must be provided.
  • If all three are provided auth_index is used.

Example

If the following usernames and passwords are exported:

export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'

then passing auth_index: 0 would lead to admin being used as the username and funny cats very Jack 21! being used as the password for endpoint authentication.

Core API Documentation

Link to this function

get_network_configuration(options \\ [])

View Source

Specs

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

Submits request to /network/configuration.

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.
    • auth_index (optional, string): auth_index is the index of the username + password combo to be used for endpoint authentication.
    • username: (optional, string): username to be used for endpoint authentication.
    • password: (optional, string): password to be used for endpoint authentication.

Note

  • Either username and password or auth_index must be provided.
  • If all three are provided auth_index is used.

Example

If the following usernames and passwords are exported:

export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'

then passing auth_index: 0 would lead to admin being used as the username and funny cats very Jack 21! being used as the password for endpoint authentication.

Core API Documentation

Link to this function

get_network_status(body, options \\ [])

View Source

Specs

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

Submits request to /network/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.
    • auth_index (optional, string): auth_index is the index of the username + password combo to be used for endpoint authentication.
    • username: (optional, string): username to be used for endpoint authentication.
    • password: (optional, string): password to be used for endpoint authentication.

Note

  • Either username and password or auth_index must be provided.
  • If all three are provided auth_index is used.

Example

If the following usernames and passwords are exported:

export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'

then passing auth_index: 0 would lead to admin being used as the username and funny cats very Jack 21! being used as the password for endpoint authentication.

Core API Documentation

Link to this function

get_public_keys(body, options \\ [])

View Source

Specs

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

Submits request to /key/list.

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.
    • auth_index (optional, string): auth_index is the index of the username + password combo to be used for endpoint authentication.
    • username: (optional, string): username to be used for endpoint authentication.
    • password: (optional, string): password to be used for endpoint authentication.

Note

  • Either username and password or auth_index must be provided.
  • If all three are provided auth_index is used.

Example

If the following usernames and passwords are exported:

export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'

then passing auth_index: 0 would lead to admin being used as the username and funny cats very Jack 21! being used as the password for endpoint authentication.

Core API Documentation

Link to this function

get_transaction_hash(body, options \\ [])

View Source

Specs

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

Submits request to /construction/hash.

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.
    • auth_index (optional, string): auth_index is the index of the username + password combo to be used for endpoint authentication.
    • username: (optional, string): username to be used for endpoint authentication.
    • password: (optional, string): password to be used for endpoint authentication.

Note

  • Either username and password or auth_index must be provided.
  • If all three are provided auth_index is used.

Example

If the following usernames and passwords are exported:

export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'

then passing auth_index: 0 would lead to admin being used as the username and funny cats very Jack 21! being used as the password for endpoint authentication.

Core API Documentation

Link to this function

parse_transaction(body, options \\ [])

View Source

Specs

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

Submits request to /construction/parse.

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.
    • auth_index (optional, string): auth_index is the index of the username + password combo to be used for endpoint authentication.
    • username: (optional, string): username to be used for endpoint authentication.
    • password: (optional, string): password to be used for endpoint authentication.

Note

  • Either username and password or auth_index must be provided.
  • If all three are provided auth_index is used.

Example

If the following usernames and passwords are exported:

export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'

then passing auth_index: 0 would lead to admin being used as the username and funny cats very Jack 21! being used as the password for endpoint authentication.

Core API Documentation

Link to this function

sign_transaction(body, options \\ [])

View Source

Specs

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

Submits request to /key/sign.

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.
    • auth_index (optional, string): auth_index is the index of the username + password combo to be used for endpoint authentication.
    • username: (optional, string): username to be used for endpoint authentication.
    • password: (optional, string): password to be used for endpoint authentication.

Note

  • Either username and password or auth_index must be provided.
  • If all three are provided auth_index is used.

Example

If the following usernames and passwords are exported:

export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'

then passing auth_index: 0 would lead to admin being used as the username and funny cats very Jack 21! being used as the password for endpoint authentication.

Core API Documentation

Link to this function

submit_transaction(body, options \\ [])

View Source

Specs

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

Submits request to /construction/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.
    • auth_index (optional, string): auth_index is the index of the username + password combo to be used for endpoint authentication.
    • username: (optional, string): username to be used for endpoint authentication.
    • password: (optional, string): password to be used for endpoint authentication.

Note

  • Either username and password or auth_index must be provided.
  • If all three are provided auth_index is used.

Example

If the following usernames and passwords are exported:

export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'

then passing auth_index: 0 would lead to admin being used as the username and funny cats very Jack 21! being used as the password for endpoint authentication.

Core API Documentation