@btc-vision/bitcoin 6.4.9 → 6.4.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (230) hide show
  1. package/.babelrc +4 -4
  2. package/.mocharc.json +13 -13
  3. package/.prettierrc.json +12 -12
  4. package/CHANGELOG.md +403 -403
  5. package/CONTRIBUTING.md +83 -83
  6. package/LICENSE +21 -21
  7. package/README.md +201 -201
  8. package/browser/index.d.ts +1 -1
  9. package/browser/index.js +1 -1
  10. package/browser/{ops.d.ts → opcodes.d.ts} +2 -3
  11. package/browser/script.d.ts +2 -2
  12. package/build/address.js +2 -1
  13. package/build/index.d.ts +1 -1
  14. package/build/index.js +1 -1
  15. package/build/{ops.d.ts → opcodes.d.ts} +2 -3
  16. package/build/{ops.js → opcodes.js} +4 -5
  17. package/build/payments/embed.js +1 -1
  18. package/build/payments/p2ms.js +1 -1
  19. package/build/payments/p2op.js +1 -1
  20. package/build/payments/p2pk.js +1 -1
  21. package/build/payments/p2pkh.js +1 -1
  22. package/build/payments/p2sh.js +3 -3
  23. package/build/payments/p2tr.js +1 -1
  24. package/build/payments/p2wpkh.js +2 -2
  25. package/build/payments/p2wsh.js +2 -2
  26. package/build/push_data.js +9 -9
  27. package/build/script.d.ts +2 -2
  28. package/build/script.js +12 -12
  29. package/build/transaction.js +1 -1
  30. package/cjs/package.json +3 -3
  31. package/gulpfile.js +42 -42
  32. package/package.json +150 -150
  33. package/src/address.ts +304 -303
  34. package/src/bip66.ts +107 -107
  35. package/src/block.ts +233 -233
  36. package/src/bufferutils.ts +188 -188
  37. package/src/crypto.ts +108 -108
  38. package/src/ecc_lib.ts +94 -94
  39. package/src/hooks/AdvancedSignatureManager.ts +104 -104
  40. package/src/hooks/SignatureManager.ts +84 -84
  41. package/src/index.ts +105 -105
  42. package/src/merkle.ts +31 -31
  43. package/src/{ops.ts → opcodes.ts} +280 -282
  44. package/src/payments/bip341.ts +140 -140
  45. package/src/payments/embed.ts +61 -61
  46. package/src/payments/index.ts +172 -172
  47. package/src/payments/lazy.ts +28 -28
  48. package/src/payments/p2ms.ts +156 -156
  49. package/src/payments/p2op.ts +195 -195
  50. package/src/payments/p2pk.ts +93 -93
  51. package/src/payments/p2pkh.ts +214 -214
  52. package/src/payments/p2sh.ts +210 -210
  53. package/src/payments/p2tr.ts +309 -309
  54. package/src/payments/p2wpkh.ts +144 -144
  55. package/src/payments/p2wsh.ts +217 -217
  56. package/src/psbt/bip371.ts +441 -441
  57. package/src/push_data.ts +97 -97
  58. package/src/script.ts +247 -247
  59. package/src/script_number.ts +72 -72
  60. package/src/script_signature.ts +91 -91
  61. package/src/transaction.ts +656 -656
  62. package/test/address.spec.ts +155 -155
  63. package/test/bitcoin.core.spec.ts +212 -212
  64. package/test/block.spec.ts +171 -171
  65. package/test/bufferutils.spec.ts +450 -450
  66. package/test/crypto.spec.ts +49 -49
  67. package/test/fixtures/address.json +329 -329
  68. package/test/fixtures/block.json +148 -148
  69. package/test/fixtures/bufferutils.json +102 -102
  70. package/test/fixtures/core/README.md +26 -26
  71. package/test/fixtures/core/base58_encode_decode.json +50 -50
  72. package/test/fixtures/core/base58_keys_invalid.json +152 -152
  73. package/test/fixtures/core/base58_keys_valid.json +452 -452
  74. package/test/fixtures/core/blocks.json +27 -27
  75. package/test/fixtures/core/sig_canonical.json +7 -7
  76. package/test/fixtures/core/sig_noncanonical.json +33 -33
  77. package/test/fixtures/core/sighash.json +3505 -3505
  78. package/test/fixtures/core/tx_valid.json +2023 -2023
  79. package/test/fixtures/crypto.json +43 -43
  80. package/test/fixtures/ecdsa.json +217 -217
  81. package/test/fixtures/ecpair.json +141 -141
  82. package/test/fixtures/embed.json +108 -108
  83. package/test/fixtures/p2ms.json +434 -434
  84. package/test/fixtures/p2pk.json +179 -179
  85. package/test/fixtures/p2pkh.json +276 -276
  86. package/test/fixtures/p2sh.json +508 -508
  87. package/test/fixtures/p2tr.json +1198 -1198
  88. package/test/fixtures/p2wpkh.json +290 -290
  89. package/test/fixtures/p2wsh.json +489 -489
  90. package/test/fixtures/psbt.json +924 -924
  91. package/test/fixtures/script.json +465 -465
  92. package/test/fixtures/script_number.json +225 -225
  93. package/test/fixtures/signature.json +140 -140
  94. package/test/fixtures/transaction.json +916 -916
  95. package/test/integration/_regtest.ts +6 -6
  96. package/test/integration/addresses.spec.ts +142 -142
  97. package/test/integration/bip32.spec.ts +130 -130
  98. package/test/integration/blocks.spec.ts +28 -28
  99. package/test/integration/cltv.spec.ts +241 -241
  100. package/test/integration/csv.spec.ts +452 -452
  101. package/test/integration/payments.spec.ts +110 -110
  102. package/test/integration/taproot.spec.ts +663 -663
  103. package/test/integration/transactions.spec.ts +668 -668
  104. package/test/payments.spec.ts +114 -114
  105. package/test/payments.utils.ts +165 -165
  106. package/test/psbt.spec.ts +1285 -1285
  107. package/test/script.spec.ts +186 -186
  108. package/test/script_number.spec.ts +26 -26
  109. package/test/script_signature.spec.ts +66 -66
  110. package/test/transaction.spec.ts +337 -337
  111. package/test/ts-node-register.js +7 -7
  112. package/test/tsconfig.json +48 -48
  113. package/test/types.spec.ts +53 -53
  114. package/tsconfig.base.json +27 -27
  115. package/tsconfig.json +19 -19
  116. package/tsconfig.webpack.json +18 -18
  117. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/.ready +0 -0
  118. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/.release-please-manifest.json +0 -3
  119. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/CHANGELOG.md +0 -962
  120. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/CONTRIBUTING.md +0 -34
  121. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/LICENSE +0 -24
  122. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/README.md +0 -273
  123. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/SECURITY.md +0 -2
  124. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/addon.gypi +0 -204
  125. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/bin/node-gyp.js +0 -138
  126. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/.release-please-manifest.json +0 -3
  127. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/LICENSE +0 -28
  128. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/data/ninja/build.ninja +0 -4
  129. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/data/win/large-pdb-shim.cc +0 -12
  130. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/docs/GypVsCMake.md +0 -116
  131. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/docs/Hacking.md +0 -46
  132. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/docs/InputFormatReference.md +0 -1080
  133. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/docs/LanguageSpecification.md +0 -430
  134. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/docs/README.md +0 -27
  135. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/docs/Testing.md +0 -450
  136. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/docs/UserDocumentation.md +0 -965
  137. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/gyp +0 -8
  138. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/gyp.bat +0 -5
  139. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/gyp_main.py +0 -45
  140. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/MSVSNew.py +0 -365
  141. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/MSVSProject.py +0 -206
  142. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/MSVSSettings.py +0 -1272
  143. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/MSVSSettings_test.py +0 -1547
  144. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/MSVSToolFile.py +0 -59
  145. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/MSVSUserFile.py +0 -153
  146. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/MSVSUtil.py +0 -271
  147. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/MSVSVersion.py +0 -574
  148. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/__init__.py +0 -692
  149. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/common.py +0 -711
  150. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/common_test.py +0 -171
  151. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/easy_xml.py +0 -169
  152. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/easy_xml_test.py +0 -113
  153. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/flock_tool.py +0 -55
  154. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/__init__.py +0 -0
  155. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/analyzer.py +0 -804
  156. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/android.py +0 -1173
  157. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/cmake.py +0 -1318
  158. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/compile_commands_json.py +0 -127
  159. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/dump_dependency_json.py +0 -103
  160. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/eclipse.py +0 -461
  161. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/gypd.py +0 -89
  162. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/gypsh.py +0 -57
  163. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/make.py +0 -2745
  164. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/msvs.py +0 -3976
  165. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/msvs_test.py +0 -44
  166. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/ninja.py +0 -2964
  167. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/ninja_test.py +0 -67
  168. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/xcode.py +0 -1391
  169. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/generator/xcode_test.py +0 -25
  170. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/input.py +0 -3115
  171. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/input_test.py +0 -98
  172. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/mac_tool.py +0 -771
  173. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/msvs_emulation.py +0 -1260
  174. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/ninja_syntax.py +0 -174
  175. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/simple_copy.py +0 -61
  176. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/win_tool.py +0 -373
  177. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/xcode_emulation.py +0 -1938
  178. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/xcode_emulation_test.py +0 -53
  179. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/xcode_ninja.py +0 -302
  180. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/xcodeproj_file.py +0 -3198
  181. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/gyp/xml_fix.py +0 -65
  182. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/LICENSE +0 -3
  183. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/LICENSE.APACHE +0 -177
  184. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/LICENSE.BSD +0 -23
  185. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/__init__.py +0 -15
  186. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/_elffile.py +0 -108
  187. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/_manylinux.py +0 -252
  188. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/_musllinux.py +0 -83
  189. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/_parser.py +0 -359
  190. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/_structures.py +0 -61
  191. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/_tokenizer.py +0 -192
  192. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/markers.py +0 -252
  193. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/metadata.py +0 -825
  194. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/py.typed +0 -0
  195. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/requirements.py +0 -90
  196. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/specifiers.py +0 -1030
  197. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/tags.py +0 -553
  198. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/utils.py +0 -172
  199. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pylib/packaging/version.py +0 -563
  200. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/pyproject.toml +0 -120
  201. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/release-please-config.json +0 -11
  202. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/gyp/test_gyp.py +0 -261
  203. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/Find-VisualStudio.cs +0 -250
  204. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/build.js +0 -227
  205. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/clean.js +0 -15
  206. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/configure.js +0 -328
  207. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/create-config-gypi.js +0 -150
  208. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/download.js +0 -39
  209. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/find-node-directory.js +0 -63
  210. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/find-python.js +0 -310
  211. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/find-visualstudio.js +0 -590
  212. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/install.js +0 -415
  213. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/list.js +0 -26
  214. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/log.js +0 -168
  215. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/node-gyp.js +0 -188
  216. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/process-release.js +0 -146
  217. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/rebuild.js +0 -12
  218. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/remove.js +0 -43
  219. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/lib/util.js +0 -81
  220. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/macOS_Catalina_acid_test.sh +0 -21
  221. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/package.json +0 -51
  222. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/release-please-config.json +0 -40
  223. package/.yarn/unplugged/node-gyp-npm-10.2.0-cad1109948/node_modules/node-gyp/src/win_delay_load_hook.cc +0 -39
  224. package/coverage/tmp/coverage-31752-1735543485354-0.json +0 -1
  225. package/coverage/tmp/coverage-59920-1735543484555-0.json +0 -1
  226. package/coverage/tmp/coverage-66252-1735543483919-0.json +0 -1
  227. package/coverage/tmp/coverage-68440-1735543485236-0.json +0 -1
  228. package/coverage/tmp/coverage-70588-1735543484426-0.json +0 -1
  229. package/coverage/tmp/coverage-79292-1735543485296-0.json +0 -1
  230. package/coverage/tmp/coverage-80212-1735543483980-0.json +0 -1
@@ -1,441 +1,441 @@
1
- import {
2
- PsbtInput,
3
- PsbtOutput,
4
- TapInternalKey,
5
- TapLeaf,
6
- TapLeafScript,
7
- TapScriptSig,
8
- TapTree,
9
- } from 'bip174/src/lib/interfaces.js';
10
- import { isTapleaf, isTaptree, Tapleaf, Taptree } from '../types.js';
11
-
12
- import { Transaction } from '../transaction.js';
13
-
14
- import {
15
- LEAF_VERSION_TAPSCRIPT,
16
- MAX_TAPTREE_DEPTH,
17
- rootHashFromPath,
18
- tapleafHash,
19
- tweakKey,
20
- } from '../payments/bip341.js';
21
- import { p2tr } from '../payments/p2tr.js';
22
- import {
23
- isP2TR,
24
- pubkeyPositionInScript,
25
- signatureBlocksAction,
26
- witnessStackToScriptWitness,
27
- } from './psbtutils.js';
28
-
29
- export const toXOnly = (pubKey: Buffer | Uint8Array): Buffer => {
30
- const buffer = pubKey.length === 32 ? pubKey : pubKey.slice(1, 33);
31
-
32
- return Buffer.isBuffer(buffer) ? buffer : Buffer.from(buffer);
33
- };
34
-
35
- /**
36
- * Default tapscript finalizer. It searches for the `tapLeafHashToFinalize` if provided.
37
- * Otherwise it will search for the tapleaf that has at least one signature and has the shortest path.
38
- * @param inputIndex the position of the PSBT input.
39
- * @param input the PSBT input.
40
- * @param tapLeafHashToFinalize optional, if provided the finalizer will search for a tapleaf that has this hash
41
- * and will try to build the finalScriptWitness.
42
- * @returns the finalScriptWitness or throws an exception if no tapleaf found.
43
- */
44
- export function tapScriptFinalizer(
45
- inputIndex: number,
46
- input: PsbtInput,
47
- tapLeafHashToFinalize?: Buffer,
48
- ): {
49
- finalScriptWitness: Buffer | undefined;
50
- } {
51
- const tapLeaf = findTapLeafToFinalize(input, inputIndex, tapLeafHashToFinalize);
52
-
53
- try {
54
- const sigs = sortSignatures(input, tapLeaf);
55
- const witness = sigs.concat(tapLeaf.script).concat(tapLeaf.controlBlock);
56
- return { finalScriptWitness: witnessStackToScriptWitness(witness) };
57
- } catch (err) {
58
- throw new Error(`Can not finalize taproot input #${inputIndex}: ${err}`);
59
- }
60
- }
61
-
62
- export function serializeTaprootSignature(sig: Buffer, sighashType?: number): Buffer {
63
- const sighashTypeByte = sighashType ? Buffer.from([sighashType!]) : Buffer.from([]);
64
-
65
- return Buffer.concat([sig, sighashTypeByte]);
66
- }
67
-
68
- export function isTaprootInput(input: PsbtInput): boolean {
69
- return (
70
- input &&
71
- !!(
72
- input.tapInternalKey ||
73
- input.tapMerkleRoot ||
74
- (input.tapLeafScript && input.tapLeafScript.length) ||
75
- (input.tapBip32Derivation && input.tapBip32Derivation.length) ||
76
- (input.witnessUtxo && isP2TR(input.witnessUtxo.script))
77
- )
78
- );
79
- }
80
-
81
- export function isTaprootOutput(output: PsbtOutput, script?: Buffer): boolean {
82
- return (
83
- output &&
84
- !!(
85
- output.tapInternalKey ||
86
- output.tapTree ||
87
- (output.tapBip32Derivation && output.tapBip32Derivation.length) ||
88
- (script && isP2TR(script))
89
- )
90
- );
91
- }
92
-
93
- export function checkTaprootInputFields(
94
- inputData: PsbtInput,
95
- newInputData: PsbtInput,
96
- action: string,
97
- ): void {
98
- checkMixedTaprootAndNonTaprootInputFields(inputData, newInputData, action);
99
- checkIfTapLeafInTree(inputData, newInputData, action);
100
- }
101
-
102
- export function checkTaprootOutputFields(
103
- outputData: PsbtOutput,
104
- newOutputData: PsbtOutput,
105
- action: string,
106
- ): void {
107
- checkMixedTaprootAndNonTaprootOutputFields(outputData, newOutputData, action);
108
- checkTaprootScriptPubkey(outputData, newOutputData);
109
- }
110
-
111
- function checkTaprootScriptPubkey(outputData: PsbtOutput, newOutputData: PsbtOutput): void {
112
- if (!newOutputData.tapTree && !newOutputData.tapInternalKey) return;
113
-
114
- const tapInternalKey = newOutputData.tapInternalKey || outputData.tapInternalKey;
115
- const tapTree = newOutputData.tapTree || outputData.tapTree;
116
-
117
- if (tapInternalKey) {
118
- const { script: scriptPubkey } = outputData as any;
119
- const script = getTaprootScripPubkey(tapInternalKey, tapTree);
120
- if (scriptPubkey && !scriptPubkey.equals(script))
121
- throw new Error('Error adding output. Script or address missmatch.');
122
- }
123
- }
124
-
125
- function getTaprootScripPubkey(tapInternalKey: TapInternalKey, tapTree?: TapTree): Buffer {
126
- const scriptTree = tapTree && tapTreeFromList(tapTree.leaves);
127
- const { output } = p2tr({
128
- internalPubkey: tapInternalKey,
129
- scriptTree,
130
- });
131
- return output!;
132
- }
133
-
134
- export function tweakInternalPubKey(inputIndex: number, input: PsbtInput): Buffer {
135
- const tapInternalKey = input.tapInternalKey;
136
- const outputKey = tapInternalKey && tweakKey(tapInternalKey, input.tapMerkleRoot);
137
-
138
- if (!outputKey)
139
- throw new Error(
140
- `Cannot tweak tap internal key for input #${inputIndex}. Public key: ${
141
- tapInternalKey && tapInternalKey.toString('hex')
142
- }`,
143
- );
144
- return outputKey.x;
145
- }
146
-
147
- /**
148
- * Convert a binary tree to a BIP371 type list. Each element of the list is (according to BIP371):
149
- * One or more tuples representing the depth, leaf version, and script for a leaf in the Taproot tree,
150
- * allowing the entire tree to be reconstructed. The tuples must be in depth first search order so that
151
- * the tree is correctly reconstructed.
152
- * @param tree the binary tap tree
153
- * @returns a list of BIP 371 tapleaves
154
- */
155
- export function tapTreeToList(tree: Taptree): TapLeaf[] {
156
- if (!isTaptree(tree))
157
- throw new Error('Cannot convert taptree to tapleaf list. Expecting a tapree structure.');
158
- return _tapTreeToList(tree);
159
- }
160
-
161
- /**
162
- * Convert a BIP371 TapLeaf list to a TapTree (binary).
163
- * @param leaves a list of tapleaves where each element of the list is (according to BIP371):
164
- * One or more tuples representing the depth, leaf version, and script for a leaf in the Taproot tree,
165
- * allowing the entire tree to be reconstructed. The tuples must be in depth first search order so that
166
- * the tree is correctly reconstructed.
167
- * @returns the corresponding taptree, or throws an exception if the tree cannot be reconstructed
168
- */
169
- export function tapTreeFromList(leaves: TapLeaf[] = []): Taptree {
170
- if (leaves.length === 1 && leaves[0].depth === 0)
171
- return {
172
- output: leaves[0].script,
173
- version: leaves[0].leafVersion,
174
- };
175
-
176
- return insertLeavesInTree(leaves);
177
- }
178
-
179
- export function checkTaprootInputForSigs(input: PsbtInput, action: string): boolean {
180
- const sigs = extractTaprootSigs(input);
181
- return sigs.some((sig) => signatureBlocksAction(sig, decodeSchnorrSignature, action));
182
- }
183
-
184
- function decodeSchnorrSignature(signature: Buffer): {
185
- signature: Buffer;
186
- hashType: number;
187
- } {
188
- return {
189
- signature: signature.slice(0, 64),
190
- hashType: signature.slice(64)[0] || Transaction.SIGHASH_DEFAULT,
191
- };
192
- }
193
-
194
- function extractTaprootSigs(input: PsbtInput): Buffer[] {
195
- const sigs: Buffer[] = [];
196
- if (input.tapKeySig) sigs.push(input.tapKeySig);
197
- if (input.tapScriptSig) sigs.push(...input.tapScriptSig.map((s) => s.signature));
198
- if (!sigs.length) {
199
- const finalTapKeySig = getTapKeySigFromWitness(input.finalScriptWitness);
200
- if (finalTapKeySig) sigs.push(finalTapKeySig);
201
- }
202
-
203
- return sigs;
204
- }
205
-
206
- export function getTapKeySigFromWitness(finalScriptWitness?: Buffer): Buffer | undefined {
207
- if (!finalScriptWitness) return;
208
- const witness = finalScriptWitness.slice(2);
209
- // todo: add schnorr signature validation
210
- if (witness.length === 64 || witness.length === 65) return witness;
211
- }
212
-
213
- function _tapTreeToList(tree: Taptree, leaves: TapLeaf[] = [], depth = 0): TapLeaf[] {
214
- if (depth > MAX_TAPTREE_DEPTH) throw new Error('Max taptree depth exceeded.');
215
- if (!tree) return [];
216
- if (isTapleaf(tree)) {
217
- leaves.push({
218
- depth,
219
- leafVersion: tree.version || LEAF_VERSION_TAPSCRIPT,
220
- script: tree.output,
221
- });
222
- return leaves;
223
- }
224
- if (tree[0]) _tapTreeToList(tree[0], leaves, depth + 1);
225
- if (tree[1]) _tapTreeToList(tree[1], leaves, depth + 1);
226
- return leaves;
227
- }
228
-
229
- // Just like Taptree, but it accepts empty branches
230
- type PartialTaptree = [PartialTaptree | Tapleaf, PartialTaptree | Tapleaf] | Tapleaf | undefined;
231
-
232
- function insertLeavesInTree(leaves: TapLeaf[]): Taptree {
233
- let tree: PartialTaptree;
234
- for (const leaf of leaves) {
235
- tree = insertLeafInTree(leaf, tree);
236
- if (!tree) throw new Error(`No room left to insert tapleaf in tree`);
237
- }
238
-
239
- return tree as Taptree;
240
- }
241
-
242
- function insertLeafInTree(leaf: TapLeaf, tree?: PartialTaptree, depth = 0): PartialTaptree {
243
- if (depth > MAX_TAPTREE_DEPTH) throw new Error('Max taptree depth exceeded.');
244
- if (leaf.depth === depth) {
245
- if (!tree)
246
- return {
247
- output: leaf.script,
248
- version: leaf.leafVersion,
249
- };
250
- return;
251
- }
252
-
253
- if (isTapleaf(tree)) return;
254
- const leftSide = insertLeafInTree(leaf, tree && tree[0], depth + 1);
255
- if (leftSide) return [leftSide, tree && tree[1]];
256
-
257
- const rightSide = insertLeafInTree(leaf, tree && tree[1], depth + 1);
258
- if (rightSide) return [tree && tree[0], rightSide];
259
- }
260
-
261
- function checkMixedTaprootAndNonTaprootInputFields(
262
- inputData: PsbtOutput,
263
- newInputData: PsbtInput,
264
- action: string,
265
- ): void {
266
- const isBadTaprootUpdate = isTaprootInput(inputData) && hasNonTaprootFields(newInputData);
267
- const isBadNonTaprootUpdate = hasNonTaprootFields(inputData) && isTaprootInput(newInputData);
268
- const hasMixedFields =
269
- inputData === newInputData &&
270
- isTaprootInput(newInputData) &&
271
- hasNonTaprootFields(newInputData); // todo: bad? use !===
272
-
273
- if (isBadTaprootUpdate || isBadNonTaprootUpdate || hasMixedFields)
274
- throw new Error(
275
- `Invalid arguments for Psbt.${action}. ` +
276
- `Cannot use both taproot and non-taproot fields.`,
277
- );
278
- }
279
-
280
- function checkMixedTaprootAndNonTaprootOutputFields(
281
- inputData: PsbtOutput,
282
- newInputData: PsbtOutput,
283
- action: string,
284
- ): void {
285
- const isBadTaprootUpdate = isTaprootOutput(inputData) && hasNonTaprootFields(newInputData);
286
- const isBadNonTaprootUpdate = hasNonTaprootFields(inputData) && isTaprootOutput(newInputData);
287
- const hasMixedFields =
288
- inputData === newInputData &&
289
- isTaprootOutput(newInputData) &&
290
- hasNonTaprootFields(newInputData);
291
-
292
- if (isBadTaprootUpdate || isBadNonTaprootUpdate || hasMixedFields)
293
- throw new Error(
294
- `Invalid arguments for Psbt.${action}. ` +
295
- `Cannot use both taproot and non-taproot fields.`,
296
- );
297
- }
298
-
299
- /**
300
- * Checks if the tap leaf is part of the tap tree for the given input data.
301
- * Throws an error if the tap leaf is not part of the tap tree.
302
- * @param inputData - The original PsbtInput data.
303
- * @param newInputData - The new PsbtInput data.
304
- * @param action - The action being performed.
305
- * @throws {Error} - If the tap leaf is not part of the tap tree.
306
- */
307
- function checkIfTapLeafInTree(inputData: PsbtInput, newInputData: PsbtInput, action: string): void {
308
- if (newInputData.tapMerkleRoot) {
309
- const newLeafsInTree = (newInputData.tapLeafScript || []).every((l) =>
310
- isTapLeafInTree(l, newInputData.tapMerkleRoot),
311
- );
312
- const oldLeafsInTree = (inputData.tapLeafScript || []).every((l) =>
313
- isTapLeafInTree(l, newInputData.tapMerkleRoot),
314
- );
315
- if (!newLeafsInTree || !oldLeafsInTree)
316
- throw new Error(`Invalid arguments for Psbt.${action}. Tapleaf not part of taptree.`);
317
- } else if (inputData.tapMerkleRoot) {
318
- const newLeafsInTree = (newInputData.tapLeafScript || []).every((l) =>
319
- isTapLeafInTree(l, inputData.tapMerkleRoot),
320
- );
321
- if (!newLeafsInTree)
322
- throw new Error(`Invalid arguments for Psbt.${action}. Tapleaf not part of taptree.`);
323
- }
324
- }
325
-
326
- /**
327
- * Checks if a TapLeafScript is present in a Merkle tree.
328
- * @param tapLeaf The TapLeafScript to check.
329
- * @param merkleRoot The Merkle root of the tree. If not provided, the function assumes the TapLeafScript is present.
330
- * @returns A boolean indicating whether the TapLeafScript is present in the tree.
331
- */
332
- function isTapLeafInTree(tapLeaf: TapLeafScript, merkleRoot?: Buffer): boolean {
333
- if (!merkleRoot) return true;
334
-
335
- const leafHash = tapleafHash({
336
- output: tapLeaf.script,
337
- version: tapLeaf.leafVersion,
338
- });
339
-
340
- const rootHash = rootHashFromPath(tapLeaf.controlBlock, leafHash);
341
- return rootHash.equals(merkleRoot);
342
- }
343
-
344
- /**
345
- * Sorts the signatures in the input's tapScriptSig array based on their position in the tapLeaf script.
346
- *
347
- * @param input - The PsbtInput object.
348
- * @param tapLeaf - The TapLeafScript object.
349
- * @returns An array of sorted signatures as Buffers.
350
- */
351
- function sortSignatures(input: PsbtInput, tapLeaf: TapLeafScript): Buffer[] {
352
- const leafHash = tapleafHash({
353
- output: tapLeaf.script,
354
- version: tapLeaf.leafVersion,
355
- });
356
-
357
- return (input.tapScriptSig || [])
358
- .filter((tss) => tss.leafHash.equals(leafHash))
359
- .map((tss) => addPubkeyPositionInScript(tapLeaf.script, tss))
360
- .sort((t1, t2) => t2.positionInScript - t1.positionInScript)
361
- .map((t) => t.signature) as Buffer[];
362
- }
363
-
364
- /**
365
- * Adds the position of a public key in a script to a TapScriptSig object.
366
- * @param script The script in which to find the position of the public key.
367
- * @param tss The TapScriptSig object to add the position to.
368
- * @returns A TapScriptSigWitPosition object with the added position.
369
- */
370
- function addPubkeyPositionInScript(script: Buffer, tss: TapScriptSig): TapScriptSigWitPosition {
371
- return Object.assign(
372
- {
373
- positionInScript: pubkeyPositionInScript(tss.pubkey, script),
374
- },
375
- tss,
376
- ) as TapScriptSigWitPosition;
377
- }
378
-
379
- /**
380
- * Find tapleaf by hash, or get the signed tapleaf with the shortest path.
381
- */
382
- function findTapLeafToFinalize(
383
- input: PsbtInput,
384
- inputIndex: number,
385
- leafHashToFinalize?: Buffer,
386
- ): TapLeafScript {
387
- if (!input.tapScriptSig || !input.tapScriptSig.length)
388
- throw new Error(
389
- `Can not finalize taproot input #${inputIndex}. No tapleaf script signature provided.`,
390
- );
391
- const tapLeaf = (input.tapLeafScript || [])
392
- .sort((a, b) => a.controlBlock.length - b.controlBlock.length)
393
- .find((leaf) => canFinalizeLeaf(leaf, input.tapScriptSig!, leafHashToFinalize));
394
-
395
- if (!tapLeaf)
396
- throw new Error(
397
- `Can not finalize taproot input #${inputIndex}. Signature for tapleaf script not found.`,
398
- );
399
-
400
- return tapLeaf;
401
- }
402
-
403
- /**
404
- * Determines whether a TapLeafScript can be finalized.
405
- *
406
- * @param leaf - The TapLeafScript to check.
407
- * @param tapScriptSig - The array of TapScriptSig objects.
408
- * @param hash - The optional hash to compare with the leaf hash.
409
- * @returns A boolean indicating whether the TapLeafScript can be finalized.
410
- */
411
- function canFinalizeLeaf(
412
- leaf: TapLeafScript,
413
- tapScriptSig: TapScriptSig[],
414
- hash?: Buffer,
415
- ): boolean {
416
- const leafHash = tapleafHash({
417
- output: leaf.script,
418
- version: leaf.leafVersion,
419
- });
420
- const whiteListedHash = !hash || hash.equals(leafHash);
421
- return (
422
- whiteListedHash && tapScriptSig!.find((tss) => tss.leafHash.equals(leafHash)) !== undefined
423
- );
424
- }
425
-
426
- /**
427
- * Checks if the given PsbtInput or PsbtOutput has non-taproot fields.
428
- * Non-taproot fields include redeemScript, witnessScript, and bip32Derivation.
429
- * @param io The PsbtInput or PsbtOutput to check.
430
- * @returns A boolean indicating whether the given input or output has non-taproot fields.
431
- */
432
- function hasNonTaprootFields(io: PsbtInput | PsbtOutput): boolean {
433
- return (
434
- io &&
435
- !!(io.redeemScript || io.witnessScript || (io.bip32Derivation && io.bip32Derivation.length))
436
- );
437
- }
438
-
439
- interface TapScriptSigWitPosition extends TapScriptSig {
440
- positionInScript: number;
441
- }
1
+ import {
2
+ PsbtInput,
3
+ PsbtOutput,
4
+ TapInternalKey,
5
+ TapLeaf,
6
+ TapLeafScript,
7
+ TapScriptSig,
8
+ TapTree,
9
+ } from 'bip174/src/lib/interfaces.js';
10
+ import { isTapleaf, isTaptree, Tapleaf, Taptree } from '../types.js';
11
+
12
+ import { Transaction } from '../transaction.js';
13
+
14
+ import {
15
+ LEAF_VERSION_TAPSCRIPT,
16
+ MAX_TAPTREE_DEPTH,
17
+ rootHashFromPath,
18
+ tapleafHash,
19
+ tweakKey,
20
+ } from '../payments/bip341.js';
21
+ import { p2tr } from '../payments/p2tr.js';
22
+ import {
23
+ isP2TR,
24
+ pubkeyPositionInScript,
25
+ signatureBlocksAction,
26
+ witnessStackToScriptWitness,
27
+ } from './psbtutils.js';
28
+
29
+ export const toXOnly = (pubKey: Buffer | Uint8Array): Buffer => {
30
+ const buffer = pubKey.length === 32 ? pubKey : pubKey.slice(1, 33);
31
+
32
+ return Buffer.isBuffer(buffer) ? buffer : Buffer.from(buffer);
33
+ };
34
+
35
+ /**
36
+ * Default tapscript finalizer. It searches for the `tapLeafHashToFinalize` if provided.
37
+ * Otherwise it will search for the tapleaf that has at least one signature and has the shortest path.
38
+ * @param inputIndex the position of the PSBT input.
39
+ * @param input the PSBT input.
40
+ * @param tapLeafHashToFinalize optional, if provided the finalizer will search for a tapleaf that has this hash
41
+ * and will try to build the finalScriptWitness.
42
+ * @returns the finalScriptWitness or throws an exception if no tapleaf found.
43
+ */
44
+ export function tapScriptFinalizer(
45
+ inputIndex: number,
46
+ input: PsbtInput,
47
+ tapLeafHashToFinalize?: Buffer,
48
+ ): {
49
+ finalScriptWitness: Buffer | undefined;
50
+ } {
51
+ const tapLeaf = findTapLeafToFinalize(input, inputIndex, tapLeafHashToFinalize);
52
+
53
+ try {
54
+ const sigs = sortSignatures(input, tapLeaf);
55
+ const witness = sigs.concat(tapLeaf.script).concat(tapLeaf.controlBlock);
56
+ return { finalScriptWitness: witnessStackToScriptWitness(witness) };
57
+ } catch (err) {
58
+ throw new Error(`Can not finalize taproot input #${inputIndex}: ${err}`);
59
+ }
60
+ }
61
+
62
+ export function serializeTaprootSignature(sig: Buffer, sighashType?: number): Buffer {
63
+ const sighashTypeByte = sighashType ? Buffer.from([sighashType!]) : Buffer.from([]);
64
+
65
+ return Buffer.concat([sig, sighashTypeByte]);
66
+ }
67
+
68
+ export function isTaprootInput(input: PsbtInput): boolean {
69
+ return (
70
+ input &&
71
+ !!(
72
+ input.tapInternalKey ||
73
+ input.tapMerkleRoot ||
74
+ (input.tapLeafScript && input.tapLeafScript.length) ||
75
+ (input.tapBip32Derivation && input.tapBip32Derivation.length) ||
76
+ (input.witnessUtxo && isP2TR(input.witnessUtxo.script))
77
+ )
78
+ );
79
+ }
80
+
81
+ export function isTaprootOutput(output: PsbtOutput, script?: Buffer): boolean {
82
+ return (
83
+ output &&
84
+ !!(
85
+ output.tapInternalKey ||
86
+ output.tapTree ||
87
+ (output.tapBip32Derivation && output.tapBip32Derivation.length) ||
88
+ (script && isP2TR(script))
89
+ )
90
+ );
91
+ }
92
+
93
+ export function checkTaprootInputFields(
94
+ inputData: PsbtInput,
95
+ newInputData: PsbtInput,
96
+ action: string,
97
+ ): void {
98
+ checkMixedTaprootAndNonTaprootInputFields(inputData, newInputData, action);
99
+ checkIfTapLeafInTree(inputData, newInputData, action);
100
+ }
101
+
102
+ export function checkTaprootOutputFields(
103
+ outputData: PsbtOutput,
104
+ newOutputData: PsbtOutput,
105
+ action: string,
106
+ ): void {
107
+ checkMixedTaprootAndNonTaprootOutputFields(outputData, newOutputData, action);
108
+ checkTaprootScriptPubkey(outputData, newOutputData);
109
+ }
110
+
111
+ function checkTaprootScriptPubkey(outputData: PsbtOutput, newOutputData: PsbtOutput): void {
112
+ if (!newOutputData.tapTree && !newOutputData.tapInternalKey) return;
113
+
114
+ const tapInternalKey = newOutputData.tapInternalKey || outputData.tapInternalKey;
115
+ const tapTree = newOutputData.tapTree || outputData.tapTree;
116
+
117
+ if (tapInternalKey) {
118
+ const { script: scriptPubkey } = outputData as any;
119
+ const script = getTaprootScripPubkey(tapInternalKey, tapTree);
120
+ if (scriptPubkey && !scriptPubkey.equals(script))
121
+ throw new Error('Error adding output. Script or address missmatch.');
122
+ }
123
+ }
124
+
125
+ function getTaprootScripPubkey(tapInternalKey: TapInternalKey, tapTree?: TapTree): Buffer {
126
+ const scriptTree = tapTree && tapTreeFromList(tapTree.leaves);
127
+ const { output } = p2tr({
128
+ internalPubkey: tapInternalKey,
129
+ scriptTree,
130
+ });
131
+ return output!;
132
+ }
133
+
134
+ export function tweakInternalPubKey(inputIndex: number, input: PsbtInput): Buffer {
135
+ const tapInternalKey = input.tapInternalKey;
136
+ const outputKey = tapInternalKey && tweakKey(tapInternalKey, input.tapMerkleRoot);
137
+
138
+ if (!outputKey)
139
+ throw new Error(
140
+ `Cannot tweak tap internal key for input #${inputIndex}. Public key: ${
141
+ tapInternalKey && tapInternalKey.toString('hex')
142
+ }`,
143
+ );
144
+ return outputKey.x;
145
+ }
146
+
147
+ /**
148
+ * Convert a binary tree to a BIP371 type list. Each element of the list is (according to BIP371):
149
+ * One or more tuples representing the depth, leaf version, and script for a leaf in the Taproot tree,
150
+ * allowing the entire tree to be reconstructed. The tuples must be in depth first search order so that
151
+ * the tree is correctly reconstructed.
152
+ * @param tree the binary tap tree
153
+ * @returns a list of BIP 371 tapleaves
154
+ */
155
+ export function tapTreeToList(tree: Taptree): TapLeaf[] {
156
+ if (!isTaptree(tree))
157
+ throw new Error('Cannot convert taptree to tapleaf list. Expecting a tapree structure.');
158
+ return _tapTreeToList(tree);
159
+ }
160
+
161
+ /**
162
+ * Convert a BIP371 TapLeaf list to a TapTree (binary).
163
+ * @param leaves a list of tapleaves where each element of the list is (according to BIP371):
164
+ * One or more tuples representing the depth, leaf version, and script for a leaf in the Taproot tree,
165
+ * allowing the entire tree to be reconstructed. The tuples must be in depth first search order so that
166
+ * the tree is correctly reconstructed.
167
+ * @returns the corresponding taptree, or throws an exception if the tree cannot be reconstructed
168
+ */
169
+ export function tapTreeFromList(leaves: TapLeaf[] = []): Taptree {
170
+ if (leaves.length === 1 && leaves[0].depth === 0)
171
+ return {
172
+ output: leaves[0].script,
173
+ version: leaves[0].leafVersion,
174
+ };
175
+
176
+ return insertLeavesInTree(leaves);
177
+ }
178
+
179
+ export function checkTaprootInputForSigs(input: PsbtInput, action: string): boolean {
180
+ const sigs = extractTaprootSigs(input);
181
+ return sigs.some((sig) => signatureBlocksAction(sig, decodeSchnorrSignature, action));
182
+ }
183
+
184
+ function decodeSchnorrSignature(signature: Buffer): {
185
+ signature: Buffer;
186
+ hashType: number;
187
+ } {
188
+ return {
189
+ signature: signature.slice(0, 64),
190
+ hashType: signature.slice(64)[0] || Transaction.SIGHASH_DEFAULT,
191
+ };
192
+ }
193
+
194
+ function extractTaprootSigs(input: PsbtInput): Buffer[] {
195
+ const sigs: Buffer[] = [];
196
+ if (input.tapKeySig) sigs.push(input.tapKeySig);
197
+ if (input.tapScriptSig) sigs.push(...input.tapScriptSig.map((s) => s.signature));
198
+ if (!sigs.length) {
199
+ const finalTapKeySig = getTapKeySigFromWitness(input.finalScriptWitness);
200
+ if (finalTapKeySig) sigs.push(finalTapKeySig);
201
+ }
202
+
203
+ return sigs;
204
+ }
205
+
206
+ export function getTapKeySigFromWitness(finalScriptWitness?: Buffer): Buffer | undefined {
207
+ if (!finalScriptWitness) return;
208
+ const witness = finalScriptWitness.slice(2);
209
+ // todo: add schnorr signature validation
210
+ if (witness.length === 64 || witness.length === 65) return witness;
211
+ }
212
+
213
+ function _tapTreeToList(tree: Taptree, leaves: TapLeaf[] = [], depth = 0): TapLeaf[] {
214
+ if (depth > MAX_TAPTREE_DEPTH) throw new Error('Max taptree depth exceeded.');
215
+ if (!tree) return [];
216
+ if (isTapleaf(tree)) {
217
+ leaves.push({
218
+ depth,
219
+ leafVersion: tree.version || LEAF_VERSION_TAPSCRIPT,
220
+ script: tree.output,
221
+ });
222
+ return leaves;
223
+ }
224
+ if (tree[0]) _tapTreeToList(tree[0], leaves, depth + 1);
225
+ if (tree[1]) _tapTreeToList(tree[1], leaves, depth + 1);
226
+ return leaves;
227
+ }
228
+
229
+ // Just like Taptree, but it accepts empty branches
230
+ type PartialTaptree = [PartialTaptree | Tapleaf, PartialTaptree | Tapleaf] | Tapleaf | undefined;
231
+
232
+ function insertLeavesInTree(leaves: TapLeaf[]): Taptree {
233
+ let tree: PartialTaptree;
234
+ for (const leaf of leaves) {
235
+ tree = insertLeafInTree(leaf, tree);
236
+ if (!tree) throw new Error(`No room left to insert tapleaf in tree`);
237
+ }
238
+
239
+ return tree as Taptree;
240
+ }
241
+
242
+ function insertLeafInTree(leaf: TapLeaf, tree?: PartialTaptree, depth = 0): PartialTaptree {
243
+ if (depth > MAX_TAPTREE_DEPTH) throw new Error('Max taptree depth exceeded.');
244
+ if (leaf.depth === depth) {
245
+ if (!tree)
246
+ return {
247
+ output: leaf.script,
248
+ version: leaf.leafVersion,
249
+ };
250
+ return;
251
+ }
252
+
253
+ if (isTapleaf(tree)) return;
254
+ const leftSide = insertLeafInTree(leaf, tree && tree[0], depth + 1);
255
+ if (leftSide) return [leftSide, tree && tree[1]];
256
+
257
+ const rightSide = insertLeafInTree(leaf, tree && tree[1], depth + 1);
258
+ if (rightSide) return [tree && tree[0], rightSide];
259
+ }
260
+
261
+ function checkMixedTaprootAndNonTaprootInputFields(
262
+ inputData: PsbtOutput,
263
+ newInputData: PsbtInput,
264
+ action: string,
265
+ ): void {
266
+ const isBadTaprootUpdate = isTaprootInput(inputData) && hasNonTaprootFields(newInputData);
267
+ const isBadNonTaprootUpdate = hasNonTaprootFields(inputData) && isTaprootInput(newInputData);
268
+ const hasMixedFields =
269
+ inputData === newInputData &&
270
+ isTaprootInput(newInputData) &&
271
+ hasNonTaprootFields(newInputData); // todo: bad? use !===
272
+
273
+ if (isBadTaprootUpdate || isBadNonTaprootUpdate || hasMixedFields)
274
+ throw new Error(
275
+ `Invalid arguments for Psbt.${action}. ` +
276
+ `Cannot use both taproot and non-taproot fields.`,
277
+ );
278
+ }
279
+
280
+ function checkMixedTaprootAndNonTaprootOutputFields(
281
+ inputData: PsbtOutput,
282
+ newInputData: PsbtOutput,
283
+ action: string,
284
+ ): void {
285
+ const isBadTaprootUpdate = isTaprootOutput(inputData) && hasNonTaprootFields(newInputData);
286
+ const isBadNonTaprootUpdate = hasNonTaprootFields(inputData) && isTaprootOutput(newInputData);
287
+ const hasMixedFields =
288
+ inputData === newInputData &&
289
+ isTaprootOutput(newInputData) &&
290
+ hasNonTaprootFields(newInputData);
291
+
292
+ if (isBadTaprootUpdate || isBadNonTaprootUpdate || hasMixedFields)
293
+ throw new Error(
294
+ `Invalid arguments for Psbt.${action}. ` +
295
+ `Cannot use both taproot and non-taproot fields.`,
296
+ );
297
+ }
298
+
299
+ /**
300
+ * Checks if the tap leaf is part of the tap tree for the given input data.
301
+ * Throws an error if the tap leaf is not part of the tap tree.
302
+ * @param inputData - The original PsbtInput data.
303
+ * @param newInputData - The new PsbtInput data.
304
+ * @param action - The action being performed.
305
+ * @throws {Error} - If the tap leaf is not part of the tap tree.
306
+ */
307
+ function checkIfTapLeafInTree(inputData: PsbtInput, newInputData: PsbtInput, action: string): void {
308
+ if (newInputData.tapMerkleRoot) {
309
+ const newLeafsInTree = (newInputData.tapLeafScript || []).every((l) =>
310
+ isTapLeafInTree(l, newInputData.tapMerkleRoot),
311
+ );
312
+ const oldLeafsInTree = (inputData.tapLeafScript || []).every((l) =>
313
+ isTapLeafInTree(l, newInputData.tapMerkleRoot),
314
+ );
315
+ if (!newLeafsInTree || !oldLeafsInTree)
316
+ throw new Error(`Invalid arguments for Psbt.${action}. Tapleaf not part of taptree.`);
317
+ } else if (inputData.tapMerkleRoot) {
318
+ const newLeafsInTree = (newInputData.tapLeafScript || []).every((l) =>
319
+ isTapLeafInTree(l, inputData.tapMerkleRoot),
320
+ );
321
+ if (!newLeafsInTree)
322
+ throw new Error(`Invalid arguments for Psbt.${action}. Tapleaf not part of taptree.`);
323
+ }
324
+ }
325
+
326
+ /**
327
+ * Checks if a TapLeafScript is present in a Merkle tree.
328
+ * @param tapLeaf The TapLeafScript to check.
329
+ * @param merkleRoot The Merkle root of the tree. If not provided, the function assumes the TapLeafScript is present.
330
+ * @returns A boolean indicating whether the TapLeafScript is present in the tree.
331
+ */
332
+ function isTapLeafInTree(tapLeaf: TapLeafScript, merkleRoot?: Buffer): boolean {
333
+ if (!merkleRoot) return true;
334
+
335
+ const leafHash = tapleafHash({
336
+ output: tapLeaf.script,
337
+ version: tapLeaf.leafVersion,
338
+ });
339
+
340
+ const rootHash = rootHashFromPath(tapLeaf.controlBlock, leafHash);
341
+ return rootHash.equals(merkleRoot);
342
+ }
343
+
344
+ /**
345
+ * Sorts the signatures in the input's tapScriptSig array based on their position in the tapLeaf script.
346
+ *
347
+ * @param input - The PsbtInput object.
348
+ * @param tapLeaf - The TapLeafScript object.
349
+ * @returns An array of sorted signatures as Buffers.
350
+ */
351
+ function sortSignatures(input: PsbtInput, tapLeaf: TapLeafScript): Buffer[] {
352
+ const leafHash = tapleafHash({
353
+ output: tapLeaf.script,
354
+ version: tapLeaf.leafVersion,
355
+ });
356
+
357
+ return (input.tapScriptSig || [])
358
+ .filter((tss) => tss.leafHash.equals(leafHash))
359
+ .map((tss) => addPubkeyPositionInScript(tapLeaf.script, tss))
360
+ .sort((t1, t2) => t2.positionInScript - t1.positionInScript)
361
+ .map((t) => t.signature) as Buffer[];
362
+ }
363
+
364
+ /**
365
+ * Adds the position of a public key in a script to a TapScriptSig object.
366
+ * @param script The script in which to find the position of the public key.
367
+ * @param tss The TapScriptSig object to add the position to.
368
+ * @returns A TapScriptSigWitPosition object with the added position.
369
+ */
370
+ function addPubkeyPositionInScript(script: Buffer, tss: TapScriptSig): TapScriptSigWitPosition {
371
+ return Object.assign(
372
+ {
373
+ positionInScript: pubkeyPositionInScript(tss.pubkey, script),
374
+ },
375
+ tss,
376
+ ) as TapScriptSigWitPosition;
377
+ }
378
+
379
+ /**
380
+ * Find tapleaf by hash, or get the signed tapleaf with the shortest path.
381
+ */
382
+ function findTapLeafToFinalize(
383
+ input: PsbtInput,
384
+ inputIndex: number,
385
+ leafHashToFinalize?: Buffer,
386
+ ): TapLeafScript {
387
+ if (!input.tapScriptSig || !input.tapScriptSig.length)
388
+ throw new Error(
389
+ `Can not finalize taproot input #${inputIndex}. No tapleaf script signature provided.`,
390
+ );
391
+ const tapLeaf = (input.tapLeafScript || [])
392
+ .sort((a, b) => a.controlBlock.length - b.controlBlock.length)
393
+ .find((leaf) => canFinalizeLeaf(leaf, input.tapScriptSig!, leafHashToFinalize));
394
+
395
+ if (!tapLeaf)
396
+ throw new Error(
397
+ `Can not finalize taproot input #${inputIndex}. Signature for tapleaf script not found.`,
398
+ );
399
+
400
+ return tapLeaf;
401
+ }
402
+
403
+ /**
404
+ * Determines whether a TapLeafScript can be finalized.
405
+ *
406
+ * @param leaf - The TapLeafScript to check.
407
+ * @param tapScriptSig - The array of TapScriptSig objects.
408
+ * @param hash - The optional hash to compare with the leaf hash.
409
+ * @returns A boolean indicating whether the TapLeafScript can be finalized.
410
+ */
411
+ function canFinalizeLeaf(
412
+ leaf: TapLeafScript,
413
+ tapScriptSig: TapScriptSig[],
414
+ hash?: Buffer,
415
+ ): boolean {
416
+ const leafHash = tapleafHash({
417
+ output: leaf.script,
418
+ version: leaf.leafVersion,
419
+ });
420
+ const whiteListedHash = !hash || hash.equals(leafHash);
421
+ return (
422
+ whiteListedHash && tapScriptSig!.find((tss) => tss.leafHash.equals(leafHash)) !== undefined
423
+ );
424
+ }
425
+
426
+ /**
427
+ * Checks if the given PsbtInput or PsbtOutput has non-taproot fields.
428
+ * Non-taproot fields include redeemScript, witnessScript, and bip32Derivation.
429
+ * @param io The PsbtInput or PsbtOutput to check.
430
+ * @returns A boolean indicating whether the given input or output has non-taproot fields.
431
+ */
432
+ function hasNonTaprootFields(io: PsbtInput | PsbtOutput): boolean {
433
+ return (
434
+ io &&
435
+ !!(io.redeemScript || io.witnessScript || (io.bip32Derivation && io.bip32Derivation.length))
436
+ );
437
+ }
438
+
439
+ interface TapScriptSigWitPosition extends TapScriptSig {
440
+ positionInScript: number;
441
+ }