@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
@@ -1,235 +1,167 @@
1
- /// <reference types="node" />
2
- import { Psbt as PsbtBase } from 'bip174';
3
- import { KeyValue, PartialSig, PsbtGlobal, PsbtGlobalUpdate, PsbtInput, PsbtInputUpdate, PsbtOutput, PsbtOutputUpdate } from 'bip174/src/lib/interfaces';
4
- import { Network } from './networks';
5
- import { Transaction } from './transaction';
6
- import { BIP32Interface } from 'bip32';
7
- import { ECPairInterface } from 'ecpair';
8
- export interface TransactionInput {
9
- hash: string | Buffer;
10
- index: number;
11
- sequence?: number;
12
- }
13
- export interface PsbtTxInput extends TransactionInput {
14
- hash: Buffer;
15
- }
16
- export interface TransactionOutput {
17
- script: Buffer;
18
- value: number;
19
- }
20
- export interface PsbtTxOutput extends TransactionOutput {
21
- address: string | undefined;
22
- }
23
- export type ValidateSigFunction = (pubkey: Buffer, msghash: Buffer, signature: Buffer) => boolean;
24
- export interface PsbtBaseExtended extends Omit<PsbtBase, 'inputs'> {
25
- inputs: PsbtInput[];
26
- globalMap: PsbtGlobal;
27
- }
28
- /**
29
- * Psbt class can parse and generate a PSBT binary based off of the BIP174.
30
- * There are 6 roles that this class fulfills. (Explained in BIP174)
31
- *
32
- * Creator: This can be done with `new Psbt()`
33
- *
34
- * Updater: This can be done with `psbt.addInput(input)`, `psbt.addInputs(inputs)`,
35
- * `psbt.addOutput(output)`, `psbt.addOutputs(outputs)` when you are looking to
36
- * add new inputs and outputs to the PSBT, and `psbt.updateGlobal(itemObject)`,
37
- * `psbt.updateInput(itemObject)`, `psbt.updateOutput(itemObject)`
38
- * addInput requires hash: Buffer | string; and index: number; as attributes
39
- * and can also include any attributes that are used in updateInput method.
40
- * addOutput requires script: Buffer; and value: number; and likewise can include
41
- * data for updateOutput.
42
- * For a list of what attributes should be what types. Check the bip174 library.
43
- * Also, check the integration tests for some examples of usage.
44
- *
45
- * Signer: There are a few methods. signAllInputs and signAllInputsAsync, which will search all input
46
- * information for your pubkey or pubkeyhash, and only sign inputs where it finds
47
- * your info. Or you can explicitly sign a specific input with signInput and
48
- * signInputAsync. For the async methods you can create a SignerAsync object
49
- * and use something like a hardware wallet to sign with. (You must implement this)
50
- *
51
- * Combiner: psbts can be combined easily with `psbt.combine(psbt2, psbt3, psbt4 ...)`
52
- * the psbt calling combine will always have precedence when a conflict occurs.
53
- * Combine checks if the internal bitcoin transaction is the same, so be sure that
54
- * all sequences, version, locktime, etc. are the same before combining.
55
- *
56
- * Input Finalizer: This role is fairly important. Not only does it need to construct
57
- * the input scriptSigs and witnesses, but it SHOULD verify the signatures etc.
58
- * Before running `psbt.finalizeAllInputs()` please run `psbt.validateSignaturesOfAllInputs()`
59
- * Running any finalize method will delete any data in the input(s) that are no longer
60
- * needed due to the finalized scripts containing the information.
61
- *
62
- * Transaction Extractor: This role will perform some checks before returning a
63
- * Transaction object. Such as fee rate not being larger than maximumFeeRate etc.
64
- */
65
- /**
66
- * Psbt class can parse and generate a PSBT binary based off of the BIP174.
67
- */
68
- export declare class Psbt {
69
- data: PsbtBaseExtended;
70
- private readonly __CACHE;
71
- private readonly opts;
72
- constructor(opts?: PsbtOptsOptional, data?: PsbtBaseExtended);
73
- get inputCount(): number;
74
- get version(): number;
75
- set version(version: number);
76
- get locktime(): number;
77
- set locktime(locktime: number);
78
- get txInputs(): PsbtTxInput[];
79
- get txOutputs(): PsbtTxOutput[];
80
- static fromBase64(data: string, opts?: PsbtOptsOptional): Psbt;
81
- static fromHex(data: string, opts?: PsbtOptsOptional): Psbt;
82
- static fromBuffer(buffer: Buffer, opts?: PsbtOptsOptional): Psbt;
83
- combine(...those: Psbt[]): this;
84
- clone(): Psbt;
85
- setMaximumFeeRate(satoshiPerByte: number): void;
86
- setVersion(version: number): this;
87
- setLocktime(locktime: number): this;
88
- setInputSequence(inputIndex: number, sequence: number): this;
89
- addInputs(inputDatas: PsbtInputExtended[], checkPartialSigs?: boolean): this;
90
- addInput(inputData: PsbtInputExtended, checkPartialSigs?: boolean): this;
91
- addOutputs(outputDatas: PsbtOutputExtended[]): this;
92
- addOutput(outputData: PsbtOutputExtended): this;
93
- extractTransaction(disableFeeCheck?: boolean, disableOutputChecks?: boolean): Transaction;
94
- getFeeRate(disableOutputChecks?: boolean): number;
95
- getFee(disableOutputChecks?: boolean): number;
96
- finalizeAllInputs(): this;
97
- finalizeInput(inputIndex: number, finalScriptsFunc?: FinalScriptsFunc | FinalTaprootScriptsFunc): this;
98
- finalizeTaprootInput(inputIndex: number, tapLeafHashToFinalize?: Buffer, finalScriptsFunc?: FinalTaprootScriptsFunc): this;
99
- getInputType(inputIndex: number): AllScriptType;
100
- inputHasPubkey(inputIndex: number, pubkey: Buffer): boolean;
101
- inputHasHDKey(inputIndex: number, root: HDSigner): boolean;
102
- outputHasPubkey(outputIndex: number, pubkey: Buffer): boolean;
103
- outputHasHDKey(outputIndex: number, root: HDSigner): boolean;
104
- validateSignaturesOfAllInputs(validator: ValidateSigFunction): boolean;
105
- validateSignaturesOfInput(inputIndex: number, validator: ValidateSigFunction, pubkey?: Buffer): boolean;
106
- signAllInputsHD(hdKeyPair: HDSigner, sighashTypes?: number[]): this;
107
- signAllInputsHDAsync(hdKeyPair: HDSigner | HDSignerAsync, sighashTypes?: number[]): Promise<void>;
108
- signInputHD(inputIndex: number, hdKeyPair: HDSigner, sighashTypes?: number[]): this;
109
- signInputHDAsync(inputIndex: number, hdKeyPair: HDSigner | HDSignerAsync, sighashTypes?: number[]): Promise<void>;
110
- signAllInputs(keyPair: Signer | SignerAlternative | BIP32Interface | ECPairInterface, sighashTypes?: number[]): this;
111
- signAllInputsAsync(keyPair: Signer | SignerAlternative | SignerAsync | BIP32Interface | ECPairInterface, sighashTypes?: number[]): Promise<void>;
112
- signInput(inputIndex: number, keyPair: Signer | SignerAlternative | BIP32Interface | ECPairInterface, sighashTypes?: number[]): this;
113
- signTaprootInput(inputIndex: number, keyPair: Signer | SignerAlternative | BIP32Interface | ECPairInterface, tapLeafHashToSign?: Buffer, sighashTypes?: number[]): this;
114
- signInputAsync(inputIndex: number, keyPair: Signer | SignerAlternative | SignerAsync | BIP32Interface | ECPairInterface, sighashTypes?: number[]): Promise<void>;
115
- signTaprootInputAsync(inputIndex: number, keyPair: Signer | SignerAlternative | SignerAsync | BIP32Interface | ECPairInterface, tapLeafHash?: Buffer, sighashTypes?: number[]): Promise<void>;
116
- toBuffer(): Buffer;
117
- toHex(): string;
118
- toBase64(): string;
119
- updateGlobal(updateData: PsbtGlobalUpdate): this;
120
- updateInput(inputIndex: number, updateData: PsbtInputUpdate): this;
121
- updateOutput(outputIndex: number, updateData: PsbtOutputUpdate): this;
122
- addUnknownKeyValToGlobal(keyVal: KeyValue): this;
123
- addUnknownKeyValToInput(inputIndex: number, keyVal: KeyValue): this;
124
- addUnknownKeyValToOutput(outputIndex: number, keyVal: KeyValue): this;
125
- clearFinalizedInput(inputIndex: number): this;
126
- private _finalizeInput;
127
- private _finalizeTaprootInput;
128
- private _validateSignaturesOfInput;
129
- private validateSignaturesOfTaprootInput;
130
- private _signInput;
131
- private _signTaprootInput;
132
- private _signInputAsync;
133
- private _signTaprootInputAsync;
134
- private checkTaprootHashesForSig;
135
- }
136
- export interface PsbtOptsOptional {
137
- network?: Network;
138
- maximumFeeRate?: number;
139
- }
140
- export interface PsbtOpts {
141
- network: Network;
142
- maximumFeeRate: number;
143
- }
144
- export interface PsbtInputExtended extends PsbtInput, TransactionInput {
145
- }
146
- export type PsbtOutputExtended = PsbtOutputExtendedAddress | PsbtOutputExtendedScript;
147
- export interface PsbtOutputExtendedAddress extends PsbtOutput {
148
- address: string;
149
- value: number;
150
- }
151
- export interface PsbtOutputExtendedScript extends PsbtOutput {
152
- script: Buffer;
153
- value: number;
154
- }
155
- interface HDSignerBase {
156
- /**
157
- * DER format compressed publicKey buffer
158
- */
159
- publicKey: Buffer;
160
- /**
161
- * The first 4 bytes of the sha256-ripemd160 of the publicKey
162
- */
163
- fingerprint: Buffer;
164
- }
165
- export interface HDSigner extends HDSignerBase {
166
- /**
167
- * The path string must match /^m(\/\d+'?)+$/
168
- * ex. m/44'/0'/0'/1/23 levels with ' must be hard derivations
169
- */
170
- derivePath(path: string): HDSigner;
171
- /**
172
- * Input hash (the "message digest") for the signature algorithm
173
- * Return a 64 byte signature (32 byte r and 32 byte s in that order)
174
- */
175
- sign(hash: Buffer): Buffer;
176
- }
177
- /**
178
- * Same as above but with async sign method
179
- */
180
- export interface HDSignerAsync extends HDSignerBase {
181
- derivePath(path: string): HDSignerAsync;
182
- sign(hash: Buffer): Promise<Buffer>;
183
- }
184
- export interface SignerAlternative {
185
- publicKey: Buffer;
186
- lowR: boolean;
187
- sign(hash: Buffer, lowR?: boolean): Buffer;
188
- verify(hash: Buffer, signature: Buffer): boolean;
189
- signSchnorr(hash: Buffer): Buffer;
190
- verifySchnorr(hash: Buffer, signature: Buffer): boolean;
191
- }
192
- export interface Signer {
193
- publicKey: Buffer;
194
- network?: Network;
195
- sign(hash: Buffer, lowR?: boolean): Buffer;
196
- signSchnorr?(hash: Buffer): Buffer;
197
- getPublicKey?(): Buffer;
198
- }
199
- export interface SignerAsync {
200
- publicKey: Buffer;
201
- network?: Network;
202
- sign(hash: Buffer, lowR?: boolean): Promise<Buffer>;
203
- signSchnorr?(hash: Buffer): Promise<Buffer>;
204
- getPublicKey?(): Buffer;
205
- }
206
- /**
207
- * This function must do two things:
208
- * 1. Check if the `input` can be finalized. If it can not be finalized, throw.
209
- * ie. `Can not finalize input #${inputIndex}`
210
- * 2. Create the finalScriptSig and finalScriptWitness Buffers.
211
- */
212
- type FinalScriptsFunc = (inputIndex: number, // Which input is it?
213
- input: PsbtInput, // The PSBT input contents
214
- script: Buffer, // The "meaningful" locking script Buffer (redeemScript for P2SH etc.)
215
- isSegwit: boolean, // Is it segwit?
216
- isP2SH: boolean, // Is it P2SH?
217
- isP2WSH: boolean) => {
218
- finalScriptSig: Buffer | undefined;
219
- finalScriptWitness: Buffer | undefined;
220
- };
221
- type FinalTaprootScriptsFunc = (inputIndex: number, // Which input is it?
222
- input: PsbtInput, // The PSBT input contents
223
- tapLeafHashToFinalize?: Buffer) => {
224
- finalScriptWitness: Buffer | undefined;
225
- };
226
- export declare function getFinalScripts(inputIndex: number, input: PsbtInput, script: Buffer, isSegwit: boolean, isP2SH: boolean, isP2WSH: boolean): {
227
- finalScriptSig: Buffer | undefined;
228
- finalScriptWitness: Buffer | undefined;
229
- };
230
- export declare function prepareFinalScripts(script: Buffer, scriptType: string, partialSig: PartialSig[], isSegwit: boolean, isP2SH: boolean, isP2WSH: boolean): {
231
- finalScriptSig: Buffer | undefined;
232
- finalScriptWitness: Buffer | undefined;
233
- };
234
- type AllScriptType = 'witnesspubkeyhash' | 'pubkeyhash' | 'multisig' | 'pubkey' | 'nonstandard' | 'p2sh-witnesspubkeyhash' | 'p2sh-pubkeyhash' | 'p2sh-multisig' | 'p2sh-pubkey' | 'p2sh-nonstandard' | 'p2wsh-pubkeyhash' | 'p2wsh-multisig' | 'p2wsh-pubkey' | 'p2wsh-nonstandard' | 'p2sh-p2wsh-pubkeyhash' | 'p2sh-p2wsh-multisig' | 'p2sh-p2wsh-pubkey' | 'p2sh-p2wsh-nonstandard';
235
- export {};
1
+ import { Psbt as PsbtBase } from 'bip174';
2
+ import { KeyValue, PartialSig, PsbtGlobal, PsbtGlobalUpdate, PsbtInput, PsbtInputUpdate, PsbtOutput, PsbtOutputUpdate } from 'bip174/src/lib/interfaces.js';
3
+ import { BIP32Interface } from 'bip32';
4
+ import { ECPairInterface } from 'ecpair';
5
+ import { Network } from './networks.js';
6
+ import { Transaction } from './transaction.js';
7
+ export interface TransactionInput {
8
+ hash: string | Buffer;
9
+ index: number;
10
+ sequence?: number;
11
+ }
12
+ export interface PsbtTxInput extends TransactionInput {
13
+ hash: Buffer;
14
+ }
15
+ export interface TransactionOutput {
16
+ script: Buffer;
17
+ value: number;
18
+ }
19
+ export interface PsbtTxOutput extends TransactionOutput {
20
+ address: string | undefined;
21
+ }
22
+ export type ValidateSigFunction = (pubkey: Buffer, msghash: Buffer, signature: Buffer) => boolean;
23
+ export interface PsbtBaseExtended extends Omit<PsbtBase, 'inputs'> {
24
+ inputs: PsbtInput[];
25
+ globalMap: PsbtGlobal;
26
+ }
27
+ export declare class Psbt {
28
+ data: PsbtBaseExtended;
29
+ private readonly __CACHE;
30
+ private readonly opts;
31
+ constructor(opts?: PsbtOptsOptional, data?: PsbtBaseExtended);
32
+ get inputCount(): number;
33
+ get version(): number;
34
+ set version(version: number);
35
+ get locktime(): number;
36
+ set locktime(locktime: number);
37
+ get txInputs(): PsbtTxInput[];
38
+ get txOutputs(): PsbtTxOutput[];
39
+ static fromBase64(data: string, opts?: PsbtOptsOptional): Psbt;
40
+ static fromHex(data: string, opts?: PsbtOptsOptional): Psbt;
41
+ static fromBuffer(buffer: Buffer, opts?: PsbtOptsOptional): Psbt;
42
+ combine(...those: Psbt[]): this;
43
+ clone(): Psbt;
44
+ setMaximumFeeRate(satoshiPerByte: number): void;
45
+ setVersion(version: number): this;
46
+ setLocktime(locktime: number): this;
47
+ setInputSequence(inputIndex: number, sequence: number): this;
48
+ addInputs(inputDatas: PsbtInputExtended[], checkPartialSigs?: boolean): this;
49
+ addInput(inputData: PsbtInputExtended, checkPartialSigs?: boolean): this;
50
+ addOutputs(outputDatas: PsbtOutputExtended[]): this;
51
+ addOutput(outputData: PsbtOutputExtended): this;
52
+ extractTransaction(disableFeeCheck?: boolean, disableOutputChecks?: boolean): Transaction;
53
+ getFeeRate(disableOutputChecks?: boolean): number;
54
+ getFee(disableOutputChecks?: boolean): number;
55
+ finalizeAllInputs(): this;
56
+ finalizeInput(inputIndex: number, finalScriptsFunc?: FinalScriptsFunc | FinalTaprootScriptsFunc): this;
57
+ finalizeTaprootInput(inputIndex: number, tapLeafHashToFinalize?: Buffer, finalScriptsFunc?: FinalTaprootScriptsFunc): this;
58
+ getInputType(inputIndex: number): AllScriptType;
59
+ inputHasPubkey(inputIndex: number, pubkey: Buffer): boolean;
60
+ inputHasHDKey(inputIndex: number, root: HDSigner): boolean;
61
+ outputHasPubkey(outputIndex: number, pubkey: Buffer): boolean;
62
+ outputHasHDKey(outputIndex: number, root: HDSigner): boolean;
63
+ validateSignaturesOfAllInputs(validator: ValidateSigFunction): boolean;
64
+ validateSignaturesOfInput(inputIndex: number, validator: ValidateSigFunction, pubkey?: Buffer): boolean;
65
+ signAllInputsHD(hdKeyPair: HDSigner, sighashTypes?: number[]): this;
66
+ signAllInputsHDAsync(hdKeyPair: HDSigner | HDSignerAsync, sighashTypes?: number[]): Promise<void>;
67
+ signInputHD(inputIndex: number, hdKeyPair: HDSigner, sighashTypes?: number[]): this;
68
+ signInputHDAsync(inputIndex: number, hdKeyPair: HDSigner | HDSignerAsync, sighashTypes?: number[]): Promise<void>;
69
+ signAllInputs(keyPair: Signer | SignerAlternative | BIP32Interface | ECPairInterface, sighashTypes?: number[]): this;
70
+ signAllInputsAsync(keyPair: Signer | SignerAlternative | SignerAsync | BIP32Interface | ECPairInterface, sighashTypes?: number[]): Promise<void>;
71
+ signInput(inputIndex: number, keyPair: Signer | SignerAlternative | BIP32Interface | ECPairInterface, sighashTypes?: number[]): this;
72
+ signTaprootInput(inputIndex: number, keyPair: Signer | SignerAlternative | BIP32Interface | ECPairInterface, tapLeafHashToSign?: Buffer, sighashTypes?: number[]): this;
73
+ signInputAsync(inputIndex: number, keyPair: Signer | SignerAlternative | SignerAsync | BIP32Interface | ECPairInterface, sighashTypes?: number[]): Promise<void>;
74
+ signTaprootInputAsync(inputIndex: number, keyPair: Signer | SignerAlternative | SignerAsync | BIP32Interface | ECPairInterface, tapLeafHash?: Buffer, sighashTypes?: number[]): Promise<void>;
75
+ toBuffer(): Buffer;
76
+ toHex(): string;
77
+ toBase64(): string;
78
+ updateGlobal(updateData: PsbtGlobalUpdate): this;
79
+ updateInput(inputIndex: number, updateData: PsbtInputUpdate): this;
80
+ updateOutput(outputIndex: number, updateData: PsbtOutputUpdate): this;
81
+ addUnknownKeyValToGlobal(keyVal: KeyValue): this;
82
+ addUnknownKeyValToInput(inputIndex: number, keyVal: KeyValue): this;
83
+ addUnknownKeyValToOutput(outputIndex: number, keyVal: KeyValue): this;
84
+ clearFinalizedInput(inputIndex: number): this;
85
+ checkTaprootHashesForSig(inputIndex: number, input: PsbtInput, keyPair: Signer | SignerAlternative | SignerAsync | BIP32Interface | ECPairInterface, tapLeafHashToSign?: Buffer, allowedSighashTypes?: number[]): {
86
+ hash: Buffer;
87
+ leafHash?: Buffer;
88
+ }[];
89
+ private _finalizeInput;
90
+ private _finalizeTaprootInput;
91
+ private _validateSignaturesOfInput;
92
+ private validateSignaturesOfTaprootInput;
93
+ private _signInput;
94
+ private _signTaprootInput;
95
+ private _signInputAsync;
96
+ private _signTaprootInputAsync;
97
+ }
98
+ export interface PsbtOptsOptional {
99
+ network?: Network;
100
+ maximumFeeRate?: number;
101
+ }
102
+ export interface PsbtOpts {
103
+ network: Network;
104
+ maximumFeeRate: number;
105
+ }
106
+ export interface PsbtInputExtended extends PsbtInput, TransactionInput {
107
+ }
108
+ export type PsbtOutputExtended = PsbtOutputExtendedAddress | PsbtOutputExtendedScript;
109
+ export interface PsbtOutputExtendedAddress extends PsbtOutput {
110
+ address: string;
111
+ value: number;
112
+ }
113
+ export interface PsbtOutputExtendedScript extends PsbtOutput {
114
+ script: Buffer;
115
+ value: number;
116
+ }
117
+ interface HDSignerBase {
118
+ publicKey: Buffer;
119
+ fingerprint: Buffer;
120
+ }
121
+ export interface HDSigner extends HDSignerBase {
122
+ derivePath(path: string): HDSigner;
123
+ sign(hash: Buffer): Buffer;
124
+ }
125
+ export interface HDSignerAsync extends HDSignerBase {
126
+ derivePath(path: string): HDSignerAsync;
127
+ sign(hash: Buffer): Promise<Buffer>;
128
+ }
129
+ export interface SignerAlternative {
130
+ publicKey: Buffer;
131
+ lowR: boolean;
132
+ sign(hash: Buffer, lowR?: boolean): Buffer;
133
+ verify(hash: Buffer, signature: Buffer): boolean;
134
+ signSchnorr(hash: Buffer): Buffer;
135
+ verifySchnorr(hash: Buffer, signature: Buffer): boolean;
136
+ }
137
+ export interface Signer {
138
+ publicKey: Buffer;
139
+ network?: Network;
140
+ sign(hash: Buffer, lowR?: boolean): Buffer;
141
+ signSchnorr?(hash: Buffer): Buffer;
142
+ getPublicKey?(): Buffer;
143
+ }
144
+ export interface SignerAsync {
145
+ publicKey: Buffer;
146
+ network?: Network;
147
+ sign(hash: Buffer, lowR?: boolean): Promise<Buffer>;
148
+ signSchnorr?(hash: Buffer): Promise<Buffer>;
149
+ getPublicKey?(): Buffer;
150
+ }
151
+ type FinalScriptsFunc = (inputIndex: number, input: PsbtInput, script: Buffer, isSegwit: boolean, isP2SH: boolean, isP2WSH: boolean) => {
152
+ finalScriptSig: Buffer | undefined;
153
+ finalScriptWitness: Buffer | undefined;
154
+ };
155
+ type FinalTaprootScriptsFunc = (inputIndex: number, input: PsbtInput, tapLeafHashToFinalize?: Buffer) => {
156
+ finalScriptWitness: Buffer | undefined;
157
+ };
158
+ export declare function getFinalScripts(inputIndex: number, input: PsbtInput, script: Buffer, isSegwit: boolean, isP2SH: boolean, isP2WSH: boolean): {
159
+ finalScriptSig: Buffer | undefined;
160
+ finalScriptWitness: Buffer | undefined;
161
+ };
162
+ export declare function prepareFinalScripts(script: Buffer, scriptType: string, partialSig: PartialSig[], isSegwit: boolean, isP2SH: boolean, isP2WSH: boolean): {
163
+ finalScriptSig: Buffer | undefined;
164
+ finalScriptWitness: Buffer | undefined;
165
+ };
166
+ type AllScriptType = 'witnesspubkeyhash' | 'pubkeyhash' | 'multisig' | 'pubkey' | 'nonstandard' | 'p2sh-witnesspubkeyhash' | 'p2sh-pubkeyhash' | 'p2sh-multisig' | 'p2sh-pubkey' | 'p2sh-nonstandard' | 'p2wsh-pubkeyhash' | 'p2wsh-multisig' | 'p2wsh-pubkey' | 'p2wsh-nonstandard' | 'p2sh-p2wsh-pubkeyhash' | 'p2sh-p2wsh-multisig' | 'p2sh-p2wsh-pubkey' | 'p2sh-p2wsh-nonstandard';
167
+ export {};
@@ -0,0 +1,7 @@
1
+ export declare function encodingLength(i: number): number;
2
+ export declare function encode(buffer: Buffer, num: number, offset: number): number;
3
+ export declare function decode(buffer: Buffer, offset: number): {
4
+ opcode: number;
5
+ number: number;
6
+ size: number;
7
+ } | null;
@@ -0,0 +1,17 @@
1
+ import { OPS } from './ops.js';
2
+ import { Stack } from './payments/index.js';
3
+ import * as scriptNumber from './script_number.js';
4
+ import * as scriptSignature from './script_signature.js';
5
+ export { OPS };
6
+ export declare function isPushOnly(value: Stack): boolean;
7
+ export declare function countNonPushOnlyOPs(value: Stack): number;
8
+ export declare function compile(chunks: Buffer | Stack): Buffer;
9
+ export declare function decompile(buffer: Buffer | Array<number | Buffer>): Array<number | Buffer> | null;
10
+ export declare function toASM(chunks: Buffer | Array<number | Buffer>): string;
11
+ export declare function fromASM(asm: string): Buffer;
12
+ export declare function toStack(chunks: Buffer | Array<number | Buffer>): Buffer[];
13
+ export declare function isCanonicalPubKey(buffer: Buffer): boolean;
14
+ export declare function isDefinedHashType(hashType: number): boolean;
15
+ export declare function isCanonicalScriptSignature(buffer: Buffer): boolean;
16
+ export declare const number: typeof scriptNumber;
17
+ export declare const signature: typeof scriptSignature;
@@ -0,0 +1,2 @@
1
+ export declare function decode(buffer: Buffer, maxLength?: number, minimal?: boolean): number;
2
+ export declare function encode(_number: number): Buffer;
@@ -0,0 +1,7 @@
1
+ interface ScriptSignature {
2
+ signature: Buffer;
3
+ hashType: number;
4
+ }
5
+ export declare function decode(buffer: Buffer): ScriptSignature;
6
+ export declare function encode(signature: Buffer, hashType: number): Buffer;
7
+ export {};
@@ -1,60 +1,48 @@
1
- /// <reference types="node" />
2
- export interface Output {
3
- script: Buffer;
4
- value: number;
5
- }
6
- export interface Input {
7
- hash: Buffer;
8
- index: number;
9
- script: Buffer;
10
- sequence: number;
11
- witness: Buffer[];
12
- }
13
- /**
14
- * Represents a Bitcoin transaction.
15
- */
16
- export declare class Transaction {
17
- static readonly DEFAULT_SEQUENCE = 4294967295;
18
- static readonly SIGHASH_DEFAULT = 0;
19
- static readonly SIGHASH_ALL = 1;
20
- static readonly SIGHASH_NONE = 2;
21
- static readonly SIGHASH_SINGLE = 3;
22
- static readonly SIGHASH_ANYONECANPAY = 128;
23
- static readonly SIGHASH_OUTPUT_MASK = 3;
24
- static readonly SIGHASH_INPUT_MASK = 128;
25
- static readonly ADVANCED_TRANSACTION_MARKER = 0;
26
- static readonly ADVANCED_TRANSACTION_FLAG = 1;
27
- version: number;
28
- locktime: number;
29
- ins: Input[];
30
- outs: Output[];
31
- static fromBuffer(buffer: Buffer, _NO_STRICT?: boolean): Transaction;
32
- static fromHex(hex: string): Transaction;
33
- static isCoinbaseHash(buffer: Buffer): boolean;
34
- isCoinbase(): boolean;
35
- addInput(hash: Buffer, index: number, sequence?: number, scriptSig?: Buffer): number;
36
- addOutput(scriptPubKey: Buffer, value: number): number;
37
- hasWitnesses(): boolean;
38
- weight(): number;
39
- virtualSize(): number;
40
- byteLength(_ALLOW_WITNESS?: boolean): number;
41
- clone(): Transaction;
42
- /**
43
- * Hash transaction for signing a specific input.
44
- *
45
- * Bitcoin uses a different hash for each signed transaction input.
46
- * This method copies the transaction, makes the necessary changes based on the
47
- * hashType, and then hashes the result.
48
- * This hash can then be used to sign the provided transaction input.
49
- */
50
- hashForSignature(inIndex: number, prevOutScript: Buffer, hashType: number): Buffer;
51
- hashForWitnessV1(inIndex: number, prevOutScripts: Buffer[], values: number[], hashType: number, leafHash?: Buffer, annex?: Buffer): Buffer;
52
- hashForWitnessV0(inIndex: number, prevOutScript: Buffer, value: number, hashType: number): Buffer;
53
- getHash(forWitness?: boolean): Buffer;
54
- getId(): string;
55
- toBuffer(buffer?: Buffer, initialOffset?: number): Buffer;
56
- toHex(): string;
57
- setInputScript(index: number, scriptSig: Buffer): void;
58
- setWitness(index: number, witness: Buffer[]): void;
59
- private __toBuffer;
60
- }
1
+ export interface Output {
2
+ script: Buffer;
3
+ value: number;
4
+ }
5
+ export interface Input {
6
+ hash: Buffer;
7
+ index: number;
8
+ script: Buffer;
9
+ sequence: number;
10
+ witness: Buffer[];
11
+ }
12
+ export declare class Transaction {
13
+ static readonly DEFAULT_SEQUENCE = 4294967295;
14
+ static readonly SIGHASH_DEFAULT = 0;
15
+ static readonly SIGHASH_ALL = 1;
16
+ static readonly SIGHASH_NONE = 2;
17
+ static readonly SIGHASH_SINGLE = 3;
18
+ static readonly SIGHASH_ANYONECANPAY = 128;
19
+ static readonly SIGHASH_OUTPUT_MASK = 3;
20
+ static readonly SIGHASH_INPUT_MASK = 128;
21
+ static readonly ADVANCED_TRANSACTION_MARKER = 0;
22
+ static readonly ADVANCED_TRANSACTION_FLAG = 1;
23
+ version: number;
24
+ locktime: number;
25
+ ins: Input[];
26
+ outs: Output[];
27
+ static fromBuffer(buffer: Buffer, _NO_STRICT?: boolean): Transaction;
28
+ static fromHex(hex: string): Transaction;
29
+ static isCoinbaseHash(buffer: Buffer): boolean;
30
+ isCoinbase(): boolean;
31
+ addInput(hash: Buffer, index: number, sequence?: number, scriptSig?: Buffer): number;
32
+ addOutput(scriptPubKey: Buffer, value: number): number;
33
+ hasWitnesses(): boolean;
34
+ weight(): number;
35
+ virtualSize(): number;
36
+ byteLength(_ALLOW_WITNESS?: boolean): number;
37
+ clone(): Transaction;
38
+ hashForSignature(inIndex: number, prevOutScript: Buffer, hashType: number): Buffer;
39
+ hashForWitnessV1(inIndex: number, prevOutScripts: Buffer[], values: number[], hashType: number, leafHash?: Buffer, annex?: Buffer): Buffer;
40
+ hashForWitnessV0(inIndex: number, prevOutScript: Buffer, value: number, hashType: number): Buffer;
41
+ getHash(forWitness?: boolean): Buffer;
42
+ getId(): string;
43
+ toBuffer(buffer?: Buffer, initialOffset?: number): Buffer;
44
+ toHex(): string;
45
+ setInputScript(index: number, scriptSig: Buffer): void;
46
+ setWitness(index: number, witness: Buffer[]): void;
47
+ private __toBuffer;
48
+ }