{"_id":"@arklabs/btc-signer","name":"@arklabs/btc-signer","dist-tags":{"latest":"1.6.0"},"versions":{"1.6.0":{"name":"@arklabs/btc-signer","version":"1.6.0","publishConfig":{"access":"public"},"description":"Audited & minimal library for Bitcoin. Handle transactions, Schnorr, Taproot, UTXO & PSBT","main":"./index.js","module":"./esm/index.js","types":"./index.d.ts","dependencies":{"@noble/curves":"~1.8.1","@noble/hashes":"~1.7.1","@scure/base":"~1.2.2","micro-packed":"~0.7.2"},"devDependencies":{"@paulmillr/jsbt":"0.3.1","@scure/bip32":"~1.6.1","micro-bmark":"0.4.0","micro-should":"0.5.1","prettier":"3.3.2","typescript":"5.5.2"},"exports":{".":{"import":"./esm/index.js","require":"./index.js"},"./index":{"import":"./esm/index.js","require":"./index.js"},"./musig2":{"import":"./esm/musig2.js","require":"./musig2.js"},"./payment":{"import":"./esm/payment.js","require":"./payment.js"},"./psbt":{"import":"./esm/psbt.js","require":"./psbt.js"},"./script":{"import":"./esm/script.js","require":"./script.js"},"./transaction":{"import":"./esm/transaction.js","require":"./transaction.js"},"./utils":{"import":"./esm/utils.js","require":"./utils.js"},"./utxo":{"import":"./esm/utxo.js","require":"./utxo.js"}},"sideEffects":false,"author":{"name":"Paul Miller","url":"https://paulmillr.com"},"license":"MIT","homepage":"https://github.com/paulmillr/scure-btc-signer","repository":{"type":"git","url":"git+https://github.com/paulmillr/scure-btc-signer.git"},"scripts":{"build":"tsc && tsc -p tsconfig.cjs.json","build:release":"npx jsbt esbuild test/build","lint":"prettier --check src","format":"prettier --write src","test":"node test/index.js","test:big":"node test/slow.test.js","test:bun":"bun test/index.js","test:deno":"deno --allow-env --allow-read test/index.js","test:extended":"node --experimental-loader ./test/bitcoinjs-test/esm-loader.js ./test/bitcoinjs-test/index.test.js"},"keywords":["bitcoin","btc","sign","tx","transaction","address","taproot","schnorr","psbt","p2pkh","p2wpkh","p2sh","p2wsh","p2tr"],"funding":"https://paulmillr.com/funding/","_id":"@arklabs/btc-signer@1.6.0","gitHead":"38e02476698a052edf097d99fa67880d37669a75","bugs":{"url":"https://github.com/paulmillr/scure-btc-signer/issues"},"_nodeVersion":"23.3.0","_npmVersion":"10.9.0","dist":{"integrity":"sha512-lMn4bQ8CxiZpmrnFN1fMhO0FhU0Dyq5GL7cxX6/Kr3QHAvZ5ZvwoN2+ezHYjKjttxvpBgUkjFcn9KfrMmUH2yg==","shasum":"9cf084458f2ba43c08931390b8da90043ef6af2d","tarball":"https://registry.npmjs.org/@arklabs/btc-signer/-/btc-signer-1.6.0.tgz","fileCount":86,"unpackedSize":1080986,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIBnm4jffiCfU3SUMWOjaBe1k8iNJu+1xg/rq+sCLEif/AiBeWtkGjrPxkESA2dUJ5kLuDOPSaOGKz83psMtO75YyGw=="}]},"_npmUser":{"name":"louisark","email":"louis@arklabs.to"},"directories":{},"maintainers":[{"name":"tiero","email":"marco@vulpem.com"},{"name":"altafan","email":"pietro@vulpem.com"},{"name":"louisark","email":"louis@arklabs.to"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/btc-signer_1.6.0_1740140995622_0.7164093968506888"},"_hasShrinkwrap":false}},"time":{"created":"2025-02-21T12:29:55.522Z","1.6.0":"2025-02-21T12:29:55.845Z","modified":"2025-02-21T12:29:56.089Z"},"maintainers":[{"name":"tiero","email":"marco@vulpem.com"},{"name":"altafan","email":"pietro@vulpem.com"},{"name":"louisark","email":"louis@arklabs.to"}],"description":"Audited & minimal library for Bitcoin. Handle transactions, Schnorr, Taproot, UTXO & PSBT","homepage":"https://github.com/paulmillr/scure-btc-signer","keywords":["bitcoin","btc","sign","tx","transaction","address","taproot","schnorr","psbt","p2pkh","p2wpkh","p2sh","p2wsh","p2tr"],"repository":{"type":"git","url":"git+https://github.com/paulmillr/scure-btc-signer.git"},"author":{"name":"Paul Miller","url":"https://paulmillr.com"},"bugs":{"url":"https://github.com/paulmillr/scure-btc-signer/issues"},"license":"MIT","readme":"# scure-btc-signer\n\nAudited & minimal library for creating, signing & decoding Bitcoin transactions.\n\n- 🔒 [**Audited**](#security) by an independent security firm\n- ✍️ Create transactions, inputs, outputs, sign them\n- 📡 No network code: simplified audits and offline usage\n- 🔀 UTXO selection with different strategies\n- 🎻 Classic & SegWit: P2PK, P2PKH, P2WPKH, P2SH, P2WSH, P2MS\n- 🧪 Schnorr & Taproot BIP340/BIP341: P2TR, P2TR-NS, P2TR-MS\n- 📨 BIP174 PSBT, BIP327 MuSig2\n- 🗳️ Easy ordinals and inscriptions\n- 🪶 3300 lines\n\nInitial development has been funded by [Ryan Shea](https://shea.io).\n\nFor discussions, questions and support, visit\n[GitHub Discussions](https://github.com/paulmillr/scure-btc-signer/discussions)\nsection of the repository.\n\n_Check out all web3 utility libraries:_ [ETH](https://github.com/paulmillr/micro-eth-signer), [BTC](https://github.com/paulmillr/scure-btc-signer), [SOL](https://github.com/paulmillr/micro-sol-signer), [ordinals](https://github.com/paulmillr/micro-ordinals)\n\n### This library belongs to _scure_\n\n> **scure** — audited micro-libraries.\n\n- Zero or minimal dependencies\n- Highly readable TypeScript / JS code\n- PGP-signed releases and transparent NPM builds\n- Check out [homepage](https://paulmillr.com/noble/#scure) & all libraries:\n  [base](https://github.com/paulmillr/scure-base),\n  [bip32](https://github.com/paulmillr/scure-bip32),\n  [bip39](https://github.com/paulmillr/scure-bip39),\n  [btc-signer](https://github.com/paulmillr/scure-btc-signer),\n  [starknet](https://github.com/paulmillr/scure-starknet)\n\n## Usage\n\n> `npm install @scure/btc-signer`\n\n> `deno add jsr:@scure/btc-signer`\n\n> `deno doc jsr:@scure/btc-signer` # command-line documentation\n\nWe support all major platforms and runtimes.\nFor [Deno](https://deno.land), ensure to use [npm specifier](https://deno.land/manual@v1.28.0/node/npm_specifiers).\nFor React Native, you may need a [polyfill for crypto.getRandomValues](https://github.com/LinusU/react-native-get-random-values).\n\n```ts\nimport * as btc from '@scure/btc-signer';\n```\n\n- [Payments](#payments)\n  - [P2PK Pay To Public Key](#p2pk-pay-to-public-key)\n  - [P2PKH Public Key Hash](#p2pkh-public-key-hash)\n  - [P2WPKH Witness Public Key Hash](#p2wpkh-witness-public-key-hash)\n  - [P2SH Script Hash](#p2sh-script-hash)\n  - [P2WSH Witness Script Hash](#p2wsh-witness-script-hash)\n  - [P2SH-P2WSH](#p2sh-p2wsh)\n  - [P2MS classic multisig](#p2ms-classic-multisig)\n  - [P2TR Taproot](#p2tr-taproot)\n  - [P2TR-NS Taproot multisig](#p2tr-ns-taproot-multisig)\n  - [P2TR-MS Taproot M-of-N multisig](#p2tr-ms-taproot-m-of-n-multisig)\n  - [P2TR-PK Taproot single P2PK script](#p2tr-pk-taproot-single-p2pk-script)\n  - [P2A Pay To Anchor](#p2a-pay-to-anchor)\n- [Transaction](#transaction)\n  - [Encode/decode](#encodedecode)\n  - [Inputs](#inputs)\n  - [Outputs](#outputs)\n  - [Basic transaction sign](#basic-transaction-sign)\n  - [BIP174 PSBT multi-sig example](#bip174-psbt-multi-sig-example)\n- [UTXO selection](#utxo-selection)\n- [MuSig2](#musig2)\n- [Ordinals and custom scripts](#ordinals-and-custom-scripts)\n- [Utils](#utils)\n  - [getAddress](#getaddress)\n    - [WIF](#wif)\n  - [Script](#script)\n  - [OutScript](#outscript)\n- [Bitcoin is flawed](#bitcoin-is-flawed)\n- [Security](#security)\n- [License](#license)\n\n## Payments\n\nBTC has several UTXO types:\n\n- P2PK: Legacy, from 2010\n- P2PKH, P2SH, P2MS: Classic\n- P2WPKH, P2WSH: classic, SegWit\n- P2TR: Taproot, recommended\n\nFor test examples, the usage is as following:\n\n```sh\nnpm install @scure/btc-signer @scure/base assert\n```\n\n```ts\nimport * as btc from '@scure/btc-signer';\nimport { hex } from '@scure/base';\nimport { deepStrictEqual, throws } from 'assert';\n```\n\n### P2PK (Pay To Public Key)\n\nLegacy script, doesn't have an address. Must be wrapped in P2SH / P2WSH / P2SH-P2WSH. Not recommended.\n\n```ts\nconst uncompressed = hex.decode(\n  '04ad90e5b6bc86b3ec7fac2c5fbda7423fc8ef0d58df594c773fa05e2c281b2bfe877677c668bd13603944e34f4818ee03cadd81a88542b8b4d5431264180e2c28'\n);\n\ndeepStrictEqual(btc.p2pk(uncompressed), {\n  type: 'pk',\n  script: hex.decode(\n    '4104ad90e5b6bc86b3ec7fac2c5fbda7423fc8ef0d58df594c773fa05e2c281b2bfe877677c668bd13603944e34f4818ee03cadd81a88542b8b4d5431264180e2c28ac'\n  ),\n});\n```\n\n### P2PKH (Public Key Hash)\n\nClassic (pre-SegWit) address.\n\n```ts\nconst PubKey = hex.decode('030000000000000000000000000000000000000000000000000000000000000001');\ndeepStrictEqual(btc.p2pkh(PubKey), {\n  type: 'pkh',\n  address: '134D6gYy8DsR5m4416BnmgASuMBqKvogQh',\n  script: hex.decode('76a914168b992bcfc44050310b3a94bd0771136d0b28d188ac'),\n});\n// P2SH-P2PKH\ndeepStrictEqual(btc.p2sh(btc.p2pkh(PubKey)), {\n  type: 'sh',\n  address: '3EPhLJ1FuR2noj6qrTs4YvepCvB6sbShoV',\n  script: hex.decode('a9148b530b962725af3bb7c818f197c619db3f71495087'),\n  redeemScript: hex.decode('76a914168b992bcfc44050310b3a94bd0771136d0b28d188ac'),\n});\n// P2WSH-P2PKH\ndeepStrictEqual(btc.p2wsh(btc.p2pkh(PubKey)), {\n  type: 'wsh',\n  address: 'bc1qhxtthndg70cthfasy8y4qlk9h7r3006azn9md0fad5dg9hh76nkqaufnuz',\n  script: hex.decode('0020b996bbcda8f3f0bba7b021c9507ec5bf8717bf5d14cbb6bd3d6d1a82defed4ec'),\n  witnessScript: hex.decode('76a914168b992bcfc44050310b3a94bd0771136d0b28d188ac'),\n});\n// P2SH-P2WSH-P2PKH\ndeepStrictEqual(btc.p2sh(btc.p2wsh(btc.p2pkh(PubKey))), {\n  type: 'sh',\n  address: '3EHxWHyLv5Seu5Cd6D1cH56jLKxSi3ps8C',\n  script: hex.decode('a9148a3d36fb710a9c7cae06cfcdf39792ff5773e8f187'),\n  redeemScript: hex.decode('0020b996bbcda8f3f0bba7b021c9507ec5bf8717bf5d14cbb6bd3d6d1a82defed4ec'),\n  witnessScript: hex.decode('76a914168b992bcfc44050310b3a94bd0771136d0b28d188ac'),\n});\n```\n\n### P2WPKH (Witness Public Key Hash)\n\nSegWit V0 version of [P2PKH](#p2pkh-public-key-hash). Basic bech32 address. Can't be wrapped in [P2WSH](#p2wsh-witness-script-hash).\n\n```ts\nconst PubKey = hex.decode('030000000000000000000000000000000000000000000000000000000000000001');\ndeepStrictEqual(btc.p2wpkh(PubKey), {\n  type: 'wpkh',\n  address: 'bc1qz69ej270c3q9qvgt822t6pm3zdksk2x35j2jlm',\n  script: hex.decode('0014168b992bcfc44050310b3a94bd0771136d0b28d1'),\n});\n// P2SH-P2WPKH\ndeepStrictEqual(btc.p2sh(btc.p2wpkh(PubKey)), {\n  type: 'sh',\n  address: '3BCuRViGCTXmQjyJ9zjeRUYrdZTUa38zjC',\n  script: hex.decode('a91468602f2db7b7d7cdcd2639ab6bf7f5bfe828e53f87'),\n  redeemScript: hex.decode('0014168b992bcfc44050310b3a94bd0771136d0b28d1'),\n});\n```\n\n### P2SH (Script Hash)\n\nClassic (pre-SegWit) script address. Useful for multisig and other advanced use-cases. Consumes full output of other payments — NOT only script.\n\nRequired tx input fields to make it spendable: `redeemScript`\n\n```ts\nconst PubKey = hex.decode('030000000000000000000000000000000000000000000000000000000000000001');\n// Wrap P2PKH in P2SH\ndeepStrictEqual(btc.p2sh(btc.p2pkh(PubKey)), {\n  type: 'sh',\n  address: '3EPhLJ1FuR2noj6qrTs4YvepCvB6sbShoV',\n  script: hex.decode('a9148b530b962725af3bb7c818f197c619db3f71495087'),\n  redeemScript: hex.decode('76a914168b992bcfc44050310b3a94bd0771136d0b28d188ac'),\n});\n```\n\n### P2WSH (Witness Script Hash)\n\nSegWit V0 version of [P2SH](#p2sh-script-hash).\n\nRequired tx input fields to make it spendable: `witnessScript`\n\n```ts\nconst PubKey = hex.decode('030000000000000000000000000000000000000000000000000000000000000001');\ndeepStrictEqual(btc.p2wsh(btc.p2pkh(PubKey)), {\n  type: 'wsh',\n  address: 'bc1qhxtthndg70cthfasy8y4qlk9h7r3006azn9md0fad5dg9hh76nkqaufnuz',\n  script: hex.decode('0020b996bbcda8f3f0bba7b021c9507ec5bf8717bf5d14cbb6bd3d6d1a82defed4ec'),\n  witnessScript: hex.decode('76a914168b992bcfc44050310b3a94bd0771136d0b28d188ac'),\n});\n```\n\n### P2SH-P2WSH\n\nNot really script type, but construction of P2WSH inside P2SH.\n\nRequired tx input fields to make it spendable: `redeemScript`, `witnessScript`\n\n```ts\nconst PubKey = hex.decode('030000000000000000000000000000000000000000000000000000000000000001');\ndeepStrictEqual(btc.p2sh(btc.p2wsh(btc.p2pkh(PubKey))), {\n  type: 'sh',\n  address: '3EHxWHyLv5Seu5Cd6D1cH56jLKxSi3ps8C',\n  script: hex.decode('a9148a3d36fb710a9c7cae06cfcdf39792ff5773e8f187'),\n  redeemScript: hex.decode('0020b996bbcda8f3f0bba7b021c9507ec5bf8717bf5d14cbb6bd3d6d1a82defed4ec'),\n  witnessScript: hex.decode('76a914168b992bcfc44050310b3a94bd0771136d0b28d188ac'),\n});\n```\n\n### P2MS (classic multisig)\n\nClassic / segwit (pre-taproot) M-of-N Multisig. Doesn't have an address, must be wrapped in P2SH / P2WSH / P2SH-P2WSH.\n\nDuplicate public keys are not accepted to reduce mistakes. Use flag `allowSamePubkeys` to override the behavior, for cases like `2-of-[A,A,B,C]`, which can be signed by `A or (B and C)`.\n\n```ts\nconst PubKeys = [\n  hex.decode('030000000000000000000000000000000000000000000000000000000000000001'),\n  hex.decode('030000000000000000000000000000000000000000000000000000000000000002'),\n  hex.decode('030000000000000000000000000000000000000000000000000000000000000003'),\n];\n// Multisig 2-of-3 wrapped in P2SH\ndeepStrictEqual(btc.p2sh(btc.p2ms(2, PubKeys)), {\n  type: 'sh',\n  address: '3G4AeQtzCLoDAyv2eb3UVTG5atfkyHtuRn',\n  script: hex.decode('a9149d91c6de4eacde72a7cc86bff98d1915b3c7818f87'),\n  redeemScript: hex.decode(\n    '5221030000000000000000000000000000000000000000000000000000000000000001210300000000000000000000000000000000000000000000000000000000000000022103000000000000000000000000000000000000000000000000000000000000000353ae'\n  ),\n});\n// Multisig 2-of-3 wrapped in P2WSH\ndeepStrictEqual(btc.p2wsh(btc.p2ms(2, PubKeys)), {\n  type: 'wsh',\n  address: 'bc1qwnhzkn8wcyyrnfyfcp7555urssu5dq0rmnvg70hg02z3nxgg4f0qljmr2h',\n  script: hex.decode('002074ee2b4ceec10839a489c07d4a538384394681e3dcd88f3ee87a85199908aa5e'),\n  witnessScript: hex.decode(\n    '5221030000000000000000000000000000000000000000000000000000000000000001210300000000000000000000000000000000000000000000000000000000000000022103000000000000000000000000000000000000000000000000000000000000000353ae'\n  ),\n});\n// Multisig 2-of-3 wrapped in P2SH-P2WSH\ndeepStrictEqual(btc.p2sh(btc.p2wsh(btc.p2ms(2, PubKeys))), {\n  type: 'sh',\n  address: '3HKWSo57kmcJZ3h43pXS3m5UESR4wXcWTd',\n  script: hex.decode('a914ab70ab84b12b891364b4b2a14ca813cac308b24287'),\n  redeemScript: hex.decode('002074ee2b4ceec10839a489c07d4a538384394681e3dcd88f3ee87a85199908aa5e'),\n  witnessScript: hex.decode(\n    '5221030000000000000000000000000000000000000000000000000000000000000001210300000000000000000000000000000000000000000000000000000000000000022103000000000000000000000000000000000000000000000000000000000000000353ae'\n  ),\n});\n// Useful util: wraps P2MS in P2SH or P2WSH\ndeepStrictEqual(btc.p2sh(btc.p2ms(2, PubKeys)), btc.multisig(2, PubKeys));\ndeepStrictEqual(btc.p2wsh(btc.p2ms(2, PubKeys)), btc.multisig(2, PubKeys, undefined, true));\n// Sorted multisig (BIP67)\ndeepStrictEqual(btc.p2sh(btc.p2ms(2, PubKeys)), btc.sortedMultisig(2, PubKeys));\ndeepStrictEqual(btc.p2wsh(btc.p2ms(2, PubKeys)), btc.sortedMultisig(2, PubKeys, true));\n```\n\n### P2TR (Taproot)\n\nTapRoot (SegWit V1) script which replaces both public key and script types from previous versions.\n\nConsumes `p2tr(PubKey?, ScriptTree?)` and works as `PubKey` OR `ScriptTree`, which means\nif you use any spendable PubKey and ScriptTree of multi-sig, owner of private key for PubKey will\nbe able to spend output. If PubKey is undefined we use static unspendable PubKey by default, which leaks information about script type. However, any dynamic unspendable keys will require complex interaction\nto sign multi-sig wallets, and there is no BIP/PSBT fields for that yet.\n\nRequired tx input fields to make it spendable: `tapInternalKey`, `tapMerkleRoot`, `tapLeafScript`\n\n```ts\nconst PubKey = hex.decode('0101010101010101010101010101010101010101010101010101010101010101');\n// Key Path Spend (owned of private key for PubKey can spend)\ndeepStrictEqual(btc.p2tr(PubKey), {\n  type: 'tr',\n  address: 'bc1p7yu5dsly83jg5tkxcljsa30vnpdpl22wr6rty98t6x6p6ekz2gkqzf2t2s',\n  script: hex.decode('5120f13946c3e43c648a2ec6c7e50ec5ec985a1fa94e1e86b214ebd1b41d66c2522c'),\n  tweakedPubkey: hex.decode('f13946c3e43c648a2ec6c7e50ec5ec985a1fa94e1e86b214ebd1b41d66c2522c'),\n  tapInternalKey: hex.decode('0101010101010101010101010101010101010101010101010101010101010101'),\n});\n\nconst clean = (x) => ({ type: x.type, address: x.address, script: hex.encode(x.script) });\n\nconst PubKey2 = hex.decode('0202020202020202020202020202020202020202020202020202020202020202');\nconst PubKey3 = hex.decode('1212121212121212121212121212121212121212121212121212121212121212');\n// Nested P2TR, owner of private key for any of PubKeys can spend whole\n// By default P2TR expects binary tree, but btc.p2tr can build it if list of scripts passed.\n// Also, you can include {weight: N} to scripts to create differently balanced tree.\ndeepStrictEqual(\n  clean(btc.p2tr(undefined, [btc.p2tr_pk(PubKey), btc.p2tr_pk(PubKey2), btc.p2tr_pk(PubKey3)])),\n  {\n    type: 'tr',\n    // weights for bitcoinjs-lib: [3,2,1]\n    address: 'bc1pj2uvajyygyu2zw0rg0d6yxdsc920kzc5pamfgtlqepe30za922cqjjmkta',\n    script: '512092b8cec8844138a139e343dba219b0c154fb0b140f76942fe0c873178ba552b0',\n  }\n);\n// If scriptsTree is already binary tree, it will be used as-is\ndeepStrictEqual(\n  clean(btc.p2tr(undefined, [btc.p2tr_pk(PubKey2), [btc.p2tr_pk(PubKey), btc.p2tr_pk(PubKey3)]])),\n  {\n    type: 'tr',\n    // default weights for bitcoinjs-lib\n    address: 'bc1pvue6sk9efyvcvpzzqkg8at4qy2u67zj7rj5sfsy573m7alxavqjqucc26a',\n    script: '51206733a858b9491986044205907eaea022b9af0a5e1ca904c094f477eefcdd6024',\n  }\n);\n```\n\n### P2TR-NS (Taproot multisig)\n\nTaproot N-of-N multisig (`[<PubKeys[0:n-1]> CHECKSIGVERIFY] <PubKeys[n-1]> CHECKSIG`).\n\nFirst arg is M, if M!=PubKeys.length, it will create a multi-leaf M-of-N taproot script tree.\nThis allows one to reveal only `M` PubKeys on spend, without any information about the others.\nThis is fast for cases like 15-of-20, but extremely slow for cases like 5-of-20.\n\nDuplicate public keys are not accepted to reduce mistakes. Use flag `allowSamePubkeys` to override the behavior, for cases like `2-of-[A,A,B,C]`, which can be signed by `A or (B and C)`.\n\n```ts\nconst PubKey = hex.decode('0101010101010101010101010101010101010101010101010101010101010101');\nconst PubKey2 = hex.decode('0202020202020202020202020202020202020202020202020202020202020202');\nconst PubKey3 = hex.decode('1212121212121212121212121212121212121212121212121212121212121212');\n\n// Simple 3-of-3 multisig\n// Creates a single script that requires all three pubkeys: [PubKey, PubKey2, PubKey3]\ndeepStrictEqual(btc.p2tr_ns(3, [PubKey, PubKey2, PubKey3]), [\n  {\n    type: 'tr_ns',\n    script: hex.decode(\n      '200101010101010101010101010101010101010101010101010101010101010101ad200202020202020202020202020202020202020202020202020202020202020202ad201212121212121212121212121212121212121212121212121212121212121212ac'\n    ),\n  },\n]);\n// Simple 2-of-3 multisig\n// If M (pubkeys required) is less than N (# of pubkeys), then multiple scripts are created: [[PubKey, PubKey2], [PubKey, PubKey3], [PubKey2, PubKey3]]\nconst clean = (x) => ({ type: x.type, address: x.address, script: hex.encode(x.script) });\ndeepStrictEqual(clean(btc.p2tr(undefined, btc.p2tr_ns(2, [PubKey, PubKey2, PubKey3]))), {\n  type: 'tr',\n  address: 'bc1pevfcmnkqqq09a4n0fs8c7mwlc6r4efqpvgyqpjvegllavgw235fq3kz7a0',\n  script: '5120cb138dcec0001e5ed66f4c0f8f6ddfc6875ca401620800c99947ffd621ca8d12',\n});\n```\n\n### P2TR-MS (Taproot M-of-N multisig)\n\nM-of-N single leaf TapRoot multisig (`<PubKeys[0]> CHECKSIG [<PubKeys[1:n]> CHECKSIGADD] <M> NUMEQUAL`)\n\nDuplicate public keys are not accepted to reduce mistakes. Use flag `allowSamePubkeys` to override the behavior, for cases like `2-of-[A,A,B,C]`, which can be signed by `A or (B and C)`.\n\n**Experimental**, use at your own risk.\n\n```ts\nconst PubKey = hex.decode('0101010101010101010101010101010101010101010101010101010101010101');\nconst PubKey2 = hex.decode('0202020202020202020202020202020202020202020202020202020202020202');\nconst PubKey3 = hex.decode('1212121212121212121212121212121212121212121212121212121212121212');\n// 2-of-3 TapRoot multisig\ndeepStrictEqual(btc.p2tr_ms(2, [PubKey, PubKey2, PubKey3]), {\n  type: 'tr_ms',\n  script: hex.decode(\n    '200101010101010101010101010101010101010101010101010101010101010101ac200202020202020202020202020202020202020202020202020202020202020202ba201212121212121212121212121212121212121212121212121212121212121212ba529c'\n  ),\n});\n// Creates a single script for [PubKey, PubKey2, PubKey3]\nconst clean = (x) => ({ type: x.type, address: x.address, script: hex.encode(x.script) });\ndeepStrictEqual(clean(btc.p2tr(undefined, btc.p2tr_ms(2, [PubKey, PubKey2, PubKey3]))), {\n  type: 'tr',\n  address: 'bc1p6m2xevckax9zucumnnyvu4xhxem66ugc5r2zlw2a20s0hxnutl8qfef23s',\n  script: '5120d6d46cb316e98a2e639b9cc8ce54d73677ad7118a0d42fb95d53e0fb9a7c5fce',\n});\n```\n\n### P2TR-PK (Taproot single P2PK script)\n\nSpecific case of `p2tr_ns(1, [pubkey])`, which is the same as the BTC descriptor: `tr($H,pk(PUBKEY))`\n\n```ts\nconst PubKey = hex.decode('0101010101010101010101010101010101010101010101010101010101010101');\n// P2PK for taproot\nconst clean = (x) => ({ type: x.type, address: x.address, script: hex.encode(x.script) });\ndeepStrictEqual(clean(btc.p2tr(undefined, [btc.p2tr_pk(PubKey)])), {\n  type: 'tr',\n  address: 'bc1pfj6w68w3v2f4pkzesc9tsqfvy5znw5qgydwa832v3v83vjn76kdsmr4360',\n  script: '51204cb4ed1dd1629350d859860ab8012c2505375008235dd3c54c8b0f164a7ed59b',\n});\n```\n\n### P2A (Pay to Anchor)\n\nEphemeral anchors are supported. [Check out docs](https://bitcoinops.org/en/topics/ephemeral-anchors/).\n\n```ts\nconst p2aScript = hex.decode('51024e73');\nconst decoded = btc.OutScript.decode(p2aScript);\ndeepStrictEqual(decoded, { type: 'p2a', script: p2aScript });\ndeepStrictEqual(hex.encode(btc.OutScript.encode(decoded)), '51024e73');\n```\n\n## Transaction\n\n### Encode/decode\n\nWe support both PSBTv0 and draft PSBTv2 (there is no PSBTv1). If PSBTv2 transaction is encoded into PSBTv1, all PSBTv2 fields will be stripped.\n\nWe strip 'unknown' keys inside PSBT, they needed for new version/features support,\nhowever any unsupported feature/new version can significantly break assumptions about code.\nIf you have use-case where they are needed, create a github issue.\n\nPSBTv2 features tx_modifiable and taproot+bip32 are not supported yet.\n\n```ts\n// Decode\nTransaction.fromRaw(raw: Bytes, opts: TxOpts = {}); // Raw tx\nTransaction.fromPSBT(psbt: Bytes, opts: TxOpts = {}); // PSBT tx\n// Encode\ntx.unsignedTx; // Bytes of raw unsigned tx\ntx.hex; // hex encoded signed raw tx\ntx.toPSBT(ver = this.PSBTVersion); // PSBT\n```\n\n### Inputs\n\nWe have txid (BE) instead of hash (LE) in transactions. We can support both,\nbut txid is consistent across block explorers, while some explorers treat hash\nas txid - so hash is not consistent.\n\nUse `getInput` and `inputsLength` to read information about inputs: they return a copy.\nThis is necessary to avoid accidental modification of internal structures without calling methods (addInput/updateInput) that will verify correctness.\n\n```ts\ntype TransactionInput = {\n  txid?: Bytes,\n  index?: number,\n  nonWitnessUtxo?: <RawTransactionBytesOrHex>,\n  witnessUtxo?: {script?: Bytes; amount: bigint},\n  partialSig?: [Bytes, Bytes][]; // [PubKey, Signature]\n  sighashType?: P.U32LE,\n  redeemScript?: Bytes,\n  witnessScript?: Bytes,\n  bip32Derivation?: [Bytes, {fingerprint: number; path: number[]}]; // [PubKey, DeriviationPath]\n  finalScriptSig?: Bytes,\n  finalScriptWitness?: Bytes[],\n  porCommitment?: Bytes,\n  sequence?: number,\n  requiredTimeLocktime?: number,\n  requiredHeightLocktime?: number,\n  tapKeySig?: Bytes,\n  tapScriptSig?: [Bytes, Bytes][]; // [PubKeySchnorr, LeafHash]\n  // [ControlBlock, ScriptWithVersion]\n  tapLeafScript?: [{version: number; internalKey: Bytes; merklePath: Bytes[]}, Bytes];\n  tapInternalKey?: Bytes,\n  tapMerkleRoot?: Bytes,\n};\n\ntx.addInput(input: TransactionInput): number;\ntx.updateInput(idx: number, input: TransactionInput);\n\n// Input\ntx.addInput({ txid: new Uint8Array(32), index: 0 });\ndeepStrictEqual(tx.inputs[0], {\n  txid: new Uint8Array(32),\n  index: 0,\n  sequence: btc.DEFAULT_SEQUENCE,\n});\n// Update basic value\ntx.updateInput(0, { index: 10 });\ndeepStrictEqual(tx.inputs[0], {\n  txid: new Uint8Array(32),\n  index: 10,\n  sequence: btc.DEFAULT_SEQUENCE,\n});\n// Add value as hex\ntx.addInput({\n  txid: '0000000000000000000000000000000000000000000000000000000000000000',\n  index: 0,\n});\ndeepStrictEqual(tx.inputs[2], {\n  txid: new Uint8Array(32),\n  index: 0,\n  sequence: btc.DEFAULT_SEQUENCE,\n});\n// Update key map\nconst pubKey = hex.decode('030000000000000000000000000000000000000000000000000000000000000001');\nconst bip1 = [pubKey, { fingerprint: 5, path: [1, 2, 3] }];\nconst pubKey2 = hex.decode('030000000000000000000000000000000000000000000000000000000000000002');\nconst bip2 = [pubKey2, { fingerprint: 6, path: [4, 5, 6] }];\nconst pubKey3 = hex.decode('030000000000000000000000000000000000000000000000000000000000000003');\nconst bip3 = [pubKey3, { fingerprint: 7, path: [7, 8, 9] }];\n// Add K-V\ntx.updateInput(0, { bip32Derivation: [bip1] });\ndeepStrictEqual(tx.inputs[0].bip32Derivation, [bip1]);\n// Add another K-V\ntx.updateInput(0, { bip32Derivation: [bip2] });\ndeepStrictEqual(tx.inputs[0].bip32Derivation, [bip1, bip2]);\n// Delete K-V\ntx.updateInput(0, { bip32Derivation: [[pubKey, undefined]] });\ndeepStrictEqual(tx.inputs[0].bip32Derivation, [bip2]);\n// Second add of same k-v does nothing\ntx.updateInput(0, { bip32Derivation: [bip2] });\ndeepStrictEqual(tx.inputs[0].bip32Derivation, [bip2]);\n// Second add of k-v with different value breaks\nthrows(() => tx.updateInput(0, { bip32Derivation: [[pubKey2, bip1[1]]] }));\ntx.updateInput(0, { bip32Derivation: [bip1, bip2, bip3] });\n// Preserves order (re-ordered on PSBT encoding)\ndeepStrictEqual(tx.inputs[0].bip32Derivation, [bip2, bip1, bip3]);\n// PSBT encoding re-order k-v\nconst tx2 = btc.Transaction.fromPSBT(tx.toPSBT());\ndeepStrictEqual(tx2.inputs[0].bip32Derivation, [bip1, bip2, bip3]);\n// Remove field\ntx.updateInput(0, { bip32Derivation: undefined });\ndeepStrictEqual(tx.inputs[0], {\n  txid: new Uint8Array(32),\n  index: 10,\n  sequence: btc.DEFAULT_SEQUENCE,\n});\n\n// Read inputs\nfor (let i = 0; i < tx.inputsLength; i++) {\n  console.log('I', tx.getInput(i));\n}\n```\n\n### Outputs\n\n`addOutputAddress` uses bigint amounts, which means satoshis - NOT btc. If you need btc representation, use Decimal:\n\n```ts\nconst amountSatoshi = btc.Decimal.decode('1.5'); // 1.5 btc in satoshi\n```\n\nUse `getOutput` and `outputsLength` to read outputs information. This methods returns copy of output, instead of internal representation.\nThis is necessary to avoid accidental modification of internal structures without calling methods (addOutput/updateOutput) that will verify correctness.\n\n```ts\ntype TransactionOutput = {\n  script?: Bytes,\n  amount?: bigint,\n  redeemScript?: Bytes,\n  witnessScript?: Bytes,\n  bip32Derivation?: [Bytes, {fingerprint: number; path: number[]}]; // [PubKey, DeriviationPath]\n  tapInternalKey?: Bytes,\n};\n\ntx.addOutput(o: TransactionOutput): number;\ntx.updateOutput(idx: number, output: TransactionOutput);\ntx.addOutputAddress(address: string, amount: bigint, network = NETWORK): number;\n\nconst compressed = hex.decode(\n  '030000000000000000000000000000000000000000000000000000000000000001'\n);\nconst script = btc.p2pkh(compressed).script;\ntx.addOutput({ script, amount: 100n });\ndeepStrictEqual(tx.outputs[0], {\n  script,\n  amount: 100n,\n});\n// Update basic value\ntx.updateOutput(0, { amount: 200n });\ndeepStrictEqual(tx.outputs[0], {\n  script,\n  amount: 200n,\n});\n// Add K-V\ntx.updateOutput(0, { bip32Derivation: [bip1] });\ndeepStrictEqual(tx.outputs[0].bip32Derivation, [bip1]);\n// Add another K-V\ntx.updateOutput(0, { bip32Derivation: [bip2] });\ndeepStrictEqual(tx.outputs[0].bip32Derivation, [bip1, bip2]);\n// Delete K-V\ntx.updateOutput(0, { bip32Derivation: [[pubKey, undefined]] });\ndeepStrictEqual(tx.outputs[0].bip32Derivation, [bip2]);\n// Second add of same k-v does nothing\ntx.updateOutput(0, { bip32Derivation: [bip2] });\ndeepStrictEqual(tx.outputs[0].bip32Derivation, [bip2]);\n// Second add of k-v with different value breaks\nthrows(() => tx.updateOutput(0, { bip32Derivation: [[pubKey2, bip1[1]]] }));\ntx.updateOutput(0, { bip32Derivation: [bip1, bip2, bip3] });\n// Preserves order (re-ordered on PSBT encoding)\ndeepStrictEqual(tx.outputs[0].bip32Derivation, [bip2, bip1, bip3]);\n// PSBT encoding re-order k-v\nconst tx3 = btc.Transaction.fromPSBT(tx.toPSBT());\ndeepStrictEqual(tx3.outputs[0].bip32Derivation, [bip1, bip2, bip3]);\n// Remove field\ntx.updateOutput(0, { bip32Derivation: undefined });\ndeepStrictEqual(tx.outputs[0], {\n  script,\n  amount: 200n,\n});\n\n// Read outputs\nfor (let i = 0; i < tx.outputsLength; i++) {\n  console.log('O', tx.getOutput(i));\n}\n```\n\n### Basic transaction sign\n\n```ts\nconst privKey = hex.decode('0101010101010101010101010101010101010101010101010101010101010101');\nconst txP2WPKH = new btc.Transaction();\nfor (const inp of TX_TEST_INPUTS) {\n  txP2WPKH.addInput({\n    txid: inp.txid,\n    index: inp.index,\n    witnessUtxo: {\n      amount: inp.amount,\n      script: btc.p2wpkh(secp256k1.getPublicKey(privKey, true)).script,\n    },\n  });\n}\nfor (const [address, amount] of TX_TEST_OUTPUTS) txP2WPKH.addOutputAddress(address, amount);\ndeepStrictEqual(hex.encode(txP2WPKH.unsignedTx), RAW_TX_HEX);\ntxP2WPKH.sign(privKey);\ntxP2WPKH.finalize();\ndeepStrictEqual(txP2WPKH.id, 'cbb94443b19861df0824914fa654212facc071854e0df6f7388b482a6394526d');\ndeepStrictEqual(\n  txP2WPKH.hex,\n  '010000000001033edaa6c4e0740ae334dbb5857dd8c6faf6ea5196760652ad7033ed9031c261c00000000000ffffffff0d9ae8a4191b3ba5a2b856c21af0f7a4feb97957ae80725ef38a933c906519a20000000000ffffffffc7a4a37d38c2b0de3d3b3e8d8e8a331977c12532fc2a4632df27a89c311ee2fa0000000000ffffffff03e8030000000000001976a91406afd46bcdfd22ef94ac122aa11f241244a37ecc88ac881300000000000017a914a860f76561c85551594c18eecceffaee8c4822d7876b24000000000000160014e8df018c7e326cc253faac7e46cdc51e68542c4202473044022024e7b1a6ae19a95c69c192745db09cc54385a80cc7684570cfbf2da84cbbfa0802205ad55efb2019a1aa6edc03cf243989ea428c4d216699cbae2cfaf3c26ddef5650121031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f0247304402204415ef16f341e888ca2483b767b47fcf22977b6d673c3f7c6cae2f6b4bc2ac08022055be98747345b02a6f40edcc2f80390dcef4efe57b38c1bb7d16bdbca710abfd0121031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f02473044022069769fb5c97a7dd9401dbd3f6d32a38fe82bc8934c49c7c4cd3b39c6d120080c02202c181604203dc45c10e5290ded103195fae117d7fb0db19cdc411e73a76da6cb0121031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f00000000'\n);\n```\n\n### BIP174 PSBT multi-sig example\n\n```ts\nconst testnet = {\n  wif: 0xef,\n  bip32: {\n    public: 0x043587cf,\n    private: 0x04358394,\n  },\n};\n// The private keys in the tests below are derived from the following master private key:\nconst epriv =\n  'tprv8ZgxMBicQKsPd9TeAdPADNnSyH9SSUUbTVeFszDE23Ki6TBB5nCefAdHkK8Fm3qMQR6sHwA56zqRmKmxnHk37JkiFzvncDqoKmPWubu7hDF';\nconst hdkey = bip32.HDKey.fromExtendedKey(epriv, testnet.bip32);\n// const seed = 'cUkG8i1RFfWGWy5ziR11zJ5V4U4W3viSFCfyJmZnvQaUsd1xuF3T';\nconst tx = new btc.Transaction();\n// A creator creating a PSBT for a transaction which creates the following outputs:\ntx.addOutput({\n  script: '0014d85c2b71d0060b09c9886aeb815e50991dda124d',\n  amount: btc.Decimal.decode('1.49990000'),\n});\ntx.addOutput({\n  script: '001400aea9a2e5f0f876a588df5546e8742d1d87008f',\n  amount: btc.Decimal.decode('1.00000000'),\n});\n// and spends the following inputs:\ntx.addInput({\n  txid: '75ddabb27b8845f5247975c8a5ba7c6f336c4570708ebe230caf6db5217ae858',\n  index: 0,\n});\ntx.addInput({\n  txid: '1dea7cd05979072a3578cab271c02244ea8a090bbb46aa680a65ecd027048d83',\n  index: 1,\n});\n// must create this PSBT:\nconst psbt1 = tx.toPSBT();\n// Given the above PSBT, an updater with only the following:\nconst tx2 = btc.Transaction.fromPSBT(psbt1);\ntx2.updateInput(0, {\n  nonWitnessUtxo:\n    '0200000001aad73931018bd25f84ae400b68848be09db706eac2ac18298babee71ab656f8b0000000048473044022058f6fc7c6a33e1b31548d481c826c015bd30135aad42cd67790dab66d2ad243b02204a1ced2604c6735b6393e5b41691dd78b00f0c5942fb9f751856faa938157dba01feffffff0280f0fa020000000017a9140fb9463421696b82c833af241c78c17ddbde493487d0f20a270100000017a91429ca74f8a08f81999428185c97b5d852e4063f618765000000',\n  redeemScript:\n    '5221029583bf39ae0a609747ad199addd634fa6108559d6c5cd39b4c2183f1ab96e07f2102dab61ff49a14db6a7d02b0cd1fbb78fc4b18312b5b4e54dae4dba2fbfef536d752ae',\n  bip32Derivation: [\n    [\n      '029583bf39ae0a609747ad199addd634fa6108559d6c5cd39b4c2183f1ab96e07f',\n      { fingerprint: hdkey.fingerprint, path: btc.bip32Path(\"m/0'/0'/0'\") },\n    ],\n    [\n      '02dab61ff49a14db6a7d02b0cd1fbb78fc4b18312b5b4e54dae4dba2fbfef536d7',\n      { fingerprint: hdkey.fingerprint, path: btc.bip32Path(\"m/0'/0'/1'\") },\n    ],\n  ],\n});\ntx2.updateInput(1, {\n  // use witness utxo ({script, amount})\n  witnessUtxo: btc.RawTx.decode(\n    hex.decode(\n      '0200000000010158e87a21b56daf0c23be8e7070456c336f7cbaa5c8757924f545887bb2abdd7501000000171600145f275f436b09a8cc9a2eb2a2f528485c68a56323feffffff02d8231f1b0100000017a914aed962d6654f9a2b36608eb9d64d2b260db4f1118700c2eb0b0000000017a914b7f5faf40e3d40a5a459b1db3535f2b72fa921e88702483045022100a22edcc6e5bc511af4cc4ae0de0fcd75c7e04d8c1c3a8aa9d820ed4b967384ec02200642963597b9b1bc22c75e9f3e117284a962188bf5e8a74c895089046a20ad770121035509a48eb623e10aace8bfd0212fdb8a8e5af3c94b0b133b95e114cab89e4f7965000000'\n    )\n  ).outputs[1],\n  redeemScript: '00208c2353173743b595dfb4a07b72ba8e42e3797da74e87fe7d9d7497e3b2028903',\n  witnessScript:\n    '522103089dc10c7ac6db54f91329af617333db388cead0c231f723379d1b99030b02dc21023add904f3d6dcf59ddb906b0dee23529b7ffb9ed50e5e86151926860221f0e7352ae',\n  bip32Derivation: [\n    [\n      '03089dc10c7ac6db54f91329af617333db388cead0c231f723379d1b99030b02dc',\n      { fingerprint: hdkey.fingerprint, path: btc.bip32Path(\"m/0'/0'/2'\") },\n    ],\n    [\n      '023add904f3d6dcf59ddb906b0dee23529b7ffb9ed50e5e86151926860221f0e73',\n      { fingerprint: hdkey.fingerprint, path: btc.bip32Path(\"m/0'/0'/3'\") },\n    ],\n  ],\n});\ntx2.updateOutput(0, {\n  bip32Derivation: [\n    [\n      '03a9a4c37f5996d3aa25dbac6b570af0650394492942460b354753ed9eeca58771',\n      { fingerprint: hdkey.fingerprint, path: btc.bip32Path(\"m/0'/0'/4'\") },\n    ],\n  ],\n});\ntx2.updateOutput(1, {\n  bip32Derivation: [\n    [\n      '027f6399757d2eff55a136ad02c684b1838b6556e5f1b6b34282a94b6b50051096',\n      { fingerprint: hdkey.fingerprint, path: btc.bip32Path(\"m/0'/0'/5'\") },\n    ],\n  ],\n});\n// Must create this PSBT:\nconst psbt2 = tx2.toPSBT();\n// An updater which adds SIGHASH_ALL to the above PSBT must create this PSBT:\nconst tx3 = btc.Transaction.fromPSBT(psbt2);\nfor (let i = 0; i < tx3.inputs.length; i++) tx3.updateInput(i, { sighashType: btc.SigHash.ALL });\nconst psbt3 = tx3.toPSBT();\n/*\n  Given the above updated PSBT, a signer that supports SIGHASH_ALL for P2PKH and P2WPKH spends and uses RFC6979 for nonce generation and has the following keys:\n  - cP53pDbR5WtAD8dYAW9hhTjuvvTVaEiQBdrz9XPrgLBeRFiyCbQr (m/0'/0'/0')\n  - cR6SXDoyfQrcp4piaiHE97Rsgta9mNhGTen9XeonVgwsh4iSgw6d (m/0'/0'/2')\n*/\n// We don't use HDKey, because it will everything because of bip32 derivation\nconst tx4 = btc.Transaction.fromPSBT(psbt3);\ntx4.sign(btc.WIF(testnet).decode('cP53pDbR5WtAD8dYAW9hhTjuvvTVaEiQBdrz9XPrgLBeRFiyCbQr'));\ntx4.sign(btc.WIF(testnet).decode('cR6SXDoyfQrcp4piaiHE97Rsgta9mNhGTen9XeonVgwsh4iSgw6d'));\n// must create this PSBT:\nconst psbt4 = tx4.toPSBT();\n// Given the above updated PSBT, a signer with the following keys:\n// cT7J9YpCwY3AVRFSjN6ukeEeWY6mhpbJPxRaDaP5QTdygQRxP9Au (m/0'/0'/1')\n// cNBc3SWUip9PPm1GjRoLEJT6T41iNzCYtD7qro84FMnM5zEqeJsE (m/0'/0'/3')\nconst tx5 = btc.Transaction.fromPSBT(psbt3);\ntx5.sign(btc.WIF(testnet).decode('cT7J9YpCwY3AVRFSjN6ukeEeWY6mhpbJPxRaDaP5QTdygQRxP9Au'));\ntx5.sign(btc.WIF(testnet).decode('cNBc3SWUip9PPm1GjRoLEJT6T41iNzCYtD7qro84FMnM5zEqeJsE'));\n// must create this PSBT:\nconst psbt5 = tx5.toPSBT();\n// Given both of the above PSBTs, a combiner must create this PSBT:\nconst psbt6 = btc.PSBTCombine([psbt4, psbt5]);\n// Given the above PSBT, an input finalizer must create this PSBT:\nconst tx7 = btc.Transaction.fromPSBT(psbt6);\ntx7.finalize();\nconst psbt7 = tx7.toPSBT();\n// Given the above PSBT, a transaction extractor must create this Bitcoin transaction:\nconst tx8 = btc.Transaction.fromPSBT(psbt7);\ndeepStrictEqual(\n  tx8.extract(),\n  hex.decode(\n    '0200000000010258e87a21b56daf0c23be8e7070456c336f7cbaa5c8757924f545887bb2abdd7500000000da00473044022074018ad4180097b873323c0015720b3684cc8123891048e7dbcd9b55ad679c99022073d369b740e3eb53dcefa33823c8070514ca55a7dd9544f157c167913261118c01483045022100f61038b308dc1da865a34852746f015772934208c6d24454393cd99bdf2217770220056e675a675a6d0a02b85b14e5e29074d8a25a9b5760bea2816f661910a006ea01475221029583bf39ae0a609747ad199addd634fa6108559d6c5cd39b4c2183f1ab96e07f2102dab61ff49a14db6a7d02b0cd1fbb78fc4b18312b5b4e54dae4dba2fbfef536d752aeffffffff838d0427d0ec650a68aa46bb0b098aea4422c071b2ca78352a077959d07cea1d01000000232200208c2353173743b595dfb4a07b72ba8e42e3797da74e87fe7d9d7497e3b2028903ffffffff0270aaf00800000000160014d85c2b71d0060b09c9886aeb815e50991dda124d00e1f5050000000016001400aea9a2e5f0f876a588df5546e8742d1d87008f000400473044022062eb7a556107a7c73f45ac4ab5a1dddf6f7075fb1275969a7f383efff784bcb202200c05dbb7470dbf2f08557dd356c7325c1ed30913e996cd3840945db12228da5f01473044022065f45ba5998b59a27ffe1a7bed016af1f1f90d54b3aa8f7450aa5f56a25103bd02207f724703ad1edb96680b284b56d4ffcb88f7fb759eabbe08aa30f29b851383d20147522103089dc10c7ac6db54f91329af617333db388cead0c231f723379d1b99030b02dc21023add904f3d6dcf59ddb906b0dee23529b7ffb9ed50e5e86151926860221f0e7352ae00000000'\n  )\n);\n```\n\n### UTXO selection\n\nUTXO selection is the process of choosing which UTXOs to use as inputs\nwhen making an on-chain bitcoin payment. The library:\n\n- can create tx, integrated with the signer\n- ensures change address is always specified\n- supports bip69\n- supports segwit + taproot\n- calculates weight with good precision\n- implements multiple strategies\n\nTaproot estimation is precise, but you have to pass sighash if you want to use non-default one,\nbecause it changes signature size. For complex taproot trees you need to filter tapLeafScript\nto include only leafs which you can sign we estimate size with smallest leaf (same as finalization),\nbut in specific case keys for this leaf can be unavailable (complex multisig)\n\n`Oldest` / `Newest` expects UTXO provided in historical order (oldest first),\notherwise we have no way to detect age of tx.\n\n#### Strategies\n\nStrategy selection is complicated. Best should be: `exactBiggest/accumSmallest`.\n\n`exactBiggest/accumBiggest` creates tx with smallest fees,\nbut it breaks big outputs to small ones, which in the end will create\na lot of outputs close to dust.\n\n- `default`: good for privacy, same as `exactBiggest/accumBiggest`\n- `all`: send all coins to change address (consolidation)\n- `accum`: accumulates inputs until the target value (+fees) is reached, skipping detrimental inputs\n- `exact`: accumulates inputs until the target value (+fees) is matched, does not accumulate inputs\n  that go over the target value (within a threshold)\n- `accumNewest`\n- `accumOldest`\n- `accumSmallest`\n- `accumBiggest`\n- `exactNewest/accumNewest`\n- `exactNewest/accumOldest`\n- `exactNewest/accumSmallest`\n- `exactNewest/accumBiggest`\n- `exactOldest/accumNewest`\n- `exactOldest/accumOldest`\n- `exactOldest/accumSmallest`\n- `exactOldest/accumBiggest`\n- `exactSmallest/accumNewest`\n- `exactSmallest/accumOldest`\n- `exactSmallest/accumSmallest`\n- `exactSmallest/accumBiggest`\n- `exactBiggest/accumNewest`\n- `exactBiggest/accumOldest`\n- `exactBiggest/accumSmallest`\n- `exactBiggest/accumBiggest`\n\n#### Example\n\n```ts\nconst privKey = hex.decode('0101010101010101010101010101010101010101010101010101010101010101');\nconst pubKey = secp256k1.getPublicKey(privKey, true);\nconst spend = btc.p2wpkh(pubKey, regtest);\nconst utxo = [\n  {\n    ...spend, // add witness/redeem scripts from spend\n    // Get txid, index from explorer/network\n    txid: hex.decode('0af50a00a22f74ece24c12cd667c290d3a35d48124a69f4082700589172a3aa2'),\n    index: 0,\n    // utxo tx information\n    // script can be used from spend itself or from explorer\n    witnessUtxo: { script: spend.script, amount: 100_000n }, // value in satoshi\n  },\n  {\n    ...spend,\n    txid: hex.decode('0af50a00a22f74ece24c12cd667c290d3a35d48124a69f4082700589172a3aa2'),\n    index: 1,\n    witnessUtxo: { script: spend.script, amount: btc.Decimal.decode('1.5') }, // value in btc\n  },\n  // {\n  //   ...spend,\n  //   txid: hex.decode('75ddabb27b8845f5247975c8a5ba7c6f336c4570708ebe230caf6db5217ae858'),\n  //   index: 0,\n  //   // tx hex from blockchain (required for non-SegWit UTXO)\n  //   nonWitnessUtxo: hex.decode(\n  //     '0200000001aad73931018bd25f84ae400b68848be09db706eac2ac18298babee71ab656f8b0000000048473044022058f6fc7c6a33e1b31548d481c826c015bd30135aad42cd67790dab66d2ad243b02204a1ced2604c6735b6393e5b41691dd78b00f0c5942fb9f751856faa938157dba01feffffff0280f0fa020000000017a9140fb9463421696b82c833af241c78c17ddbde493487d0f20a270100000017a91429ca74f8a08f81999428185c97b5d852e4063f618765000000'\n  //   ),\n  // },\n];\nconst outputs = [\n  { address: '2MvpbAgedBzJUBZWesDwdM7p3FEkBEwq3n3', amount: 50_000n }, // amount in satoshi\n  {\n    address: 'bcrt1pw53jtgez0wf69n06fchp0ctk48620zdscnrj8heh86wykp9mv20q7vd3gm',\n    amount: btc.Decimal.decode('0.5'), // amount in btc\n  },\n];\n// Send all utxo to specific address (consolidation):\n// const selected = btc.selectUTXO(utxo, [], 'all', {\n//   changeAddress: 'bcrt1pea3850rzre54e53eh7suwmrwc66un6nmu9npd7eqrhd6g4lh8uqsxcxln8', ...\nconst selected = btc.selectUTXO(utxo, outputs, 'default', {\n  changeAddress: 'bcrt1pea3850rzre54e53eh7suwmrwc66un6nmu9npd7eqrhd6g4lh8uqsxcxln8', // required, address to send change\n  feePerByte: 2n, // require, fee per vbyte in satoshi\n  bip69: true, // lexicographical Indexing of Transaction Inputs and Outputs\n  createTx: true, // create tx with selected inputs/outputs\n  network: regtest,\n});\n// NOTE: 'selected' will 'undefined' if there is not enough funds\ndeepStrictEqual(selected.fee, 394n); // estimated fee\ndeepStrictEqual(selected.change, true); // change address used\ndeepStrictEqual(selected.outputs, [\n  { address: '2MvpbAgedBzJUBZWesDwdM7p3FEkBEwq3n3', amount: 50000n },\n  {\n    address: 'bcrt1pw53jtgez0wf69n06fchp0ctk48620zdscnrj8heh86wykp9mv20q7vd3gm',\n    amount: 50_000_000n,\n  },\n  // Change address\n  // NOTE: with bip69 it is not necessarily last item in outputs\n  {\n    address: 'bcrt1pea3850rzre54e53eh7suwmrwc66un6nmu9npd7eqrhd6g4lh8uqsxcxln8',\n    amount: 99_949_606n,\n  },\n]);\n// No need to create tx manually!\nconst { tx } = selected;\ntx.sign(privKey);\ntx.finalize();\ndeepStrictEqual(tx.id, 'b702078d65edd65a84b2a97a669df5631b06f42a67b0d7090e540b02cc65aed5');\n// real tx fee, can be bigger than estimated, since we expect signatures of maximal size\ndeepStrictEqual(tx.fee, 394n);\n```\n\n## MuSig2\n\nMuSig2 implementation conforming to [BIP-327](https://github.com/bitcoin/bips/blob/master/bip-0327.mediawiki)\nis available in `@scure/btc-signer/musig2`. Check out [bip327-musig2.test.js](./test/bip327-musig2.test.js) as well:\n\n```ts\nimport * as musig2 from '@scure/btc-signer/musig2';\n// MuSig2 Multi-signature for Alice, Bob, and Carol\n// 1. Key Generation (for each signer: Alice, Bob, Carol)\n// - Alice's key generation\nconst aliceSecretKey = randomBytes(32); // Alice generates a random 32-byte secret key\nconst alicePublicKey = musig2.IndividualPubkey(aliceSecretKey); // Alice derives her individual public key from her secret key\n// - Bob's key generation\nconst bobSecretKey = randomBytes(32); // Bob generates a random 32-byte secret key\nconst bobPublicKey = musig2.IndividualPubkey(bobSecretKey); // Bob derives his individual public key from his secret key\n// - Carol's key generation\nconst carolSecretKey = randomBytes(32); // Carol generates a random 32-byte secret key\nconst carolPublicKey = musig2.IndividualPubkey(carolSecretKey); // Carol derives her individual public key from her secret key\n\n// 2. Key Aggregation (All signers participate by sharing public keys)\nconst individualPublicKeys = [alicePublicKey, bobPublicKey, carolPublicKey]; // Collect all individual public keys\nconst sortedPublicKeys = musig2.sortKeys(individualPublicKeys); // Sort public keys lexicographically (as required by MuSig2)\nconst aggregatePublicKey = musig2.keyAggExport(musig2.keyAggregate(sortedPublicKeys)); // Extract the X-only aggregate public key (32 bytes)\n// At this point, all signers have the 'aggregatePublicKey' and 'keyAggContext'.\n// 3. Nonce Generation - Round 1 (Each signer generates and broadcasts public nonce)\nconst msg = new Uint8Array(32).fill(5); // Example message to be signed (32-byte message is recommended for BIP340)\n// Alice generates her nonce\nconst aliceNonces = musig2.nonceGen(alicePublicKey, aliceSecretKey, aggregatePublicKey, msg);\n// Secret nonce: must be kept secret and used only once per signing session!\n// Public nonce: to be shared with Bob and Carol\n// Bob generates his nonce\nconst bobNonces = musig2.nonceGen(bobPublicKey, bobSecretKey, aggregatePublicKey, msg);\n// Carol generates her nonce\nconst carolNonces = musig2.nonceGen(carolPublicKey, carolSecretKey, aggregatePublicKey, msg);\n// Each signer creates own instance\nconst session = new musig2.Session(\n  // 4. Nonce Aggregation (All signers participate by sharing public nonces)\n  musig2.nonceAggregate([aliceNonces.public, bobNonces.public, carolNonces.public]),\n  sortedPublicKeys,\n  msg\n);\n// At this point, all signers have the 'aggregateNonce'.\n// 5. Partial Signature Generation - Round 2 (Each signer generates partial signature)\n// Alice generates her partial signature\nconst alicePartialSignature = session.sign(aliceNonces.secret, aliceSecretKey);\n// Bob generates his partial signature\nconst bobPartialSignature = session.sign(bobNonces.secret, bobSecretKey);\n// Carol generates her partial signature\nconst carolPartialSignature = session.sign(carolNonces.secret, carolSecretKey);\n// 6. Partial Signature Aggregation (Anyone can aggregate partial signatures)\nconst partialSignatures = [alicePartialSignature, bobPartialSignature, carolPartialSignature]; // Collect all partial signatures\nconst finalSignature = session.partialSigAgg(partialSignatures); // Aggregate partial signatures to create the final signature\n\n// 7. Signature Verification (Anyone can verify the final signature)\n// Verify the final signature\nimport { schnorr } from '@noble/curves/secp256k1';\nschnorr.verify(finalSignature, msg, aggregatePublicKey);\n```\n\n## Ordinals and custom scripts\n\nWe support custom scripts. You can pass it as last argument to `p2tr`.\n\nWe've developed separate [micro-ordinals](https://github.com/paulmillr/micro-ordinals) package, which contains:\n\n- Real code for ordinals / inscriptions / runes\n- CLI tool that allows to upload files as inscriptions\n- Example usage of custom scripts\n\n## Utils\n\n### secp256k1 keys\n\n```ts\nimport { pubSchnorr, signSchnorr } from '@scure/btc-signer/utils';\nimport { pubECDSA, signECDSA } from '@scure/btc-signer/utils';\nimport { randomPrivateKeyBytes } from '@scure/btc-signer/utils';\n\nconst priv = randomPrivateKeyBytes();\nconst pub = pubSchnorr(priv);\n```\n\n### getAddress\n\nReturns common addresses from privateKey\n\n```ts\nconst privKey = hex.decode('0101010101010101010101010101010101010101010101010101010101010101');\ndeepStrictEqual(btc.getAddress('pkh', privKey), '1C6Rc3w25VHud3dLDamutaqfKWqhrLRTaD'); // P2PKH (legacy address)\ndeepStrictEqual(btc.getAddress('wpkh', privKey), 'bc1q0xcqpzrky6eff2g52qdye53xkk9jxkvrh6yhyw'); // SegWit V0 address\ndeepStrictEqual(\n  btc.getAddress('tr', priv),\n  'bc1p33wm0auhr9kkahzd6l0kqj85af4cswn276hsxg6zpz85xe2r0y8syx4e5t'\n); // TapRoot KeyPathSpend\n```\n\n#### WIF\n\nEncoding/decoding of WIF privateKeys. Only compressed keys are supported for now.\n\n```ts\nconst privKey = hex.decode('0101010101010101010101010101010101010101010101010101010101010101');\ndeepStrictEqual(btc.WIF().encode(privKey), 'KwFfNUhSDaASSAwtG7ssQM1uVX8RgX5GHWnnLfhfiQDigjioWXHH');\ndeepStrictEqual(\n  hex.encode(btc.WIF().decode('KwFfNUhSDaASSAwtG7ssQM1uVX8RgX5GHWnnLfhfiQDigjioWXHH')),\n  '0101010101010101010101010101010101010101010101010101010101010101'\n);\n```\n\n### Script\n\nEncoding/decoding bitcoin scripts\n\n```ts\ndeepStrictEqual(\n  btc.Script.decode(\n    hex.decode(\n      '5221030000000000000000000000000000000000000000000000000000000000000001210300000000000000000000000000000000000000000000000000000000000000022103000000000000000000000000000000000000000000000000000000000000000353ae'\n    )\n  ).map((i) => (P.isBytes(i) ? hex.encode(i) : i)),\n  [\n    'OP_2',\n    '030000000000000000000000000000000000000000000000000000000000000001',\n    '030000000000000000000000000000000000000000000000000000000000000002',\n    '030000000000000000000000000000000000000000000000000000000000000003',\n    'OP_3',\n    'CHECKMULTISIG',\n  ]\n);\ndeepStrictEqual(\n  hex.encode(\n    btc.Script.encode([\n      'OP_2',\n      hex.decode('030000000000000000000000000000000000000000000000000000000000000001'),\n      hex.decode('030000000000000000000000000000000000000000000000000000000000000002'),\n      hex.decode('030000000000000000000000000000000000000000000000000000000000000003'),\n      'OP_3',\n      'CHECKMULTISIG',\n    ])\n  ),\n  '5221030000000000000000000000000000000000000000000000000000000000000001210300000000000000000000000000000000000000000000000000000000000000022103000000000000000000000000000000000000000000000000000000000000000353ae'\n);\n```\n\n### OutScript\n\nEncoding / decoding of output scripts\n\n```ts\ndeepStrictEqual(\n  btc.OutScript.decode(\n    hex.decode(\n      '5221030000000000000000000000000000000000000000000000000000000000000001210300000000000000000000000000000000000000000000000000000000000000022103000000000000000000000000000000000000000000000000000000000000000353ae'\n    )\n  ),\n  {\n    type: 'ms',\n    m: 2,\n    pubkeys: [\n      '030000000000000000000000000000000000000000000000000000000000000001',\n      '030000000000000000000000000000000000000000000000000000000000000002',\n      '030000000000000000000000000000000000000000000000000000000000000003',\n    ].map(hex.decode),\n  }\n);\ndeepStrictEqual(\n  hex.encode(\n    btc.OutScript.encode({\n      type: 'ms',\n      m: 2,\n      pubkeys: [\n        '030000000000000000000000000000000000000000000000000000000000000001',\n        '030000000000000000000000000000000000000000000000000000000000000002',\n        '030000000000000000000000000000000000000000000000000000000000000003',\n      ].map(hex.decode),\n    })\n  ),\n  '5221030000000000000000000000000000000000000000000000000000000000000001210300000000000000000000000000000000000000000000000000000000000000022103000000000000000000000000000000000000000000000000000000000000000353ae'\n);\n```\n\n## Bitcoin is flawed\n\nBitcoin is more complex than ETH / SOL despite having less features:\n\n- **Legacy:** too much decade-old code / standards\n- **Overengineering:** features were designed to be extensible and future-proof; then abandoned when future arrived.\n  - Transaction has `version` field, which is nice, allowing to change format later, however when there\n    was first change (SegWit V0), instead of using different tx version, there was hack with zero-inputs prefix\n    (tx cannot have zero inputs, so inputsCount=0 + '01' flag after that for tx version with witness data).\n    Probably it was done so it won't interfere with different transaction versions of different coins.\n    However, there is also `txVersion=2` (BIP68) which changes lockTime behaviour, but not tx format.\n  - There is bech32/witness program addresses, which is very extensible. By default rules software should\n    support future versions (0..16), so there will be no change in libraries to support new addresses.\n    However, even after first update (version 0 to 1) format of addresses itself changed from bech32 to bech32m,\n    so whole mechanic of different address versions is already unused. Also, supporting future version\n    of addresses is cool, but they are currently unspendable and we cannot know rules for spending new version address,\n    which means any new version address created now will be unspendable in future (SegWitV0->SegWitV1(taproot) even\n    changes public key format). So we cannot use this whole mechanic of future addresses at all (or users can accidentally create unspendable address and lose coins).\n  - PSBT supports unknown fields, according to spec we need to pass them as is, without modifications.\n    It was probably done this way to be future-proof: new version of PSBT can be parsed with old parser, which will ignore new fields. However, when future came (PSBTv2), format significantly changed (no `global.unsignedTx`) anyway.\n- **Bad BIP specs:** likely because there is only one relevant BTC Core implementation.\n  - To implement something, specs are not enough: need to read source code of Core (which is very complex, especially functional tests which re-implement parts in python) and other bitcoin libraries (such as bitcoinjs-lib)\n  - No one cares about specs much: for example, in [BIP174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki),\n    despite being old 2017 spec, formatting issues still haven't been fixed: `m/0&#39;/0&#39;/0&#39;`\n  - [BIP174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki) multisig example has unsorted partialSig field\n    inside input (it's better to sort it)\n  - Many PSBT tests are in format of `valid/invalid` (especially for PSBTv2), which isn't very helpful.\n    Parser which produces garbage, but doesn't throw exception, is still broken.\n- **Major flaws in PSBT:**\n  - PSBT was designed to be opaque key-value store. Combiner only needed to merge dictories, without a need to understand\n    fields. However, parsing requires to understand `unsignedTx`, since there is no input/output count in format itself.\n  - Instead of `global, inputCount, inputs[], outputCount, outputs[]`, inputCount and outputCount are stored inside\n    `global.unsignedTx` (v0) or `global.inputCount/global.outputCount` (v2), which means in order to parse\n    basic structure we need to completely parse global KV and understand its fields.\n  - **Security issue:** Unknown PSBT fields can be used to pass some code to backdoored wallets while being ignore by others.\n  - In JS, it is even harder to implement properly, because JS doesn't support complex keys in objects / dicts.\n    There is whole controlBlock of taproot in key inside tapLeafScript, which we need to parse, leading to structure like:\n    `{key: {version, internalKey, merklePath}, value: {script, version}`.\n    But, since there is no support for complex keys, we cannot do `correct by construction` using js objects,\n    we need to do this dict as array and constantly check if keys are unique.\n\n## Security\n\nThe library has been independently audited:\n\n- at version 0.3.0, in Feb 2023, by [cure53](https://cure53.de)\n  - PDFs: [online](https://cure53.de/audit-report_micro-btc-signer.pdf), [offline](./audit/2023-02-21-cure53-audit-report.pdf)\n  - [Changes since audit](https://github.com/paulmillr/scure-btc-signer/compare/0.3.0..main).\n  - The audit has been funded by [Ryan Shea](https://shea.io)\n\nMuSig2 and UTXO selection has not been audited yet.\nCommit [58d4554](58d455480919e968aabff132503560effb2f8eaf)\nsplit the library from one into several files to ease future maintainability.\n\nIf you see anything unusual: investigate and report.\n\n### Supply chain security\n\n- **Commits** are signed with PGP keys, to prevent forgery. Make sure to verify commit signatures\n- **Releases** are transparent and built on GitHub CI. Make sure to verify [provenance](https://docs.npmjs.com/generating-provenance-statements) logs\n- **Rare releasing** is followed to ensure less re-audit need for end-users\n- **Dependencies** are minimized and locked-down: any dependency could get hacked and users will be downloading malware with every install.\n  - We make sure to use as few dependencies as possible\n  - Automatic dep updates are prevented by locking-down version ranges; diffs are checked with `npm-diff`\n- **Dev Dependencies** are disabled for end-users; they are only used to develop / build the source code\n\nFor this package, there are 4 dependencies; and a few dev dependencies:\n\n- [noble-hashes](https://github.com/paulmillr/noble-hashes) provides cryptographic hashing functionality\n- [noble-curves](https://github.com/paulmillr/noble-curves) provides secp256k1 elliptic curve\n- [scure-base](https://github.com/paulmillr/scure-base) provides base58 and bech32\n- [micro-packed](https://github.com/paulmillr/micro-packed) is responsible for binary encoding\n- micro-bmark, micro-should and jsbt are used for benchmarking / testing / build tooling and developed by the same author\n- prettier, fast-check and typescript are used for code quality / test generation / ts compilation. It's hard to audit their source code thoroughly and fully because of their size\n\n## Contributing & testing\n\n- `npm install && npm run build && npm test` will build the code and run tests.\n- `npm run lint` / `npm run format` will run linter / fix linter issues.\n- `npm run build:release` will build single file\n\n## License\n\nMIT (c) Paul Miller [(https://paulmillr.com)](https://paulmillr.com), see LICENSE file.\n","readmeFilename":"README.md"}