View Source StellarBase.StrKey (Elixir Stellar Base v0.16.0)

Allows encoding and decoding signatures used in the Stellar network.

Summary

Types

binary_data()

checksum()

data()

decoded_components()

error()

validation()

version()

version_bytes()

Functions

decode(data, version)

decode!(data, version)

encode(data, version)

encode!(data, version)

Types

binary_data()

@type binary_data() :: binary() | nil

checksum()

@type checksum() :: integer()

data()

@type data() :: String.t() | nil

decoded_components()

@type decoded_components() :: {:ok, {version_bytes(), binary(), checksum()}} | error()

error()

@type error() :: {:error, atom()}

validation()

@type validation() :: :ok | error()

version()

@type version() ::
  :ed25519_public_key
  | :ed25519_secret_seed
  | :pre_auth_tx
  | :sha256_hash
  | :muxed_account
  | :signed_payload
  | :contract

version_bytes()

@type version_bytes() :: integer()

Functions

decode(data, version)

@spec decode(data :: data(), version :: version()) :: {:ok, binary()} | error()

decode!(data, version)

@spec decode!(data :: data(), version :: atom()) :: binary() | no_return()

encode(data, version)

@spec encode(data :: binary_data(), version :: version()) ::
  {:ok, String.t()} | {:error, atom()}

encode!(data, version)

@spec encode!(data :: binary_data(), version :: version()) :: String.t() | no_return()