Cardanoex.Network (cardanoex v0.6.0)

The Network module helps you check various information and parameters in the network

Link to this section Summary

Functions

Get network clock information.

Get information about the network.

Get network parameters.

Link to this section Types

Specs

clock() :: %{
  status: String.t(),
  offset: %{quantity: integer(), unit: String.t()}
}
Link to this type

network_information()

Specs

network_information() :: %{
  sync_process: %{
    status: String.t(),
    progress: %{quantity: 0..100, unit: String.t()}
  },
  node_tip: %{
    absolute_slot_number: non_neg_integer(),
    slot_number: non_neg_integer(),
    epoch_number: non_neg_integer(),
    time: String.t(),
    height: %{quantity: non_neg_integer(), unit: String.t()}
  },
  network_tip: %{
    absolute_slot_number: non_neg_integer(),
    slot_number: non_neg_integer(),
    epoch_number: non_neg_integer(),
    time: String.t()
  },
  next_epoch: %{epoch_number: non_neg_integer(), epoch_start_time: String.t()},
  node_era: String.t()
}
Link to this type

parameters()

Specs

parameters() :: %{
  slot_length: %{quantity: non_neg_integer(), unit: String.t()},
  decentralization_level: %{quantity: non_neg_integer(), unit: String.t()},
  maximum_token_bundle_size: %{quantity: non_neg_integer(), unit: String.t()},
  genesis_block_hash: String.t(),
  blockchain_start_time: String.t(),
  desired_pool_number: non_neg_integer(),
  epoch_length: %{quantity: non_neg_integer(), unit: String.t()},
  eras: map(),
  active_slot_coefficient: %{quantity: non_neg_integer(), unit: String.t()},
  security_parameter: %{quantity: non_neg_integer(), unit: String.t()},
  minimum_utxo_value: %{quantity: non_neg_integer(), unit: String.t()},
  maximum_collateral_input_count: non_neg_integer()
}

Link to this section Functions

Specs

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

Get network clock information.

Specs

information() :: {:error, String} | {:ok, network_information()}

Get information about the network.

Specs

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

Get network parameters.