BSV.ARC.Types (bsv_sdk v1.1.0)

ARC data types: status codes and API response structures.

Summary

Types

arc_status()

Functions

all_statuses()

All valid status atoms.

parse_status(str)

Parses a status string like "MINED" to an atom.

status_code(status)

Returns the integer code for an ARC status atom.

status_string(status)

Returns the string representation for an ARC status atom.

Types

arc_status()

@type arc_status() ::
  :rejected
  | :queued
  | :received
  | :stored
  | :announced_to_network
  | :requested_by_network
  | :sent_to_network
  | :accepted_by_network
  | :seen_on_network
  | :mined
  | :confirmed
  | :double_spend_attempted
  | :seen_in_orphan_mempool

Functions

all_statuses()

@spec all_statuses() :: [arc_status()]

All valid status atoms.

parse_status(str)

@spec parse_status(String.t()) :: {:ok, arc_status()} | :error

Parses a status string like "MINED" to an atom.

status_code(status)

@spec status_code(arc_status()) :: integer()

Returns the integer code for an ARC status atom.

status_string(status)

@spec status_string(arc_status()) :: String.t()

Returns the string representation for an ARC status atom.