on_flow v0.13.0

View Source OnFlow.Credentials (on_flow v0.13.0)

Defines a struct that contains an address, a public key, and a private key.

:address might be nil, but the key will be present in the struct.

Do not initialize this directly. Instead, call Credentials.new/1 or Credentials.new!/1.

Link to this section Summary

Types

keys_with_address()
t()

Functions

generate_keys()

Returns a %Credentials{} struct with the keypairs generated.

new(attrs)

Initializes a %Credentials{} struct. Returns {:ok, credentials} on success. The params must contain a :private_key and :public_key, or {:error, :missing_keys} will be returned.

new!(attrs)

Initializes a %Credentials{} struct. Raises on error. See the documentation for new/1.

Link to this section Types

Link to this type

keys_with_address()

View Source 
@type keys_with_address() :: %{
  optional(:address) => nil | String.t(),
  public_key: String.t(),
  private_key: String.t()
}
Link to this type

t()

View Source 
@type t() :: %OnFlow.Credentials{
  address: nil | hex_string(),
  private_key: hex_string(),
  public_key: hex_string()
}

Link to this section Functions

Link to this function

generate_keys()

View Source 
@spec generate_keys() :: t()

Returns a %Credentials{} struct with the keypairs generated.

Link to this function

new(attrs)

View Source 
@spec new(keys_with_address()) :: {:ok, t()} | {:error, :missing_keys}

Initializes a %Credentials{} struct. Returns {:ok, credentials} on success. The params must contain a :private_key and :public_key, or {:error, :missing_keys} will be returned.

:public_key and :private_key must be hex-encoded strings.

Link to this function

new!(attrs)

View Source 
@spec new!(map()) :: t() | none()

Initializes a %Credentials{} struct. Raises on error. See the documentation for new/1.