View Source Baobab (Baobab v0.12.1)
Baobab is a pure Elixir implementation of the Bamboo append-only log.
It is fairly opinionated about the DETS persistence of the logs. They are considered to be a spool of the logs as retreived.
Consumers of this library may wish to place a local copy of the logs in a store with better indexing and query properties.
configuration
Configuration
config :baobab, spool_dir: "/tmp"
options
Options
format
::entry
or:binary
, default::entry
log_id
: the author's log identifier, default0
clump_id
: the bamboo clump with which associated, default:"default"
revalidate
: confirm the store contents are unchanged, default:false
replace
: rewrite log contents even if it exists, default:false
Link to this section Summary
Functions
A list of all {author, log_id, seqnum} tuples in the configured store
Retrieve the list of sequence numbers on a particular log identified by the author key and log number
Create and store a new log entry for a stored identity
Resolve an identity to its Base62 representation
Compact log contents to only items in the certificate pool for the latest entry. This allows validation while reducing space used
Create and store a new identity
Retrieve the current hash of the :content
or :identity
store.
Drop a stored identity. Baobab
will be unable to recover keys
(notably :secret
keys) destroyed herewith.
Retrieve all available entries in a particular log
List all known identities with their base62 public key representation
Retrieve the key for a stored identity.
Import and store a list of log entries from their binary format.
Retrieve an author log at a particular sequence number. Includes the available certificate pool for its verification.
Retreive a paticular entry by author and sequence number.
Retrieve all available author log entries over a specified range: {first, last}
.
Retrieve the latest sequence number on a particular log identified by the author key and log number
Purges a given log.
Rename an extant identity leaving its keys intact.
A list of {author, log_id, max_seqnum} tuples in the configured store
Link to this section Functions
A list of all {author, log_id, seqnum} tuples in the configured store
Retrieve the list of sequence numbers on a particular log identified by the author key and log number
Create and store a new log entry for a stored identity
Resolve an identity to its Base62 representation
Attempts to resolve ~short
using stored logs
Compact log contents to only items in the certificate pool for the latest entry. This allows validation while reducing space used
Create and store a new identity
An optional secret key to be associated with the identity may provided, either raw or base62 encoded. The public key will be derived therefrom.
Retrieve the current hash of the :content
or :identity
store.
No information should be gleaned from any particular hash beyond whether the contents have changed since a previous check.
Drop a stored identity. Baobab
will be unable to recover keys
(notably :secret
keys) destroyed herewith.
Retrieve all available entries in a particular log
List all known identities with their base62 public key representation
Retrieve the key for a stored identity.
Can be either the :public
or :secret
key
Import and store a list of log entries from their binary format.
Retrieve an author log at a particular sequence number. Includes the available certificate pool for its verification.
Using :max
as the sequence number will use the latest
Retreive a paticular entry by author and sequence number.
:max
for the sequence number retrieves the latest known entry
Retrieve all available author log entries over a specified range: {first, last}
.
Retrieve the latest sequence number on a particular log identified by the author key and log number
Purges a given log.
:all
may be specified for author
and/or the log_id
option.
Specifying both effectively clears the entire store.
Returns Baobab.stored_info/0
examples
Examples
iex> Baobab.purge(:all, log_id: :all) []
Rename an extant identity leaving its keys intact.
A list of {author, log_id, max_seqnum} tuples in the configured store