Terrasol v2.0.0

View Source Terrasol.Author (Terrasol v2.0.0)

Handling of Earthstar author strings and resulting Terrasol.Author.t structures

Link to this section Summary

Types

t()

An Earthstar author

Functions

build(input)

Fill a Terrasol.Author structure from an address string or (possibly incomplete) map.

from_keypair_file(filename)

Create a Terrasol.Author structure from a keypair.json-style file

parse(address)

Parse an author address into a Terrasol.Author

to_keypair_file(author, filename)

Write a keypair.json-style file from a supplied identity. As a secret file, the publickey must be included.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Terrasol.Author{
  privatekey: nil | binary(),
  publickey: binary(),
  shortname: String.t(),
  string: String.t()
}

An Earthstar author

Link to this section Functions

Link to this function

build(input)

View Source

Fill a Terrasol.Author structure from an address string or (possibly incomplete) map.

Internal conflict resolution is determinisitic, but depends on implementation-specific ordering which is not gauranteed and should not be depended upon being the same between versions.

:error on invalid input

Link to this function

from_keypair_file(filename)

View Source

Create a Terrasol.Author structure from a keypair.json-style file

:error on error

Link to this function

parse(address)

View Source

Parse an author address into a Terrasol.Author

:error on invalid input

Link to this function

to_keypair_file(author, filename)

View Source

Write a keypair.json-style file from a supplied identity. As a secret file, the publickey must be included.