Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

expand documentation about seed format (electrum mnemonic words), detail specific version numbers #110

Open
SomberNight opened this issue Jul 3, 2020 · 1 comment

Comments

@SomberNight
Copy link
Member

@chris-belcher asked on IRC for more detailed documentation about the seed format.

We currently have seedphrase.rst but it only details how to calculate the version number of a seed, and lists registered version numbers.

We should either expand that doc, or add another, that details the schemes that correspond to specific version numbers, i.e. how to go from seed words to bip32 chains (and what to use those chains for).

Note that there are unit tests here: https://github.com/spesmilo/electrum/blob/8d7370d897314d8542906aecc6a45cc949651f77/electrum/tests/test_wallet_vertical.py#L106
we could link to those in the doc, resolving potential ambiguities

Related:
https://github.com/spesmilo/electrum/blob/8d7370d897314d8542906aecc6a45cc949651f77/electrum/mnemonic.py#L159
https://github.com/spesmilo/electrum/blob/8d7370d897314d8542906aecc6a45cc949651f77/electrum/keystore.py#L975

@chris-belcher
Copy link

One of Electrum's selling points is "No Lock-In - Exportable keys to other clients." That also justifies working on this documentation, because maybe other software will end up supporting electrum seed phrases and users could use those to recover their funds too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants