-
-
Notifications
You must be signed in to change notification settings - Fork 18
/
setup.py
409 lines (349 loc) · 17.4 KB
/
setup.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
import os
import sys
import glob
import fnmatch
#
# All platforms
#
HERE = os.path.dirname( os.path.abspath( __file__ ))
install_requires = open( os.path.join( HERE, "requirements.txt" )).readlines()
tests_require = open( os.path.join( HERE, "requirements-tests.txt" )).readlines()
options_require = [
'gui', # slip39[gui]: Support PySimpleGUI/tkinter Graphical UI App
'serial', # slip39[serial]: Support serial I/O of generated wallet data
'wallet', # slip39[wallet]: Paper Wallet and BIP-38/Ethereum wallet encryption
'invoice', # slip39[invoice]: Generation of invoices, and associated Smart Contracts
]
extras_require = {
option: list(
# Remove whitespace, elide blank lines and comments
''.join( r.split() )
for r in open( os.path.join( HERE, f"requirements-{option}.txt" )).readlines()
if r.strip() and not r.strip().startswith( '#' )
)
for option in options_require
}
# Make python-slip39[all] install all extra (non-tests) requirements, excluding duplicates
extras_require['all'] = list( set( sum( extras_require.values(), [] )))
# Since setuptools is retiring tests_require, add it as another option (but not included in 'all')
extras_require['tests'] = tests_require
Executable = None
if sys.platform == 'win32':
# We use cx_Freeze for executable/installer packaging on Windows, only, for now.
from cx_Freeze import setup, Executable
print( f"sys.platform {sys.platform}: Using cx_Freeze.setup" )
else:
from setuptools import setup
print( f"sys.platform {sys.platform}: Using setuptools.setup" )
#
# For various platforms, extra setup options are required. Collect them here
#
extra_options = {}
#
# cx_Freeze options -- Windows .exe/.msi support
# cx-freeze.readthedocs.io/en/latest/setup_script.html
#
mainscript = "SLIP-39.py"
copyright = "Copyright (c) 2022 Perry Kundert",
if sys.platform == 'win32':
company_name = "pjkundert"
product_name = "python-slip39"
icon_win = "images/SLIP-39.ico"
shortcut = (
"DesktopShortcut", # Shortcut
"DesktopFolder", # Directory_
"SLIP-39", # Name
"TARGETDIR", # Component_
"[TARGETDIR]SLIP-39.exe", # Target
None, # Arguments
None, # Description
None, # Hotkey
None, # Icon
None, # IconIndex
None, # ShowCmd
"TARGETDIR", # WkDir
)
msi_data = dict(
Shortcut = [
shortcut,
],
#Icon = [
# icon_win,
#]
)
bdist_msi_options = dict(
add_to_path = True,
data = msi_data,
initial_target_dir = rf"[ProgramFilesFolder]\{company_name}\{product_name}",
)
build_exe_options = dict(
packages = [
'eth_account', 'Crypto', 'hdwallet', 'shamir_mnemonic', 'cytoolz', 'eth_hash',
],
excludes = [],
include_msvcr = True,
)
executables = [
Executable(
mainscript,
copyright = copyright,
base = "Win32GUI",
icon = icon_win,
),
]
extra_options = dict(
executables = executables,
options = dict(
bdist_msi = bdist_msi_options,
build_exe = build_exe_options,
)
)
'''
if sys.platform == 'darwin':
# For py2{app,exe} App Generation. TODO: Does not work; use PyInstaller instead
extra_options = dict(
setup_requires = [ 'py2app' ],
app = [ mainscript ],
# Cross-platform applications generally expect sys.argv to
# be used for opening files.
# Don't use this with GUI toolkits, the argv
# emulator causes problems and toolkits generally have
# hooks for responding to file-open events.
options = dict(
py2app = dict(
argv_emulation = True,
iconfile = 'images/SLIP39.icns',
includes = 'tkinter',
),
),
)
elif sys.platform == 'win32':
extra_options = dict(
setup_requires = [ 'py2exe' ],
app = [ mainscript ],
)
else:
extra_options = dict(
# Normally unix-like platforms will use "setup.py install"
# and install the main script as such
scripts = [ mainscript ],
)
'''
# Must work if setup.py is run in the source distribution context, or from
# within the packaged distribution directory.
__version__ = None
try:
exec( open( 'slip39/version.py', 'r' ).read() )
except FileNotFoundError:
exec( open( 'version.py', 'r' ).read() )
console_scripts = [
'slip39 = slip39.main:main',
'slip39-recovery = slip39.recovery.main:main',
'slip39-generator = slip39.generator.main:main',
'slip39-gui = slip39.gui.main:main',
'slip39-cli = slip39.cli:cli',
]
entry_points = {
'console_scripts': console_scripts,
}
package_dir = {
"slip39": "./slip39",
"slip39.cli": "./slip39/cli",
"slip39.invoice": "./slip39/invoice",
"slip39.layout": "./slip39/layout",
"slip39.layout.font": "./slip39/layout/font",
"slip39.recovery": "./slip39/recovery",
"slip39.generator": "./slip39/generator",
"slip39.gui": "./slip39/gui",
}
package_data = {
'slip39': [
'layout/*.png',
'layout/*.txt',
'layout/font/*.ttf',
'gui/*.txt',
],
}
long_description_content_type = 'text/markdown'
long_description = """\
Creating Ethereum, Bitcoin and other accounts is complex and fraught
with potential for loss of funds.
A BIP-39 seed recovery phrase helps, but a *single* lapse in security
dooms the account (and all derived accounts, in fact). If someone finds
your recovery phrase (or you lose it), the accounts derived from that
seed are /gone/.
The SLIP-39 standard allows you to split the seed between 1, 2, or more
groups of several mnemonic recovery phrases. This is better, but
creating such accounts is difficult; presently, only the Trezor supports
these, and they can only be created "manually". Writing down 5 or more
sets of 20 words is difficult, error-prone and time consuming.
# Hardware Wallet "Seed" Configuration
> Your keys, your Bitcoin. Not your keys, not your Bitcoin.
>
> ---Andreas Antonopoulos
The [python-slip39] project (and the [SLIP-39 macOS/win32 App]) exists
to assist in the safe creation, backup and documentation of
[Hierarchical Deterministic (HD) Wallet] seeds and derived accounts,
with various SLIP-39 sharing parameters. It generates the new random
wallet seed, and generates the expected standard Ethereum account(s)
(at [derivation path] *m/44'/60'/0'/0/0* by default) and Bitcoin
accounts (at Bech32 derivation path *m/84'/0'/0'/0/0* by default),
with wallet address and QR code (compatible with Trezor and Ledger
derivations). It produces the required SLIP-39 phrases, and outputs a
single PDF containing all the required printable cards to document the
seed (and the specified derived accounts).
On an secure (ideally air-gapped) computer, new seeds can /safely/ be
generated (*without trusting this program*) and the PDF saved to a USB
drive for printing (or directly printed without the file being saved
to disk.). Presently, `slip39' can output example ETH, BTC, LTC,
DOGE, BSC, and XRP addresses derived from the seed, to /illustrate/
what accounts are associated with the backed-up seed. Recovery of the
seed to a [Trezor Safe 3] is simple, by entering the mnemonics right
on the device.
We also support the backup of existing insecure and unreliable 12- or
24-word BIP-39 Mnemonic Phrases as SLIP-39 Mnemonic cards, for
existing BIP-39 hardware wallets like the [Ledger Nano], etc.!
Recover from your existing BIP-39 Seed Phrase Mnemonic, select "Using
BIP-39" (and enter your BIP-39 passphrase), and generate a set of
SLIP-39 Mnemonic cards. Later, use the SLIP-39 App to recover from
your SLIP-39 Mnemonic cards, click "Using BIP-39" to get your BIP-39
Mnemonic back, and use it (and your passphrase) to recover your
accounts to your Ledger (or other) hardware wallet.
Output of BIP-38 or JSON encrypted Paper Wallets is also supported,
for import into standard software cryptocurrency wallets.
<./images/slip39.png>
[python-slip39] <https://github.com/pjkundert/python-slip39.git>
[SLIP-39 macOS/win32 App] <https://slip39.com/app>
[Hierarchical Deterministic (HD) Wallet]
<https://wolovim.medium.com/ethereum-201-hd-wallets-11d0c93c87>
[derivation path]
<https://medium.com/myetherwallet/hd-wallets-and-derivation-paths-explained-865a643c7bf2>
[Trezor Safe 3] <https://trezor.go2cloud.org/SHdf>
[Ledger Nano]
<https://shop.ledger.com/pages/ledger-nano-x?r=2cd1cb6ae51f>
## The SLIP-39 App for Generation and Backup
Download the SLIP-39 App from [slip39-download][5] for Windows (.msi) or macOS (.dmg).
The Graphical User Interface (GUI) also supports Linux:
$ python3 -m pip install slip39[gui]
$ slip39-gui
![SLIP-39 App GUI][slip39-gui]
[5]: <https://github.com/pjkundert/python-slip39/releases/latest> "SLIP-39 App Download"
[slip39-gui]: https://github.com/pjkundert/python-slip39/raw/master/images/slip39.png "SLIP-39 App GUI"
## Generating SLIP-39 on the Command Line
$ python3 -m slip39 -v Personal # or run: slip39 -v Personal
2022-01-26 13:55:30 slip39 First(1/1): Recover w/ 2 of 4 groups First(1), Second(1), Fam(2/4), Frens(2/6)
2022-01-26 13:55:30 slip39 1st 1 sister 8 cricket 15 unhappy
2022-01-26 13:55:30 slip39 2 acid 9 mental 16 ocean
2022-01-26 13:55:30 slip39 3 acrobat 10 veteran 17 mayor
2022-01-26 13:55:30 slip39 4 romp 11 phantom 18 promise
2022-01-26 13:55:30 slip39 5 anxiety 12 grownup 19 wrote
2022-01-26 13:55:30 slip39 6 laser 13 skunk 20 romp
2022-01-26 13:55:30 slip39 7 cricket 14 anatomy
2022-01-26 13:55:30 slip39 Second(1/1): Recover w/ 2 of 4 groups First(1), Second(1), Fam(2/4), Frens(2/6)
2022-01-26 13:55:30 slip39 1st 1 sister 8 belong 15 spirit
2022-01-26 13:55:30 slip39 2 acid 9 survive 16 royal
2022-01-26 13:55:30 slip39 3 beard 10 home 17 often
2022-01-26 13:55:30 slip39 4 romp 11 herd 18 silver
2022-01-26 13:55:30 slip39 5 again 12 mountain 19 grocery
2022-01-26 13:55:30 slip39 6 orbit 13 august 20 antenna
2022-01-26 13:55:30 slip39 7 very 14 evening
2022-01-26 13:55:30 slip39 Fam(2/4): Recover w/ 2 of 4 groups First(1), Second(1), Fam(2/4), Frens(2/6)
2022-01-26 13:55:30 slip39 1st 1 sister 8 rainbow 15 husky
2022-01-26 13:55:30 slip39 2 acid 9 swing 16 crowd
2022-01-26 13:55:30 slip39 3 ceramic 10 credit 17 learn
2022-01-26 13:55:30 slip39 4 roster 11 piece 18 priority
2022-01-26 13:55:30 slip39 5 already 12 puny 19 hand
2022-01-26 13:55:30 slip39 6 quiet 13 senior 20 watch
2022-01-26 13:55:30 slip39 7 erode 14 listen
2022-01-26 13:55:30 slip39 2nd 1 sister 8 holy 15 revenue
2022-01-26 13:55:30 slip39 2 acid 9 execute 16 junction
2022-01-26 13:55:30 slip39 3 ceramic 10 lift 17 elite
2022-01-26 13:55:30 slip39 4 scared 11 spark 18 flexible
2022-01-26 13:55:30 slip39 5 domestic 12 yoga 19 inform
2022-01-26 13:55:30 slip39 6 exact 13 medical 20 predator
2022-01-26 13:55:30 slip39 7 finger 14 grief
...
2022-01-26 13:55:30 slip39 ETH m/44'/60'/0'/0/0 : 0x8FBCe53111817DcE01F9f4C4A6319eA1Ca0c3bf1
2022-01-26 13:55:30 slip39 BTC m/84'/0'/0'/0/0 : bc1q6u7qk0tepkxdm8wkhpqzwwy0w8zfls9yvghaxq
...
2022-01-26 13:55:30 slip39 Wrote SLIP39-encoded wallet for 'Personal' to: Personal-2022-01-26+13.55.30-ETH-0x8FBCe53111817DcE01F9f4C4A6319eA1Ca0c3bf1.pdf
## Recover from SLIP-39 Mnemonics
Later, if you need to recover the Ethereum wallet, keep entering SLIP-39 mnemonics until the secret
is recovered (invalid/duplicate mnemonics will be ignored):
$ python3 -m slip39.recovery -v # or run: slip39-recovery -v
Enter 1st SLIP-39 mnemonic: sister acid acrobat romp anxiety laser cricket cricket mental veteran phantom grownup skunk anatomy unhappy ocean mayor promise wrote romp
2021-12-29 13:24:25 slip39.recovery Could not recover SLIP-39 master secret with 1 supplied mnemonics: Insufficient number of mnemonic groups. The required number of groups is 2.
Enter 2nd SLIP-39 mnemonic: a bc
2021-12-29 13:24:53 slip39.recovery Could not recover SLIP-39 master secret with 2 supplied mnemonics: Invalid mnemonic word 'a'.
Enter 3rd SLIP-39 mnemonic: sister acid ceramic roster already quiet erode rainbow swing credit piece puny senior listen husky crowd learn priority hand watch
2021-12-29 13:24:58 slip39.recovery Could not recover SLIP-39 master secret with 3 supplied mnemonics: Invalid mnemonic word 'a'.
Enter 4th SLIP-39 mnemonic: sister acid ceramic scared domestic exact finger holy execute lift spark yoga medical grief revenue junction elite flexible inform predator
2021-12-29 13:25:14 slip39.recovery Recovered SLIP-39 secret with 3 (1st, 3rd, 4th) of 4 supplied mnemonics
2021-12-29 13:25:14 slip39.recovery Recovered SLIP-39 secret; To re-generate, send it to: python3 -m slip39 --secret -
32448aabb50cb6b022fdf17d960720df
Finally, regenerate the Ethereum wallet, perhaps including an encrypted JSON wallet file for import
into a software wallet; note that the same Ethereum wallet address 0x8FBC...3bf1 is recovered:
$ python3 -m slip39 --secret 32448aabb50cb6b022fdf17d960720df --json -
2022-01-26 14:06:14 slip39 It is recommended to not use '-s|--secret <hex>'; specify '-' to read from input
2022-01-26 14:06:14 slip39 ETH m/44'/60'/0'/0/0 : 0x8FBCe53111817DcE01F9f4C4A6319eA1Ca0c3bf1
2022-01-26 14:06:14 slip39 BTC m/84'/0'/0'/0/0 : bc1q6u7qk0tepkxdm8wkhpqzwwy0w8zfls9yvghaxq
JSON key file password:
2022-01-26 14:06:21 slip39 Wrote JSON SLIP39's encrypted ETH wallet 0x8FBCe53111817DcE01F9f4C4A6319eA1Ca0c3bf1 \
derived at m/44'/60'/0'/0/0 to: SLIP39-2022-01-26+14.06.14-ETH-0x8FBCe53111817DcE01F9f4C4A6319eA1Ca0c3bf1.json
2022-01-26 14:06:21 slip39 Wrote SLIP39-encoded wallet for '' to: SLIP39-2022-01-26+14.06.14-ETH-0x8FBCe53111817DcE01F9f4C4A6319eA1Ca0c3bf1.pdf
The whole toolchain is suitable for pipelining:
$ python3 -m slip39 --text --no-card -q \\
| sort -r \\
| python3 -m slip39.recovery \\
| python3 -m slip39 --secret - --no-card -q
2021-12-28 10:55:17 slip39 ETH m/44'/60'/0'/0/0 : 0x68dD9B59D5dF605f4e9612E8b427Ab31187E2C54
2021-12-28 10:55:18 slip39.recovery Recovered SLIP-39 secret with 4 (1st, 2nd, 7th, 8th) of 8 supplied mnemonics
2021-12-28 10:55:18 slip39 ETH m/44'/60'/0'/0/0 : 0x68dD9B59D5dF605f4e9612E8b427Ab31187E2C54
## SLIP-39 Mnemonic Cards PDF
Here's an example of PDF containing the SLIP-39 recovery mnemonic cards produced:
![SLIP-39 Mnemonic Cards PDF][slip39-cards]
If desired, you can output encrypted "Paper Wallets", compatible for import into standard software
cryptocurrency wallets (BIP-38 for Bitcoin, etc., and standard JSON wallets for Ethereum):
![Encrypted Paper Wallets PDF][slip39-wallets]
[slip39-cards]: https://github.com/pjkundert/python-slip39/raw/master/images/slip39-cards.png "SLIP-39 Mnemonic Cards PDF"
[slip39-wallets]: https://github.com/pjkundert/python-slip39/raw/master/images/slip39-wallets.png "Encrypted Paper Wallets PDF"
"""
classifiers = [
"License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
"License :: Other/Proprietary License",
"Programming Language :: Python :: 3",
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"Intended Audience :: Financial and Insurance Industry",
"Environment :: Console",
"Topic :: Security :: Cryptography",
"Topic :: Office/Business :: Financial",
]
project_urls = {
"Bug Tracker": "https://github.com/pjkundert/python-slip39/issues",
}
setup(
name = "slip39",
version = __version__,
install_requires = install_requires,
tests_require = tests_require,
extras_require = extras_require,
packages = package_dir.keys(),
package_dir = package_dir,
package_data = package_data,
include_package_data = True,
zip_safe = True,
entry_points = entry_points,
author = "Perry Kundert",
author_email = "[email protected]",
project_urls = project_urls,
description = "Standards-compliant SLIP-39 cryptocurrency seed generation and recovery, compatible with Trezor hardware wallets",
long_description = long_description,
long_description_content_type = long_description_content_type,
license = "Dual License; GPLv3 and Proprietary",
keywords = "Ethereum Bitcoin Dogecoin Litecoin cryptocurrency SLIP-39 BIP-39 seed recovery PDF BIP-38 paper wallet",
url = "https://github.com/pjkundert/python-slip39",
classifiers = classifiers,
python_requires = ">=3.9",
**extra_options
)