README
¶
no mnemonic
nomnemonic is a deterministic mnemonic generator library that uses 3 inputs and cryptographic hash functions to generate the words.
The library is an implementation of the spec which aims to provide an alternative way for like-minded people/machines to have mnemonic words but also want to access to the seed in the future without any seed storage needs.
Inputs
- Identifier with any size (at least 2 chars)
- Password with any size (at least 8 chars)
- 6 digit numeric pass code
- Number of words: 12, 15, 18, 21, 24
Cryptography
pbkdf2withsha512scryptwithsha256
Outputs
- Mnemonic words
Algorithm
Please refer to SPEC.md
License
Apache License 2.0
Copyright (c) 2022 nomnemonic
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Documentation
¶
Index ¶
Constants ¶
const ( Version = "0.3.0" VersionAlgorithm = "3.0.0" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Mnemonicer ¶
type Mnemonicer interface {
Generate(identifier, password, passcode string, size int) ([]string, error)
CalculateEntropy(words []string) ([]byte, error)
GenerateSeed(sentence, passphrase string) ([]byte, error)
GenerateSeed32(sentence, passphrase string) ([]byte, error)
IsValid(words []string) (bool, error)
}
Source Files