Skip to content

Commit 95fc062

Browse files
authored
Merge pull request #117 from JAGADISHSUNILPEDNEKAR/improve-taproot-docs
Improved the Taproot documentation with better description and organisation
2 parents 820a566 + e6e73f6 commit 95fc062

1 file changed

Lines changed: 22 additions & 11 deletions

File tree

README.rst

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -89,34 +89,45 @@ Spend from a timelocked address
8989
https://github.com/karask/python-bitcoin-utils/blob/master/examples/spend_p2sh_csv_p2pkh.py - spends from a P2SH(CSV+P2PKH) address as created from above.
9090

9191
Taproot (segwit v1) Transactions
92-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
92+
--------------------------------
9393

94-
Spend from a taproot address
95-
https://github.com/karask/python-bitcoin-utils/blob/master/examples/spend_p2tr_default_path.py - single input, single output default key path spending.
94+
Taproot combines Schnorr signatures, Merkle trees, and a new scripting language to improve Bitcoin's privacy, efficiency, and smart contract capabilities. The library fully supports Taproot addresses, key path spending, and script path spending with multiple script options.
95+
96+
Taproot Keys and Addresses
97+
https://github.com/karask/python-bitcoin-utils/blob/master/examples/keys_taproot_addresses.py - creates a public key, derives its corresponding tweaked taproot public key (x-only) and taproot address.
98+
99+
Spend from a taproot address (key path)
100+
https://github.com/karask/python-bitcoin-utils/blob/master/examples/spend_p2tr_default_path.py - spends a taproot UTXO using the key path, which is the most efficient and private approach.
96101

97102
Spend a multi input that contains both taproot and legacy UTXOs
98-
https://github.com/karask/python-bitcoin-utils/blob/master/examples/spend_multi_input_p2tr_and_p2pkh.py - three inputs (two taproot and one legacy), single legacy output.
103+
https://github.com/karask/python-bitcoin-utils/blob/master/examples/spend_multi_input_p2tr_and_p2pkh.py - three inputs (two taproot and one legacy), single legacy output.
104+
105+
Taproot with Single Script Path
106+
-------------------------------
99107

100108
Send to taproot address that contains a single script path spend
101-
https://github.com/karask/python-bitcoin-utils/blob/master/examples/send_to_p2tr_with_single_script.py - single input, single output (key path and single script path).
109+
https://github.com/karask/python-bitcoin-utils/blob/master/examples/send_to_p2tr_with_single_script.py - single input, single output (key path and single script path).
102110

103111
Spend taproot from key path (has single alternative script path spend)
104-
https://github.com/karask/python-bitcoin-utils/blob/master/examples/spend_p2tr_single_script_by_key_path.py - single input, single output, spend key path.
112+
https://github.com/karask/python-bitcoin-utils/blob/master/examples/spend_p2tr_single_script_by_key_path.py - single input, single output, spend key path.
105113

106114
Spend taproot from script path (has single alternative script path spend)
107-
https://github.com/karask/python-bitcoin-utils/blob/master/examples/spend_p2tr_single_script_by_script_path.py - single input, single output, spend script path.
115+
https://github.com/karask/python-bitcoin-utils/blob/master/examples/spend_p2tr_single_script_by_script_path.py - single input, single output, spend script path.
116+
117+
Taproot with Multiple Script Paths
118+
---------------------------------
108119

109120
Send to taproot address that contains two scripts path spends
110-
https://github.com/karask/python-bitcoin-utils/blob/master/examples/send_to_p2tr_with_two_scripts.py - single input, single output (key path and two script paths - A and B).
121+
https://github.com/karask/python-bitcoin-utils/blob/master/examples/send_to_p2tr_with_two_scripts.py - single input, single output (key path and two script paths - A and B).
111122

112123
Spend taproot from script path (has two alternative script path spend - A and B)
113-
https://github.com/karask/python-bitcoin-utils/blob/master/examples/spend_p2tr_two_scripts_by_script_path.py - single input, single output, spend script path A.
124+
https://github.com/karask/python-bitcoin-utils/blob/master/examples/spend_p2tr_two_scripts_by_script_path.py - single input, single output, spend script path A.
114125

115126
Send to taproot address that contains three scripts path spends
116-
https://github.com/karask/python-bitcoin-utils/blob/master/examples/send_to_p2tr_with_three_scripts.py - single input, single output (key path and three script paths - A, B and C).
127+
https://github.com/karask/python-bitcoin-utils/blob/master/examples/send_to_p2tr_with_three_scripts.py - single input, single output (key path and three script paths - A, B and C).
117128

118129
Spend taproot from script path (has three alternative script path spends - A, B and C)
119-
https://github.com/karask/python-bitcoin-utils/blob/master/examples/spend_p2tr_three_scripts_by_script_path.py - single input, single output, spend script path B.
130+
https://github.com/karask/python-bitcoin-utils/blob/master/examples/spend_p2tr_three_scripts_by_script_path.py - single input, single output, spend script path B.
120131

121132
Other
122133
^^^^^

0 commit comments

Comments
 (0)