https://github.com/staltz/ssb-keys-mnemonic
Module that converts from/to SSB keys and BIP39 mnemonic codes
https://github.com/staltz/ssb-keys-mnemonic
bip39 bip39-mnemonic-codes mnemonic ssb ssb-server
Last synced: 6 months ago
JSON representation
Module that converts from/to SSB keys and BIP39 mnemonic codes
- Host: GitHub
- URL: https://github.com/staltz/ssb-keys-mnemonic
- Owner: staltz
- License: mit
- Created: 2019-09-24T12:48:47.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-03-03T21:18:07.000Z (over 3 years ago)
- Last Synced: 2025-04-03T10:39:13.680Z (7 months ago)
- Topics: bip39, bip39-mnemonic-codes, mnemonic, ssb, ssb-server
- Language: JavaScript
- Size: 14.6 KB
- Stars: 15
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ssb-keys-mnemonic
Module that converts from/to SSB keys and [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonic codes.
```
npm install --save ssb-keys-mnemonic
```
## Usage
### keysToWords(keys: object): string
```js
const mnemonic = require('ssb-keys-mnemonic')
const keys = {
curve: 'ed25519',
public: '1nf1T1tUSa43dWglCHzyKIxV61jG/EeeL1Xq1Nk8I3U=.ed25519',
private: 'GO0Lv5BvcuuJJdHrokHoo0PmCDC/XjO/SZ6H+ddq4UvWd/VPW1RJrjd1aCUIfPIojFXrWMb8R54vVerU2TwjdQ==.ed25519',
id: '@1nf1T1tUSa43dWglCHzyKIxV61jG/EeeL1Xq1Nk8I3U=.ed25519'
}
const words = mnemonic.keysToWords(keys)
console.log(words)
/*
'body hair useful camp warm into cause riot two bamboo kick educate dinosaur advice seed type crisp where guilt avocado output rely lunch goddess'
*/
```
### wordsToKeys(words: string): object
```js
const mnemonic = require('ssb-keys-mnemonic')
const words = 'body hair useful camp warm into cause riot two bamboo kick educate dinosaur advice seed type crisp where guilt avocado output rely lunch goddess'
const keys = mnemonic.wordsToKeys(words)
console.log(keys)
/*
{ curve: 'ed25519',
public: '1nf1T1tUSa43dWglCHzyKIxV61jG/EeeL1Xq1Nk8I3U=.ed25519',
private: 'GO0Lv5BvcuuJJdHrokHoo0PmCDC/XjO/SZ6H+ddq4UvWd/VPW1RJrjd1aCUIfPIojFXrWMb8R54vVerU2TwjdQ==.ed25519',
id: '@1nf1T1tUSa43dWglCHzyKIxV61jG/EeeL1Xq1Nk8I3U=.ed25519' }
*/
```
## License
MIT