View Source Eddy.PrivKey (Eddy v1.0.0)

Module for working with private keys.

PrivKey structs can be encoded to and from binary data, using any encoding.

Link to this section Summary

Types

t()

Private Key

Functions

Converts the given binary data to a PrivKey struct, optionally with the specified encoding.

Converts the given PrivKey struct to a binary, optionally with the specified encoding.

Link to this section Types

@type t() :: %Eddy.PrivKey{d: <<_::256>>}

Private Key

An Ed25519 private key is 256 bits of cryptographically secure random data.

Link to this section Functions

Link to this function

from_bin(data, encoding \\ nil)

View Source
@spec from_bin(binary(), Eddy.encoding() | nil) :: {:ok, t()} | {:error, term()}

Converts the given binary data to a PrivKey struct, optionally with the specified encoding.

Returns the result in an :ok / :error tuple pair.

Link to this function

to_bin(priv_key, encoding \\ nil)

View Source
@spec to_bin(t(), Eddy.encoding() | nil) :: binary()

Converts the given PrivKey struct to a binary, optionally with the specified encoding.