Crate harpo[−][src]
Expand description
harpo
The harpo crate provides functionality to secret-share seed phrases.
The main functions that harpo provides are:
- generate_seed_phrase: Generate a random seed phrase.
- validate_seed_phrase: Validate a given seed phrase.
- create_secret_shared_seed_phrases: Given a valid seed phrase, create the requested number of secret-shared seed phrases. A threshold must be provided as well, specifying how many secret-shared seed phrases are required to reconstruct the original seed phrase.
- reconstruct_seed_phrase: Given a set of secret-shared seed phrases, the function reconstructs a seed phrase.
The additional functionality that harpo provides is documented below.
Modules
The seed_phrase module provides the functionality to convert a seed phrase into a finite
field element and vice versa.
Enums
This enumeration type is returned by the main library functions if there is an error.
Constants
The maximum number of shares that can be embedded.
It is 2^NUM_BITS_FOR_INDEX = 16 because 4 bits are used to encode the index in the embedding.
It is not easily possible to use more than 4 bits because only 4 additional bits are used
when using a 12-word seed phrase (12*11 = 132 bits to encode a secret of 128 bits).
Functions
The function is called to create secret-shared seed phrases.
The function is called to create secret-shared seed phrases.
The function generates and returns a random seed phrase.
The function generates and returns a random seed phrase.
The function is called to reconstruct a seed phrase.
The function is called to reconstruct a seed phrase.
The function validates a given seed phrase using the standard word list.
The function validates a given seed phrase.
Type Definitions
A result that contains a HarpoError in the Err case.
A HarpoResult that encapsulates a
SeedPhrase in the Ok case.