cardanoex v0.6.1

Cardanoex.Address (cardanoex v0.6.1)

The Address module lets you work with addresses for a wallet.

Link to this section Summary

Types

address()
inspected_address()

Functions

inspect(address)

Give useful information about the structure of a given address.

list(wallet_id)

Return a list of known addresses, ordered from newest to oldest

Link to this section Types

Link to this type

address()

Specs

address() :: %{id: String.t(), state: String.t(), derivation_path: [String.t()]}
Link to this type

inspected_address()

Specs

inspected_address() :: %{
  address_style: String.t(),
  stake_reference: String.t(),
  network_tag: non_neg_integer() | nil,
  spending_key_hash: String.t(),
  spending_key_bech32: String.t(),
  stake_key_hash: String.t(),
  stake_key_bech32: String.t(),
  script_hash: String.t(),
  script_hash_bech32: String.t(),
  pointer: %{
    slot_num: non_neg_integer(),
    transaction_index: non_neg_integer(),
    output_index: non_neg_integer()
  },
  address_root: String.t(),
  derivation_path: String.t()
}

Link to this section Functions

Link to this function

inspect(address)

Specs

inspect(String.t()) :: {:error, String.t()} | {:ok, inspected_address()}

Give useful information about the structure of a given address.

Options

  • address
Link to this function

list(wallet_id)

Specs

list(String.t()) :: {:error, String.t()} | {:ok, address()}

Return a list of known addresses, ordered from newest to oldest

Options

  • wallet_id - hex based string. 40 characters