Skip to content

Commit 4b3a272

Browse files
kouloumoskouloumos
committed
simplify notebook setup with configuration file
allow for a single point of configuration by: - moving all notebooks to the root dir while switching to a "<chapter_number>.<sub-chapter_number> " prefix to keep the structure. - adding a configuration file `config.ini` in which the user can define their Bitcoin Core directory - adding `setup.py` as a single import that takes care of all the configurations required for the initial setup of the notebook.
1 parent 01b47c8 commit 4b3a272

21 files changed

+491
-2316
lines changed

‎appendix/elliptic-curve-math-review.ipynb ‎0.1-elliptic-curve-math-review.ipynb

+28-80
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,12 @@
11
{
22
"cells": [
3-
{
4-
"cell_type": "markdown",
5-
"id": "3ca0e780",
6-
"metadata": {},
7-
"source": [
8-
"## Setup \n",
9-
"\n",
10-
"### Requirements\n",
11-
"For this exercise we'll need Bitcoin Core. This notebook has been tested with [v24.0.1](https://github.com/bitcoin/bitcoin/releases/tag/v24.0.1).\n",
12-
"\n",
13-
"Below, set the paths for:\n",
14-
"1. The bitcoin core functional test framework directory.\n",
15-
"2. The directory containing bitcoin-tx-tutorial.\n",
16-
"\n",
17-
"**You'll need to edit these next two lines for your local setup.**"
18-
]
19-
},
203
{
214
"cell_type": "code",
22-
"execution_count": 1,
5+
"execution_count": null,
236
"id": "752d005e",
247
"metadata": {},
258
"outputs": [],
269
"source": [
27-
"path_to_bitcoin_functional_test = \"/Users/dariuscognac/bitcoin/test/functional\"\n",
28-
"path_to_bitcoin_tx_tutorial = \"/Users/dariuscognac/Documents/Github/bitcoin-tx-tutorial\"\n",
29-
"\n",
30-
"import sys\n",
31-
"\n",
32-
"# Add the functional test framework to our PATH\n",
33-
"sys.path.insert(0, path_to_bitcoin_functional_test)\n",
34-
"from test_framework.test_shell import TestShell\n",
35-
"\n",
36-
"# Add the bitcoin-tx-tutorial functions to our PATH\n",
37-
"sys.path.insert(0, path_to_bitcoin_tx_tutorial)\n",
3810
"from functions import *\n",
3911
"from functions.bip_0340_reference import *"
4012
]
@@ -101,7 +73,7 @@
10173
},
10274
{
10375
"cell_type": "code",
104-
"execution_count": 2,
76+
"execution_count": null,
10577
"id": "2f212482",
10678
"metadata": {},
10779
"outputs": [],
@@ -120,18 +92,10 @@
12092
},
12193
{
12294
"cell_type": "code",
123-
"execution_count": 3,
95+
"execution_count": null,
12496
"id": "54b533fc",
12597
"metadata": {},
126-
"outputs": [
127-
{
128-
"name": "stdout",
129-
"output_type": "stream",
130-
"text": [
131-
"pubkey: (55066263022277343669578718895168534326250603453777594175500187360389116729240, 32670510020758816978083085130507043184471273380659243275938904335757337482424)\n"
132-
]
133-
}
134-
],
98+
"outputs": [],
13599
"source": [
136100
"privkey_int = int_from_bytes(privkey)\n",
137101
"pubkey = point_mul(G, privkey_int)\n",
@@ -180,19 +144,10 @@
180144
},
181145
{
182146
"cell_type": "code",
183-
"execution_count": 4,
147+
"execution_count": null,
184148
"id": "468b6795",
185149
"metadata": {},
186-
"outputs": [
187-
{
188-
"name": "stdout",
189-
"output_type": "stream",
190-
"text": [
191-
"Uncompressed pubkey: 0479be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798483ada7726a3c4655da4fbfc0e1108a8fd17b448a68554199c47d08ffb10d4b8\n",
192-
"Compressed pubkey: 0279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798\n"
193-
]
194-
}
195-
],
150+
"outputs": [],
196151
"source": [
197152
"# using the same privkey value from above\n",
198153
"pubkey = point_mul(G, privkey_int)\n",
@@ -226,23 +181,10 @@
226181
},
227182
{
228183
"cell_type": "code",
229-
"execution_count": 5,
184+
"execution_count": null,
230185
"id": "a56fe6dc",
231186
"metadata": {},
232-
"outputs": [
233-
{
234-
"name": "stdout",
235-
"output_type": "stream",
236-
"text": [
237-
"original_pubkey: (115780575977492633039504758427830329241728645270042306223540962614150928364886, 78735063515800386211891312544505775871260717697865196436804966483607426560663)\n",
238-
"y coordinate is odd\n",
239-
"\n",
240-
"Negating the private key..\n",
241-
"new_pubkey: (115780575977492633039504758427830329241728645270042306223540962614150928364886, 37057025721515809211679672464182131982009266967775367602652617524301408111000)\n",
242-
"y coordinate is even\n"
243-
]
244-
}
245-
],
187+
"outputs": [],
246188
"source": [
247189
"# This private key has been chosen as it'll produce a public key with an odd y-coordinate\n",
248190
"original_privkey = bytes.fromhex(\"0000000000000000000000000000000000000000000000000000000000000006\")\n",
@@ -289,20 +231,10 @@
289231
},
290232
{
291233
"cell_type": "code",
292-
"execution_count": 6,
234+
"execution_count": null,
293235
"id": "c7cd1861",
294236
"metadata": {},
295-
"outputs": [
296-
{
297-
"name": "stdout",
298-
"output_type": "stream",
299-
"text": [
300-
"Pubkey generated from summing private keys: (112711660439710606056748659173929673102114977341539408544630613555209775888121, 25583027980570883691656905877401976406448868254816295069919888960541586679410)\n",
301-
"Pubkey generated from summing public keys: (112711660439710606056748659173929673102114977341539408544630613555209775888121, 25583027980570883691656905877401976406448868254816295069919888960541586679410)\n",
302-
"Success!\n"
303-
]
304-
}
305-
],
237+
"outputs": [],
306238
"source": [
307239
"# Define private keys and convert to int\n",
308240
"privkey_a = bytes.fromhex(\"0000000000000000000000000000000000000000000000000000000000000001\")\n",
@@ -323,11 +255,27 @@
323255
"assert(pubkey_ab == pubkey2)\n",
324256
"print(\"Success!\")"
325257
]
258+
},
259+
{
260+
"cell_type": "code",
261+
"execution_count": null,
262+
"id": "10adecc4",
263+
"metadata": {},
264+
"outputs": [],
265+
"source": []
266+
},
267+
{
268+
"cell_type": "code",
269+
"execution_count": null,
270+
"id": "fa1bf7c9",
271+
"metadata": {},
272+
"outputs": [],
273+
"source": []
326274
}
327275
],
328276
"metadata": {
329277
"kernelspec": {
330-
"display_name": "Python 3",
278+
"display_name": "Python 3 (ipykernel)",
331279
"language": "python",
332280
"name": "python3"
333281
},
@@ -341,7 +289,7 @@
341289
"name": "python",
342290
"nbconvert_exporter": "python",
343291
"pygments_lexer": "ipython3",
344-
"version": "3.7.0"
292+
"version": "3.8.16"
345293
}
346294
},
347295
"nbformat": 4,

‎appendix/hash-functions.ipynb ‎0.2-hash-functions.ipynb

+16-70
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,10 @@
2121
},
2222
{
2323
"cell_type": "code",
24-
"execution_count": 1,
24+
"execution_count": null,
2525
"id": "1da041f0",
2626
"metadata": {},
27-
"outputs": [
28-
{
29-
"name": "stdout",
30-
"output_type": "stream",
31-
"text": [
32-
"5f78c33274e43fa9de5659265c1d917e25c03722dcb0b8d27db8d5feaa813953\n"
33-
]
34-
}
35-
],
27+
"outputs": [],
3628
"source": [
3729
"import hashlib\n",
3830
"\n",
@@ -52,18 +44,10 @@
5244
},
5345
{
5446
"cell_type": "code",
55-
"execution_count": 2,
47+
"execution_count": null,
5648
"id": "51287990",
5749
"metadata": {},
58-
"outputs": [
59-
{
60-
"name": "stdout",
61-
"output_type": "stream",
62-
"text": [
63-
"226821c2f5423e11fe9af68bd285c249db2e4b5a\n"
64-
]
65-
}
66-
],
50+
"outputs": [],
6751
"source": [
6852
"output = hashlib.new('ripemd160', data).digest()\n",
6953
"print(output.hex())"
@@ -82,7 +66,7 @@
8266
},
8367
{
8468
"cell_type": "code",
85-
"execution_count": 3,
69+
"execution_count": null,
8670
"id": "f30433e5",
8771
"metadata": {},
8872
"outputs": [],
@@ -106,18 +90,10 @@
10690
},
10791
{
10892
"cell_type": "code",
109-
"execution_count": 4,
93+
"execution_count": null,
11094
"id": "f4e6ca67",
11195
"metadata": {},
112-
"outputs": [
113-
{
114-
"name": "stdout",
115-
"output_type": "stream",
116-
"text": [
117-
"00000000000000001e8d6829a8a21adc5d38d0a473b144b6765798e61f98bd1d\n"
118-
]
119-
}
120-
],
96+
"outputs": [],
12197
"source": [
12298
"# The block header from block 125552\n",
12399
"header_hex = (\n",
@@ -152,7 +128,7 @@
152128
},
153129
{
154130
"cell_type": "code",
155-
"execution_count": 5,
131+
"execution_count": null,
156132
"id": "0288b375",
157133
"metadata": {},
158134
"outputs": [],
@@ -175,18 +151,10 @@
175151
},
176152
{
177153
"cell_type": "code",
178-
"execution_count": 6,
154+
"execution_count": null,
179155
"id": "41c06d0b",
180156
"metadata": {},
181-
"outputs": [
182-
{
183-
"name": "stdout",
184-
"output_type": "stream",
185-
"text": [
186-
"ca61e52e881d41374e640f819cd118cc153b21a7\n"
187-
]
188-
}
189-
],
157+
"outputs": [],
190158
"source": [
191159
"pubkey = bytes.fromhex(\"11\")\n",
192160
"pkh = hash160(pubkey)\n",
@@ -229,21 +197,10 @@
229197
},
230198
{
231199
"cell_type": "code",
232-
"execution_count": 7,
200+
"execution_count": null,
233201
"id": "a87080b9",
234202
"metadata": {},
235-
"outputs": [
236-
{
237-
"data": {
238-
"text/plain": [
239-
"'596711e622bf8dc1d6b892863d56504003f39bb0ee482d6d1715e590e58b35bc'"
240-
]
241-
},
242-
"execution_count": 7,
243-
"metadata": {},
244-
"output_type": "execute_result"
245-
}
246-
],
203+
"outputs": [],
247204
"source": [
248205
"tx_hex = \"0100000001399434f3943d776250cf4b4c2b3fa2cac259dd5551a822e1976d25a2d9e0231d010000006b483045022100a628f785b81d04e3b5d2f4a554c839acab64215935a0558dda1e33d0120dada30220616acf4b1c796cebe11f30dd53bbb4354899d924a4791c8fd7c0ae3da0c4782c0121034f355bdcb7cc0af728ef3cceb9615d90684bb5b2ca5f859ab0f0b704075871aaffffffff0280d1f008000000001976a9143bc28d6d92d9073fb5e3adf481795eaf446bceed88ac80f0fa02000000001976a914531260aa2a199e228c537dfa42c82bea2c7c1f4d88ac00000000\"\n",
249206
"tx = bytes.fromhex(tx_hex)\n",
@@ -261,21 +218,10 @@
261218
},
262219
{
263220
"cell_type": "code",
264-
"execution_count": 8,
221+
"execution_count": null,
265222
"id": "28392546",
266223
"metadata": {},
267-
"outputs": [
268-
{
269-
"data": {
270-
"text/plain": [
271-
"'fc7250a211deddc70ee5a2738de5f07817351cef'"
272-
]
273-
},
274-
"execution_count": 8,
275-
"metadata": {},
276-
"output_type": "execute_result"
277-
}
278-
],
224+
"outputs": [],
279225
"source": [
280226
"pk = bytes.fromhex(\"034f355bdcb7cc0af728ef3cceb9615d90684bb5b2ca5f859ab0f0b704075871aa\")\n",
281227
"hash160(pk).hex()"
@@ -292,7 +238,7 @@
292238
],
293239
"metadata": {
294240
"kernelspec": {
295-
"display_name": "Python 3",
241+
"display_name": "Python 3 (ipykernel)",
296242
"language": "python",
297243
"name": "python3"
298244
},
@@ -306,7 +252,7 @@
306252
"name": "python",
307253
"nbconvert_exporter": "python",
308254
"pygments_lexer": "ipython3",
309-
"version": "3.7.0"
255+
"version": "3.8.16"
310256
}
311257
},
312258
"nbformat": 4,

‎appendix/bitcoin-script.ipynb ‎0.3-bitcoin-script.ipynb

+4-4
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
},
4141
{
4242
"cell_type": "code",
43-
"execution_count": 1,
43+
"execution_count": null,
4444
"id": "881e4514",
4545
"metadata": {},
4646
"outputs": [],
@@ -76,7 +76,7 @@
7676
},
7777
{
7878
"cell_type": "code",
79-
"execution_count": 2,
79+
"execution_count": null,
8080
"id": "d8c9fd61",
8181
"metadata": {},
8282
"outputs": [],
@@ -204,7 +204,7 @@
204204
],
205205
"metadata": {
206206
"kernelspec": {
207-
"display_name": "Python 3",
207+
"display_name": "Python 3 (ipykernel)",
208208
"language": "python",
209209
"name": "python3"
210210
},
@@ -218,7 +218,7 @@
218218
"name": "python",
219219
"nbconvert_exporter": "python",
220220
"pygments_lexer": "ipython3",
221-
"version": "3.7.0"
221+
"version": "3.8.16"
222222
}
223223
},
224224
"nbformat": 4,

0 commit comments

Comments
 (0)