@btc-vision/bitcoin 6.3.0 → 6.3.2

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 (260) hide show
  1. package/.babelrc +4 -0
  2. package/.gitattributes +2 -0
  3. package/.nyc_output/6368a5b2-daa5-4821-8ed0-b742d6fc7eab.json +1 -0
  4. package/.nyc_output/processinfo/6368a5b2-daa5-4821-8ed0-b742d6fc7eab.json +1 -0
  5. package/.nyc_output/processinfo/index.json +1 -0
  6. package/.prettierrc.json +12 -0
  7. package/CHANGELOG.md +403 -0
  8. package/CONTRIBUTING.md +83 -0
  9. package/browser/address.d.ts +16 -0
  10. package/{src → browser}/bip66.d.ts +6 -7
  11. package/{src → browser}/block.d.ts +29 -30
  12. package/{src → browser}/bufferutils.d.ts +34 -54
  13. package/browser/crypto/crypto.d.ts +1 -0
  14. package/{src → browser}/crypto.d.ts +13 -18
  15. package/browser/ecc_lib.d.ts +3 -0
  16. package/browser/hooks/AdvancedSignatureManager.d.ts +16 -0
  17. package/{src → browser}/hooks/HookedSigner.d.ts +4 -4
  18. package/browser/hooks/SignatureManager.d.ts +13 -0
  19. package/browser/index.d.ts +58 -0
  20. package/browser/index.js +2 -0
  21. package/browser/index.js.LICENSE.txt +14 -0
  22. package/browser/merkle.d.ts +1 -0
  23. package/browser/networks.d.ts +23 -0
  24. package/{src → browser}/ops.d.ts +126 -126
  25. package/browser/payments/bip341.d.ts +23 -0
  26. package/browser/payments/embed.d.ts +2 -0
  27. package/browser/payments/index.d.ts +41 -0
  28. package/{src → browser}/payments/lazy.d.ts +2 -2
  29. package/browser/payments/p2ms.d.ts +2 -0
  30. package/browser/payments/p2pk.d.ts +2 -0
  31. package/browser/payments/p2pkh.d.ts +2 -0
  32. package/browser/payments/p2sh.d.ts +2 -0
  33. package/browser/payments/p2tr.d.ts +2 -0
  34. package/browser/payments/p2wpkh.d.ts +2 -0
  35. package/browser/payments/p2wsh.d.ts +2 -0
  36. package/browser/psbt/bip371.d.ts +16 -0
  37. package/browser/psbt/psbtutils.d.ts +26 -0
  38. package/{src → browser}/psbt.d.ts +167 -235
  39. package/browser/push_data.d.ts +7 -0
  40. package/browser/script.d.ts +17 -0
  41. package/browser/script_number.d.ts +2 -0
  42. package/browser/script_signature.d.ts +7 -0
  43. package/{src → browser}/transaction.d.ts +48 -60
  44. package/{src → browser}/types.d.ts +37 -54
  45. package/build/address.d.ts +16 -0
  46. package/build/address.js +148 -0
  47. package/build/bip66.d.ts +6 -0
  48. package/build/bip66.js +99 -0
  49. package/build/block.d.ts +29 -0
  50. package/build/block.js +181 -0
  51. package/build/bufferutils.d.ts +34 -0
  52. package/build/bufferutils.js +141 -0
  53. package/build/crypto/crypto.d.ts +1 -0
  54. package/build/crypto/crypto.js +1 -0
  55. package/build/crypto.d.ts +13 -0
  56. package/build/crypto.js +87 -0
  57. package/build/ecc_lib.d.ts +3 -0
  58. package/build/ecc_lib.js +61 -0
  59. package/build/hooks/AdvancedSignatureManager.d.ts +16 -0
  60. package/build/hooks/AdvancedSignatureManager.js +52 -0
  61. package/build/hooks/HookedSigner.d.ts +4 -0
  62. package/build/hooks/HookedSigner.js +64 -0
  63. package/build/hooks/SignatureManager.d.ts +13 -0
  64. package/build/hooks/SignatureManager.js +45 -0
  65. package/build/index.d.ts +58 -0
  66. package/build/index.js +32 -0
  67. package/build/merkle.d.ts +1 -0
  68. package/build/merkle.js +19 -0
  69. package/build/networks.d.ts +23 -0
  70. package/build/networks.js +121 -0
  71. package/build/ops.d.ts +126 -0
  72. package/{src → build}/ops.js +127 -131
  73. package/build/payments/bip341.d.ts +23 -0
  74. package/build/payments/bip341.js +82 -0
  75. package/build/payments/embed.d.ts +2 -0
  76. package/build/payments/embed.js +39 -0
  77. package/build/payments/index.d.ts +41 -0
  78. package/build/payments/index.js +10 -0
  79. package/build/payments/lazy.d.ts +2 -0
  80. package/{src → build}/payments/lazy.js +28 -32
  81. package/build/payments/p2ms.d.ts +2 -0
  82. package/{src → build}/payments/p2ms.js +128 -158
  83. package/build/payments/p2pk.d.ts +2 -0
  84. package/build/payments/p2pk.js +68 -0
  85. package/build/payments/p2pkh.d.ts +2 -0
  86. package/build/payments/p2pkh.js +135 -0
  87. package/build/payments/p2sh.d.ts +2 -0
  88. package/build/payments/p2sh.js +175 -0
  89. package/build/payments/p2tr.d.ts +2 -0
  90. package/build/payments/p2tr.js +254 -0
  91. package/build/payments/p2wpkh.d.ts +2 -0
  92. package/build/payments/p2wpkh.js +130 -0
  93. package/build/payments/p2wsh.d.ts +2 -0
  94. package/build/payments/p2wsh.js +180 -0
  95. package/build/psbt/bip371.d.ts +16 -0
  96. package/build/psbt/bip371.js +246 -0
  97. package/build/psbt/psbtutils.d.ts +26 -0
  98. package/build/psbt/psbtutils.js +170 -0
  99. package/build/psbt.d.ts +167 -0
  100. package/build/psbt.js +1305 -0
  101. package/build/push_data.d.ts +7 -0
  102. package/build/push_data.js +57 -0
  103. package/build/script.d.ts +17 -0
  104. package/build/script.js +167 -0
  105. package/build/script_number.d.ts +2 -0
  106. package/build/script_number.js +49 -0
  107. package/build/script_signature.d.ts +7 -0
  108. package/build/script_signature.js +49 -0
  109. package/build/transaction.d.ts +48 -0
  110. package/build/transaction.js +445 -0
  111. package/build/types.d.ts +37 -0
  112. package/build/types.js +73 -0
  113. package/cjs/package.json +3 -0
  114. package/eslint.config.js +56 -0
  115. package/gulpfile.js +42 -0
  116. package/package.json +105 -50
  117. package/src/{address.js → address.ts} +93 -73
  118. package/src/{bip66.js → bip66.ts} +23 -19
  119. package/src/{block.js → block.ts} +114 -105
  120. package/src/{bufferutils.js → bufferutils.ts} +65 -67
  121. package/src/crypto/crypto-browser.js +75 -0
  122. package/src/crypto/crypto.ts +1 -0
  123. package/src/crypto.ts +108 -0
  124. package/src/{ecc_lib.js → ecc_lib.ts} +25 -53
  125. package/src/hooks/{AdvancedSignatureManager.js → AdvancedSignatureManager.ts} +34 -18
  126. package/src/hooks/HookedSigner.ts +108 -0
  127. package/src/hooks/{SignatureManager.js → SignatureManager.ts} +26 -14
  128. package/src/index.ts +86 -0
  129. package/src/{merkle.js → merkle.ts} +8 -7
  130. package/src/networks.ts +235 -0
  131. package/src/ops.ts +282 -0
  132. package/src/payments/bip341.ts +140 -0
  133. package/src/payments/embed.ts +55 -0
  134. package/src/payments/{index.d.ts → index.ts} +20 -10
  135. package/src/payments/lazy.ts +28 -0
  136. package/src/payments/p2ms.ts +150 -0
  137. package/src/payments/{p2pk.js → p2pk.ts} +32 -29
  138. package/src/payments/{p2pkh.js → p2pkh.ts} +53 -47
  139. package/src/payments/{p2sh.js → p2sh.ts} +72 -71
  140. package/src/payments/{p2tr.js → p2tr.ts} +114 -125
  141. package/src/payments/{p2wpkh.js → p2wpkh.ts} +51 -56
  142. package/src/payments/{p2wsh.js → p2wsh.ts} +69 -81
  143. package/src/psbt/{bip371.js → bip371.ts} +195 -178
  144. package/src/psbt/psbtutils.ts +299 -0
  145. package/src/{psbt.js → psbt.ts} +1048 -699
  146. package/src/{push_data.js → push_data.ts} +35 -21
  147. package/src/{script.js → script.ts} +93 -77
  148. package/src/{script_number.js → script_number.ts} +15 -21
  149. package/src/{script_signature.js → script_signature.ts} +26 -14
  150. package/src/{transaction.js → transaction.ts} +247 -167
  151. package/src/types.ts +122 -0
  152. package/test/address.spec.js +124 -0
  153. package/test/address.spec.ts +177 -0
  154. package/test/bitcoin.core.spec.js +170 -0
  155. package/test/bitcoin.core.spec.ts +234 -0
  156. package/test/block.spec.js +141 -0
  157. package/test/block.spec.ts +194 -0
  158. package/test/bufferutils.spec.js +427 -0
  159. package/test/bufferutils.spec.ts +513 -0
  160. package/test/crypto.spec.js +41 -0
  161. package/test/crypto.spec.ts +55 -0
  162. package/test/fixtures/address.json +329 -0
  163. package/test/fixtures/block.json +148 -0
  164. package/test/fixtures/bufferutils.json +102 -0
  165. package/test/fixtures/core/README.md +26 -0
  166. package/test/fixtures/core/base58_encode_decode.json +50 -0
  167. package/test/fixtures/core/base58_keys_invalid.json +152 -0
  168. package/test/fixtures/core/base58_keys_valid.json +452 -0
  169. package/test/fixtures/core/blocks.json +27 -0
  170. package/test/fixtures/core/sig_canonical.json +7 -0
  171. package/test/fixtures/core/sig_noncanonical.json +33 -0
  172. package/test/fixtures/core/sighash.json +3505 -0
  173. package/test/fixtures/core/tx_valid.json +2023 -0
  174. package/test/fixtures/crypto.json +43 -0
  175. package/test/fixtures/ecdsa.json +217 -0
  176. package/test/fixtures/ecpair.json +141 -0
  177. package/test/fixtures/embed.json +108 -0
  178. package/test/fixtures/p2ms.json +434 -0
  179. package/test/fixtures/p2pk.json +179 -0
  180. package/test/fixtures/p2pkh.json +276 -0
  181. package/test/fixtures/p2sh.json +508 -0
  182. package/test/fixtures/p2tr.json +1198 -0
  183. package/test/fixtures/p2wpkh.json +290 -0
  184. package/test/fixtures/p2wsh.json +489 -0
  185. package/test/fixtures/psbt.json +924 -0
  186. package/test/fixtures/script.json +465 -0
  187. package/test/fixtures/script_number.json +225 -0
  188. package/test/fixtures/signature.json +140 -0
  189. package/test/fixtures/transaction.json +916 -0
  190. package/test/integration/_regtest.js +7 -0
  191. package/test/integration/_regtest.ts +6 -0
  192. package/test/integration/addresses.spec.js +116 -0
  193. package/test/integration/addresses.spec.ts +154 -0
  194. package/test/integration/bip32.spec.js +85 -0
  195. package/test/integration/bip32.spec.ts +151 -0
  196. package/test/integration/blocks.spec.js +26 -0
  197. package/test/integration/blocks.spec.ts +28 -0
  198. package/test/integration/cltv.spec.js +199 -0
  199. package/test/integration/cltv.spec.ts +283 -0
  200. package/test/integration/csv.spec.js +362 -0
  201. package/test/integration/csv.spec.ts +527 -0
  202. package/test/integration/payments.spec.js +98 -0
  203. package/test/integration/payments.spec.ts +135 -0
  204. package/test/integration/taproot.spec.js +532 -0
  205. package/test/integration/taproot.spec.ts +707 -0
  206. package/test/integration/transactions.spec.js +561 -0
  207. package/test/integration/transactions.spec.ts +769 -0
  208. package/test/payments.spec.js +97 -0
  209. package/test/payments.spec.ts +125 -0
  210. package/test/payments.utils.js +190 -0
  211. package/test/payments.utils.ts +208 -0
  212. package/test/psbt.spec.js +1044 -0
  213. package/test/psbt.spec.ts +1414 -0
  214. package/test/script.spec.js +151 -0
  215. package/test/script.spec.ts +210 -0
  216. package/test/script_number.spec.js +24 -0
  217. package/test/script_number.spec.ts +29 -0
  218. package/test/script_signature.spec.js +52 -0
  219. package/test/script_signature.spec.ts +66 -0
  220. package/test/transaction.spec.js +269 -0
  221. package/test/transaction.spec.ts +387 -0
  222. package/test/ts-node-register.js +5 -0
  223. package/test/tsconfig.json +45 -0
  224. package/test/types.spec.js +46 -0
  225. package/test/types.spec.ts +58 -0
  226. package/tsconfig.base.json +27 -0
  227. package/tsconfig.json +19 -0
  228. package/tsconfig.webpack.json +18 -0
  229. package/webpack.config.js +79 -0
  230. package/src/address.d.ts +0 -42
  231. package/src/crypto.js +0 -128
  232. package/src/ecc_lib.d.ts +0 -17
  233. package/src/hooks/AdvancedSignatureManager.d.ts +0 -44
  234. package/src/hooks/HookedSigner.js +0 -90
  235. package/src/hooks/SignatureManager.d.ts +0 -35
  236. package/src/index.d.ts +0 -42
  237. package/src/index.js +0 -87
  238. package/src/merkle.d.ts +0 -10
  239. package/src/networks.d.ts +0 -29
  240. package/src/networks.js +0 -71
  241. package/src/payments/bip341.d.ts +0 -49
  242. package/src/payments/bip341.js +0 -124
  243. package/src/payments/embed.d.ts +0 -9
  244. package/src/payments/embed.js +0 -54
  245. package/src/payments/index.js +0 -69
  246. package/src/payments/p2ms.d.ts +0 -9
  247. package/src/payments/p2pk.d.ts +0 -10
  248. package/src/payments/p2pkh.d.ts +0 -10
  249. package/src/payments/p2sh.d.ts +0 -10
  250. package/src/payments/p2tr.d.ts +0 -10
  251. package/src/payments/p2wpkh.d.ts +0 -10
  252. package/src/payments/p2wsh.d.ts +0 -10
  253. package/src/psbt/bip371.d.ts +0 -42
  254. package/src/psbt/psbtutils.d.ts +0 -64
  255. package/src/psbt/psbtutils.js +0 -191
  256. package/src/push_data.d.ts +0 -29
  257. package/src/script.d.ts +0 -42
  258. package/src/script_number.d.ts +0 -19
  259. package/src/script_signature.d.ts +0 -21
  260. package/src/types.js +0 -106
package/src/index.d.ts DELETED
@@ -1,42 +0,0 @@
1
- import * as address from './address';
2
- import * as crypto from './crypto';
3
- import * as networks from './networks';
4
- import * as payments from './payments';
5
- import * as script from './script';
6
- import { PsbtInput as _PsbtInput, PsbtInputUpdate as _PsbtInputUpdate, PsbtOutput as _PsbtOutput, TapBip32Derivation as _TapBip32Derivation, TapInternalKey as _TapInternalKey, TapKeySig as _TapKeySig, TapLeaf as _TapLeaf, TapLeafScript as _TapLeafScript, TapMerkleRoot as _TapMerkleRoot, TapScriptSig as _TapScriptSig, TapTree as _TapTree } from 'bip174/src/lib/interfaces';
7
- export { address, crypto, networks, payments, script };
8
- export { Block } from './block';
9
- /** @hidden */
10
- export { TaggedHashPrefix } from './crypto';
11
- export * from './psbt';
12
- /** @hidden */
13
- export { OPS as opcodes } from './ops';
14
- export { Transaction } from './transaction';
15
- /** @hidden */
16
- export { Network } from './networks';
17
- /** @hidden */
18
- export { Payment, PaymentCreator, PaymentOpts, Stack, StackElement, } from './payments';
19
- export { Input as TxInput, Output as TxOutput } from './transaction';
20
- export { initEccLib } from './ecc_lib';
21
- export interface PsbtInput extends _PsbtInput {
22
- }
23
- export interface PsbtOutput extends _PsbtOutput {
24
- }
25
- export interface TapInternalKey extends _TapInternalKey {
26
- }
27
- export interface TapLeaf extends _TapLeaf {
28
- }
29
- export interface TapScriptSig extends _TapScriptSig {
30
- }
31
- export interface TapKeySig extends _TapKeySig {
32
- }
33
- export interface TapTree extends _TapTree {
34
- }
35
- export interface TapMerkleRoot extends _TapMerkleRoot {
36
- }
37
- export interface TapLeafScript extends _TapLeafScript {
38
- }
39
- export interface TapBip32Derivation extends _TapBip32Derivation {
40
- }
41
- export interface PsbtInputUpdate extends _PsbtInputUpdate {
42
- }
package/src/index.js DELETED
@@ -1,87 +0,0 @@
1
- 'use strict';
2
- var __createBinding =
3
- (this && this.__createBinding) ||
4
- (Object.create
5
- ? function (o, m, k, k2) {
6
- if (k2 === undefined) k2 = k;
7
- var desc = Object.getOwnPropertyDescriptor(m, k);
8
- if (
9
- !desc ||
10
- ('get' in desc
11
- ? !m.__esModule
12
- : desc.writable || desc.configurable)
13
- ) {
14
- desc = {
15
- enumerable: true,
16
- get: function () {
17
- return m[k];
18
- },
19
- };
20
- }
21
- Object.defineProperty(o, k2, desc);
22
- }
23
- : function (o, m, k, k2) {
24
- if (k2 === undefined) k2 = k;
25
- o[k2] = m[k];
26
- });
27
- var __exportStar =
28
- (this && this.__exportStar) ||
29
- function (m, exports) {
30
- for (var p in m)
31
- if (
32
- p !== 'default' &&
33
- !Object.prototype.hasOwnProperty.call(exports, p)
34
- )
35
- __createBinding(exports, m, p);
36
- };
37
- Object.defineProperty(exports, '__esModule', { value: true });
38
- exports.initEccLib =
39
- exports.Transaction =
40
- exports.opcodes =
41
- exports.Block =
42
- exports.script =
43
- exports.payments =
44
- exports.networks =
45
- exports.crypto =
46
- exports.address =
47
- void 0;
48
- const address = require('./address');
49
- exports.address = address;
50
- const crypto = require('./crypto');
51
- exports.crypto = crypto;
52
- const networks = require('./networks');
53
- exports.networks = networks;
54
- const payments = require('./payments');
55
- exports.payments = payments;
56
- const script = require('./script');
57
- exports.script = script;
58
- var block_1 = require('./block');
59
- Object.defineProperty(exports, 'Block', {
60
- enumerable: true,
61
- get: function () {
62
- return block_1.Block;
63
- },
64
- });
65
- __exportStar(require('./psbt'), exports);
66
- /** @hidden */
67
- var ops_1 = require('./ops');
68
- Object.defineProperty(exports, 'opcodes', {
69
- enumerable: true,
70
- get: function () {
71
- return ops_1.OPS;
72
- },
73
- });
74
- var transaction_1 = require('./transaction');
75
- Object.defineProperty(exports, 'Transaction', {
76
- enumerable: true,
77
- get: function () {
78
- return transaction_1.Transaction;
79
- },
80
- });
81
- var ecc_lib_1 = require('./ecc_lib');
82
- Object.defineProperty(exports, 'initEccLib', {
83
- enumerable: true,
84
- get: function () {
85
- return ecc_lib_1.initEccLib;
86
- },
87
- });
package/src/merkle.d.ts DELETED
@@ -1,10 +0,0 @@
1
- /// <reference types="node" />
2
- /**
3
- * Calculates the Merkle root of an array of buffers using a specified digest function.
4
- *
5
- * @param values - The array of buffers.
6
- * @param digestFn - The digest function used to calculate the hash of the concatenated buffers.
7
- * @returns The Merkle root as a buffer.
8
- * @throws {TypeError} If the values parameter is not an array or the digestFn parameter is not a function.
9
- */
10
- export declare function fastMerkleRoot(values: Buffer[], digestFn: (b: Buffer) => Buffer): Buffer;
package/src/networks.d.ts DELETED
@@ -1,29 +0,0 @@
1
- /**
2
- * Represents a Bitcoin network configuration,including messagePrefix, bech32, bip32, pubKeyHash, scriptHash, wif.
3
- * Support bitcoin、bitcoin testnet and bitcoin regtest.
4
- * @packageDocumentation
5
- */
6
- export interface Bip32 {
7
- public: number;
8
- private: number;
9
- }
10
- export interface Network {
11
- wif: number;
12
- bip32: Bip32;
13
- messagePrefix: string;
14
- bech32: string;
15
- pubKeyHash: number;
16
- scriptHash: number;
17
- }
18
- /**
19
- * Represents the Bitcoin network configuration.
20
- */
21
- export declare const bitcoin: Network;
22
- /**
23
- * Represents the regtest network configuration.
24
- */
25
- export declare const regtest: Network;
26
- /**
27
- * Represents the testnet network configuration.
28
- */
29
- export declare const testnet: Network;
package/src/networks.js DELETED
@@ -1,71 +0,0 @@
1
- 'use strict';
2
- // https://en.bitcoin.it/wiki/List_of_address_prefixes
3
- // Dogecoin BIP32 is a proposed standard: https://bitcointalk.org/index.php?topic=409731
4
- Object.defineProperty(exports, '__esModule', { value: true });
5
- exports.testnet = exports.regtest = exports.bitcoin = void 0;
6
- /**
7
- * Represents the Bitcoin network configuration.
8
- */
9
- exports.bitcoin = {
10
- /**
11
- * The message prefix used for signing Bitcoin messages.
12
- */
13
- messagePrefix: '\x18Bitcoin Signed Message:\n',
14
- /**
15
- * The Bech32 prefix used for Bitcoin addresses.
16
- */
17
- bech32: 'bc',
18
- /**
19
- * The BIP32 key prefixes for Bitcoin.
20
- */
21
- bip32: {
22
- /**
23
- * The public key prefix for BIP32 extended public keys.
24
- */
25
- public: 0x0488b21e,
26
- /**
27
- * The private key prefix for BIP32 extended private keys.
28
- */
29
- private: 0x0488ade4,
30
- },
31
- /**
32
- * The prefix for Bitcoin public key hashes.
33
- */
34
- pubKeyHash: 0x00,
35
- /**
36
- * The prefix for Bitcoin script hashes.
37
- */
38
- scriptHash: 0x05,
39
- /**
40
- * The prefix for Bitcoin Wallet Import Format (WIF) private keys.
41
- */
42
- wif: 0x80,
43
- };
44
- /**
45
- * Represents the regtest network configuration.
46
- */
47
- exports.regtest = {
48
- messagePrefix: '\x18Bitcoin Signed Message:\n',
49
- bech32: 'bcrt',
50
- bip32: {
51
- public: 0x043587cf,
52
- private: 0x04358394,
53
- },
54
- pubKeyHash: 0x6f,
55
- scriptHash: 0xc4,
56
- wif: 0xef,
57
- };
58
- /**
59
- * Represents the testnet network configuration.
60
- */
61
- exports.testnet = {
62
- messagePrefix: '\x18Bitcoin Signed Message:\n',
63
- bech32: 'tb',
64
- bip32: {
65
- public: 0x043587cf,
66
- private: 0x04358394,
67
- },
68
- pubKeyHash: 0x6f,
69
- scriptHash: 0xc4,
70
- wif: 0xef,
71
- };
@@ -1,49 +0,0 @@
1
- /// <reference types="node" />
2
- import { Tapleaf, Taptree } from '../types';
3
- export declare const LEAF_VERSION_TAPSCRIPT = 192;
4
- export declare const MAX_TAPTREE_DEPTH = 128;
5
- interface HashLeaf {
6
- hash: Buffer;
7
- }
8
- interface HashBranch {
9
- hash: Buffer;
10
- left: HashTree;
11
- right: HashTree;
12
- }
13
- interface TweakedPublicKey {
14
- parity: number;
15
- x: Buffer;
16
- }
17
- /**
18
- * Binary tree representing leaf, branch, and root node hashes of a Taptree.
19
- * Each node contains a hash, and potentially left and right branch hashes.
20
- * This tree is used for 2 purposes: Providing the root hash for tweaking,
21
- * and calculating merkle inclusion proofs when constructing a control block.
22
- */
23
- export type HashTree = HashLeaf | HashBranch;
24
- /**
25
- * Calculates the root hash from a given control block and leaf hash.
26
- * @param controlBlock - The control block buffer.
27
- * @param leafHash - The leaf hash buffer.
28
- * @returns The root hash buffer.
29
- * @throws {TypeError} If the control block length is less than 33.
30
- */
31
- export declare function rootHashFromPath(controlBlock: Buffer, leafHash: Buffer): Buffer;
32
- /**
33
- * Build a hash tree of merkle nodes from the scripts binary tree.
34
- * @param scriptTree - the tree of scripts to pairwise hash.
35
- */
36
- export declare function toHashTree(scriptTree: Taptree): HashTree;
37
- /**
38
- * Given a HashTree, finds the path from a particular hash to the root.
39
- * @param node - the root of the tree
40
- * @param hash - the hash to search for
41
- * @returns - array of sibling hashes, from leaf (inclusive) to root
42
- * (exclusive) needed to prove inclusion of the specified hash. undefined if no
43
- * path is found
44
- */
45
- export declare function findScriptPath(node: HashTree, hash: Buffer): Buffer[] | undefined;
46
- export declare function tapleafHash(leaf: Tapleaf): Buffer;
47
- export declare function tapTweakHash(pubKey: Buffer, h: Buffer | undefined): Buffer;
48
- export declare function tweakKey(pubKey: Buffer, h: Buffer | undefined): TweakedPublicKey | null;
49
- export {};
@@ -1,124 +0,0 @@
1
- 'use strict';
2
- Object.defineProperty(exports, '__esModule', { value: true });
3
- exports.tweakKey =
4
- exports.tapTweakHash =
5
- exports.tapleafHash =
6
- exports.findScriptPath =
7
- exports.toHashTree =
8
- exports.rootHashFromPath =
9
- exports.MAX_TAPTREE_DEPTH =
10
- exports.LEAF_VERSION_TAPSCRIPT =
11
- void 0;
12
- const buffer_1 = require('buffer');
13
- const ecc_lib_1 = require('../ecc_lib');
14
- const bcrypto = require('../crypto');
15
- const bufferutils_1 = require('../bufferutils');
16
- const types_1 = require('../types');
17
- exports.LEAF_VERSION_TAPSCRIPT = 0xc0;
18
- exports.MAX_TAPTREE_DEPTH = 128;
19
- const isHashBranch = ht => 'left' in ht && 'right' in ht;
20
- /**
21
- * Calculates the root hash from a given control block and leaf hash.
22
- * @param controlBlock - The control block buffer.
23
- * @param leafHash - The leaf hash buffer.
24
- * @returns The root hash buffer.
25
- * @throws {TypeError} If the control block length is less than 33.
26
- */
27
- function rootHashFromPath(controlBlock, leafHash) {
28
- if (controlBlock.length < 33)
29
- throw new TypeError(
30
- `The control-block length is too small. Got ${controlBlock.length}, expected min 33.`,
31
- );
32
- const m = (controlBlock.length - 33) / 32;
33
- let kj = leafHash;
34
- for (let j = 0; j < m; j++) {
35
- const ej = controlBlock.slice(33 + 32 * j, 65 + 32 * j);
36
- if (kj.compare(ej) < 0) {
37
- kj = tapBranchHash(kj, ej);
38
- } else {
39
- kj = tapBranchHash(ej, kj);
40
- }
41
- }
42
- return kj;
43
- }
44
- exports.rootHashFromPath = rootHashFromPath;
45
- /**
46
- * Build a hash tree of merkle nodes from the scripts binary tree.
47
- * @param scriptTree - the tree of scripts to pairwise hash.
48
- */
49
- function toHashTree(scriptTree) {
50
- if ((0, types_1.isTapleaf)(scriptTree))
51
- return { hash: tapleafHash(scriptTree) };
52
- const hashes = [toHashTree(scriptTree[0]), toHashTree(scriptTree[1])];
53
- hashes.sort((a, b) => a.hash.compare(b.hash));
54
- const [left, right] = hashes;
55
- return {
56
- hash: tapBranchHash(left.hash, right.hash),
57
- left,
58
- right,
59
- };
60
- }
61
- exports.toHashTree = toHashTree;
62
- /**
63
- * Given a HashTree, finds the path from a particular hash to the root.
64
- * @param node - the root of the tree
65
- * @param hash - the hash to search for
66
- * @returns - array of sibling hashes, from leaf (inclusive) to root
67
- * (exclusive) needed to prove inclusion of the specified hash. undefined if no
68
- * path is found
69
- */
70
- function findScriptPath(node, hash) {
71
- if (isHashBranch(node)) {
72
- const leftPath = findScriptPath(node.left, hash);
73
- if (leftPath !== undefined) return [...leftPath, node.right.hash];
74
- const rightPath = findScriptPath(node.right, hash);
75
- if (rightPath !== undefined) return [...rightPath, node.left.hash];
76
- } else if (node.hash.equals(hash)) {
77
- return [];
78
- }
79
- return undefined;
80
- }
81
- exports.findScriptPath = findScriptPath;
82
- function tapleafHash(leaf) {
83
- const version = leaf.version || exports.LEAF_VERSION_TAPSCRIPT;
84
- return bcrypto.taggedHash(
85
- 'TapLeaf',
86
- buffer_1.Buffer.concat([
87
- buffer_1.Buffer.from([version]),
88
- serializeScript(leaf.output),
89
- ]),
90
- );
91
- }
92
- exports.tapleafHash = tapleafHash;
93
- function tapTweakHash(pubKey, h) {
94
- return bcrypto.taggedHash(
95
- 'TapTweak',
96
- buffer_1.Buffer.concat(h ? [pubKey, h] : [pubKey]),
97
- );
98
- }
99
- exports.tapTweakHash = tapTweakHash;
100
- function tweakKey(pubKey, h) {
101
- if (!buffer_1.Buffer.isBuffer(pubKey)) return null;
102
- if (pubKey.length !== 32) return null;
103
- if (h && h.length !== 32) return null;
104
- const tweakHash = tapTweakHash(pubKey, h);
105
- const res = (0, ecc_lib_1.getEccLib)().xOnlyPointAddTweak(
106
- pubKey,
107
- tweakHash,
108
- );
109
- if (!res || res.xOnlyPubkey === null) return null;
110
- return {
111
- parity: res.parity,
112
- x: buffer_1.Buffer.from(res.xOnlyPubkey),
113
- };
114
- }
115
- exports.tweakKey = tweakKey;
116
- function tapBranchHash(a, b) {
117
- return bcrypto.taggedHash('TapBranch', buffer_1.Buffer.concat([a, b]));
118
- }
119
- function serializeScript(s) {
120
- const varintLen = bufferutils_1.varuint.encodingLength(s.length);
121
- const buffer = buffer_1.Buffer.allocUnsafe(varintLen); // better
122
- bufferutils_1.varuint.encode(s.length, buffer);
123
- return buffer_1.Buffer.concat([buffer, s]);
124
- }
@@ -1,9 +0,0 @@
1
- import { Payment, PaymentOpts } from './index';
2
- /**
3
- * Embeds data in a Bitcoin payment.
4
- * @param a - The payment object.
5
- * @param opts - Optional payment options.
6
- * @returns The modified payment object.
7
- * @throws {TypeError} If there is not enough data or if the output is invalid.
8
- */
9
- export declare function p2data(a: Payment, opts?: PaymentOpts): Payment;
@@ -1,54 +0,0 @@
1
- 'use strict';
2
- Object.defineProperty(exports, '__esModule', { value: true });
3
- exports.p2data = void 0;
4
- const networks_1 = require('../networks');
5
- const bscript = require('../script');
6
- const types_1 = require('../types');
7
- const lazy = require('./lazy');
8
- const OPS = bscript.OPS;
9
- // output: OP_RETURN ...
10
- /**
11
- * Embeds data in a Bitcoin payment.
12
- * @param a - The payment object.
13
- * @param opts - Optional payment options.
14
- * @returns The modified payment object.
15
- * @throws {TypeError} If there is not enough data or if the output is invalid.
16
- */
17
- function p2data(a, opts) {
18
- if (!a.data && !a.output) throw new TypeError('Not enough data');
19
- opts = Object.assign({ validate: true }, opts || {});
20
- (0, types_1.typeforce)(
21
- {
22
- network: types_1.typeforce.maybe(types_1.typeforce.Object),
23
- output: types_1.typeforce.maybe(types_1.typeforce.Buffer),
24
- data: types_1.typeforce.maybe(
25
- types_1.typeforce.arrayOf(types_1.typeforce.Buffer),
26
- ),
27
- },
28
- a,
29
- );
30
- const network = a.network || networks_1.bitcoin;
31
- const o = { name: 'embed', network };
32
- lazy.prop(o, 'output', () => {
33
- if (!a.data) return;
34
- return bscript.compile([OPS.OP_RETURN].concat(a.data));
35
- });
36
- lazy.prop(o, 'data', () => {
37
- if (!a.output) return;
38
- return bscript.decompile(a.output).slice(1);
39
- });
40
- // extended validation
41
- if (opts.validate) {
42
- if (a.output) {
43
- const chunks = bscript.decompile(a.output);
44
- if (chunks[0] !== OPS.OP_RETURN)
45
- throw new TypeError('Output is invalid');
46
- if (!chunks.slice(1).every(types_1.typeforce.Buffer))
47
- throw new TypeError('Output is invalid');
48
- if (a.data && !(0, types_1.stacksEqual)(a.data, o.data))
49
- throw new TypeError('Data mismatch');
50
- }
51
- }
52
- return Object.assign(o, a);
53
- }
54
- exports.p2data = p2data;
@@ -1,69 +0,0 @@
1
- 'use strict';
2
- Object.defineProperty(exports, '__esModule', { value: true });
3
- exports.p2tr =
4
- exports.p2wsh =
5
- exports.p2wpkh =
6
- exports.p2sh =
7
- exports.p2pkh =
8
- exports.p2pk =
9
- exports.p2ms =
10
- exports.embed =
11
- void 0;
12
- const embed_1 = require('./embed');
13
- Object.defineProperty(exports, 'embed', {
14
- enumerable: true,
15
- get: function () {
16
- return embed_1.p2data;
17
- },
18
- });
19
- const p2ms_1 = require('./p2ms');
20
- Object.defineProperty(exports, 'p2ms', {
21
- enumerable: true,
22
- get: function () {
23
- return p2ms_1.p2ms;
24
- },
25
- });
26
- const p2pk_1 = require('./p2pk');
27
- Object.defineProperty(exports, 'p2pk', {
28
- enumerable: true,
29
- get: function () {
30
- return p2pk_1.p2pk;
31
- },
32
- });
33
- const p2pkh_1 = require('./p2pkh');
34
- Object.defineProperty(exports, 'p2pkh', {
35
- enumerable: true,
36
- get: function () {
37
- return p2pkh_1.p2pkh;
38
- },
39
- });
40
- const p2sh_1 = require('./p2sh');
41
- Object.defineProperty(exports, 'p2sh', {
42
- enumerable: true,
43
- get: function () {
44
- return p2sh_1.p2sh;
45
- },
46
- });
47
- const p2wpkh_1 = require('./p2wpkh');
48
- Object.defineProperty(exports, 'p2wpkh', {
49
- enumerable: true,
50
- get: function () {
51
- return p2wpkh_1.p2wpkh;
52
- },
53
- });
54
- const p2wsh_1 = require('./p2wsh');
55
- Object.defineProperty(exports, 'p2wsh', {
56
- enumerable: true,
57
- get: function () {
58
- return p2wsh_1.p2wsh;
59
- },
60
- });
61
- const p2tr_1 = require('./p2tr');
62
- Object.defineProperty(exports, 'p2tr', {
63
- enumerable: true,
64
- get: function () {
65
- return p2tr_1.p2tr;
66
- },
67
- });
68
- // TODO
69
- // witness commitment
@@ -1,9 +0,0 @@
1
- import { Payment, PaymentOpts } from './index';
2
- /**
3
- * Represents a function that creates a Pay-to-Multisig (P2MS) payment object.
4
- * @param a - The payment object.
5
- * @param opts - Optional payment options.
6
- * @returns The created payment object.
7
- * @throws {TypeError} If the provided data is not valid.
8
- */
9
- export declare function p2ms(a: Payment, opts?: PaymentOpts): Payment;
@@ -1,10 +0,0 @@
1
- import { Payment, PaymentOpts } from './index';
2
- /**
3
- * Creates a pay-to-public-key (P2PK) payment object.
4
- *
5
- * @param a - The payment object containing the necessary data.
6
- * @param opts - Optional payment options.
7
- * @returns The P2PK payment object.
8
- * @throws {TypeError} If the required data is not provided or if the data is invalid.
9
- */
10
- export declare function p2pk(a: Payment, opts?: PaymentOpts): Payment;
@@ -1,10 +0,0 @@
1
- import { Payment, PaymentOpts } from './index';
2
- /**
3
- * Creates a Pay-to-Public-Key-Hash (P2PKH) payment object.
4
- *
5
- * @param a - The payment object containing the necessary data.
6
- * @param opts - Optional payment options.
7
- * @returns The P2PKH payment object.
8
- * @throws {TypeError} If the required data is not provided or if the data is invalid.
9
- */
10
- export declare function p2pkh(a: Payment, opts?: PaymentOpts): Payment;
@@ -1,10 +0,0 @@
1
- import { Payment, PaymentOpts } from './index';
2
- /**
3
- * Creates a Pay-to-Script-Hash (P2SH) payment object.
4
- *
5
- * @param a - The payment object containing the necessary data.
6
- * @param opts - Optional payment options.
7
- * @returns The P2SH payment object.
8
- * @throws {TypeError} If the required data is not provided or if the data is invalid.
9
- */
10
- export declare function p2sh(a: Payment, opts?: PaymentOpts): Payment;
@@ -1,10 +0,0 @@
1
- import { Payment, PaymentOpts } from './index';
2
- /**
3
- * Creates a Pay-to-Taproot (P2TR) payment object.
4
- *
5
- * @param a - The payment object containing the necessary data for P2TR.
6
- * @param opts - Optional payment options.
7
- * @returns The P2TR payment object.
8
- * @throws {TypeError} If the provided data is invalid or insufficient.
9
- */
10
- export declare function p2tr(a: Payment, opts?: PaymentOpts): Payment;
@@ -1,10 +0,0 @@
1
- import { Payment, PaymentOpts } from './index';
2
- /**
3
- * Creates a pay-to-witness-public-key-hash (p2wpkh) payment object.
4
- *
5
- * @param a - The payment object containing the necessary data.
6
- * @param opts - Optional payment options.
7
- * @returns The p2wpkh payment object.
8
- * @throws {TypeError} If the required data is missing or invalid.
9
- */
10
- export declare function p2wpkh(a: Payment, opts?: PaymentOpts): Payment;
@@ -1,10 +0,0 @@
1
- import { Payment, PaymentOpts } from './index';
2
- /**
3
- * Creates a Pay-to-Witness-Script-Hash (P2WSH) payment object.
4
- *
5
- * @param a - The payment object containing the necessary data.
6
- * @param opts - Optional payment options.
7
- * @returns The P2WSH payment object.
8
- * @throws {TypeError} If the required data is missing or invalid.
9
- */
10
- export declare function p2wsh(a: Payment, opts?: PaymentOpts): Payment;
@@ -1,42 +0,0 @@
1
- /// <reference types="node" />
2
- import { Taptree } from '../types';
3
- import { PsbtInput, PsbtOutput, TapLeaf } from 'bip174/src/lib/interfaces';
4
- export declare const toXOnly: (pubKey: Buffer) => Buffer;
5
- /**
6
- * Default tapscript finalizer. It searches for the `tapLeafHashToFinalize` if provided.
7
- * Otherwise it will search for the tapleaf that has at least one signature and has the shortest path.
8
- * @param inputIndex the position of the PSBT input.
9
- * @param input the PSBT input.
10
- * @param tapLeafHashToFinalize optional, if provided the finalizer will search for a tapleaf that has this hash
11
- * and will try to build the finalScriptWitness.
12
- * @returns the finalScriptWitness or throws an exception if no tapleaf found.
13
- */
14
- export declare function tapScriptFinalizer(inputIndex: number, input: PsbtInput, tapLeafHashToFinalize?: Buffer): {
15
- finalScriptWitness: Buffer | undefined;
16
- };
17
- export declare function serializeTaprootSignature(sig: Buffer, sighashType?: number): Buffer;
18
- export declare function isTaprootInput(input: PsbtInput): boolean;
19
- export declare function isTaprootOutput(output: PsbtOutput, script?: Buffer): boolean;
20
- export declare function checkTaprootInputFields(inputData: PsbtInput, newInputData: PsbtInput, action: string): void;
21
- export declare function checkTaprootOutputFields(outputData: PsbtOutput, newOutputData: PsbtOutput, action: string): void;
22
- export declare function tweakInternalPubKey(inputIndex: number, input: PsbtInput): Buffer;
23
- /**
24
- * Convert a binary tree to a BIP371 type list. Each element of the list is (according to BIP371):
25
- * One or more tuples representing the depth, leaf version, and script for a leaf in the Taproot tree,
26
- * allowing the entire tree to be reconstructed. The tuples must be in depth first search order so that
27
- * the tree is correctly reconstructed.
28
- * @param tree the binary tap tree
29
- * @returns a list of BIP 371 tapleaves
30
- */
31
- export declare function tapTreeToList(tree: Taptree): TapLeaf[];
32
- /**
33
- * Convert a BIP371 TapLeaf list to a TapTree (binary).
34
- * @param leaves a list of tapleaves where each element of the list is (according to BIP371):
35
- * One or more tuples representing the depth, leaf version, and script for a leaf in the Taproot tree,
36
- * allowing the entire tree to be reconstructed. The tuples must be in depth first search order so that
37
- * the tree is correctly reconstructed.
38
- * @returns the corresponding taptree, or throws an exception if the tree cannot be reconstructed
39
- */
40
- export declare function tapTreeFromList(leaves?: TapLeaf[]): Taptree;
41
- export declare function checkTaprootInputForSigs(input: PsbtInput, action: string): boolean;
42
- export declare function getTapKeySigFromWithness(finalScriptWitness?: Buffer): Buffer | undefined;