@scure/btc-signer 1.2.1 → 1.3.0

package/README.md

@@ -9,9 +9,16 @@ Audited & minimal library for creating, signing & decoding Bitcoin transactions.
 - 🎻 Classic & SegWit: P2PK, P2PKH, P2WPKH, P2SH, P2WSH, P2MS
 - 🧪 Schnorr & Taproot BIP340/BIP341: P2TR, P2TR-NS, P2TR-MS
 - 📨 BIP174 PSBT
-- 🪶 3000 lines
+- 🗳️ Easy ordinals and inscriptions
+- 🪶 3300 lines
 
-Initial development has been funded by [Ryan Shea](https://shea.io). Check out [the demo](https://signerdemo.micro-btc.dev/) & [its github](https://github.com/shea256/micro-btc-web-demo).
+Initial development has been funded by [Ryan Shea](https://shea.io).
+
+For discussions, questions and support, visit
+[GitHub Discussions](https://github.com/paulmillr/scure-btc-signer/discussions)
+section of the repository.
+
+_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)
 
 ### This library belongs to _scure_
 
@@ -59,6 +66,7 @@ import * as btc from '@scure/btc-signer';
   - [Basic transaction sign](#basic-transaction-sign)
   - [BIP174 PSBT multi-sig example](#bip174-psbt-multi-sig-example)
 - [UTXO selection](#utxo-selection)
+- [Ordinals and custom scripts](#ordinals-and-custom-scripts)
 - [Utils](#utils)
   - [getAddress](#getaddress)
     - [WIF](#wif)
@@ -870,6 +878,19 @@ deepStrictEqual(tx.id, 'b702078d65edd65a84b2a97a669df5631b06f42a67b0d7090e540b02
 deepStrictEqual(tx.fee, 394n);
 ```
 
+## Ordinals and custom scripts
+
+We support custom scripts. You can pass it as last argument to `p2tr`.
+
+Ordinals, inscriptions, runes and others are handled by a separate package for now:
+[micro-ordinals](https://github.com/paulmillr/micro-ordinals).
+
+The package contains:
+
+- Real code for ordinals / inscriptions
+- CLI tool that allows to upload files as inscriptions
+- Example usage of custom scripts
+
 ## Utils
 
 ### getAddress
@@ -980,7 +1001,8 @@ The library has been independently audited:
   - [Changes since audit](https://github.com/paulmillr/scure-btc-signer/compare/0.3.0..main).
   - The audit has been funded by [Ryan Shea](https://shea.io)
 
-UTXO selection functionality has not been audited yet.
+UTXO selection functionality has not been audited yet. Commit [58d4554](58d455480919e968aabff132503560effb2f8eaf)
+split the library from one into several files to ease future maintainability.
 
 ### Supply chain security
 

package/lib/_type_test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=_type_test.d.ts.map

package/lib/_type_test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_type_test.d.ts","sourceRoot":"","sources":["../src/_type_test.ts"],"names":[],"mappings":""}

package/lib/_type_test.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const btc = require("./index.js");
+const base_1 = require("@scure/base");
+const secp256k1_1 = require("@noble/curves/secp256k1");
+const privKey1 = base_1.hex.decode('0101010101010101010101010101010101010101010101010101010101010101');
+const P1 = secp256k1_1.secp256k1.getPublicKey(privKey1, true);
+const wpkh = btc.p2wpkh(P1);
+const tx = new btc.Transaction();
+// Basic input test
+tx.addInput({
+    txid: base_1.hex.decode('0af50a00a22f74ece24c12cd667c290d3a35d48124a69f4082700589172a3aa2'),
+    index: 0,
+    ...wpkh,
+    finalScriptSig: new Uint8Array(),
+    sequence: 1,
+});
+// Doesn't force any fields on input addition (only on sign)
+tx.addInput({
+    sequence: 1,
+});
+tx.updateInput(0, {
+    sequence: 1,
+});
+const nonWitnessUtxo = '0200000001aad73931018bd25f84ae400b68848be09db706eac2ac18298babee71ab656f8b0000000048473044022058f6fc7c6a33e1b31548d481c826c015bd30135aad42cd67790dab66d2ad243b02204a1ced2604c6735b6393e5b41691dd78b00f0c5942fb9f751856faa938157dba01feffffff0280f0fa020000000017a9140fb9463421696b82c833af241c78c17ddbde493487d0f20a270100000017a91429ca74f8a08f81999428185c97b5d852e4063f618765000000';
+const nonWitnessUtxoB = base_1.hex.decode(nonWitnessUtxo);
+tx.updateInput(0, { nonWitnessUtxo: nonWitnessUtxo });
+tx.updateInput(0, { nonWitnessUtxo: nonWitnessUtxoB });
+tx.addInput({
+    txid: base_1.hex.decode('0af50a00a22f74ece24c12cd667c290d3a35d48124a69f4082700589172a3aa2'),
+    index: 0,
+    nonWitnessUtxo: nonWitnessUtxo,
+});
+tx.addInput({
+    txid: base_1.hex.decode('0af50a00a22f74ece24c12cd667c290d3a35d48124a69f4082700589172a3aa2'),
+    index: 0,
+    nonWitnessUtxo: nonWitnessUtxoB,
+});
+// Should fail!
+// tx.updateInput(0, {
+//   nonWitnessUtxo: 1,
+// });
+// Outputs
+tx.addOutput({ amount: 123n });
+// should fail
+// tx.updateOutput(0, { amount: '1' });
+// tx.updateOutput(0, { amount: 1 });
+// should fail
+// tx.addOutput({ amount: '123' });
+// tx.addOutput({ amount: 123 });
+for (let i = 0; i < tx.inputsLength; i++) {
+    // @ts-ignore
+    console.log('I', tx.getInput(i));
+}
+for (let i = 0; i < tx.outputsLength; i++) {
+    // @ts-ignore
+    console.log('O', tx.getOutput(i));
+}
+//# sourceMappingURL=_type_test.js.map

package/lib/_type_test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_type_test.js","sourceRoot":"","sources":["../src/_type_test.ts"],"names":[],"mappings":";;AAAA,kCAAkC;AAClC,sCAAkC;AAClC,uDAA4D;AAE5D,MAAM,QAAQ,GAAG,UAAG,CAAC,MAAM,CAAC,kEAAkE,CAAC,CAAC;AAChG,MAAM,EAAE,GAAG,qBAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AAE7C,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAE5B,MAAM,EAAE,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;AAEjC,mBAAmB;AACnB,EAAE,CAAC,QAAQ,CAAC;IACV,IAAI,EAAE,UAAG,CAAC,MAAM,CAAC,kEAAkE,CAAC;IACpF,KAAK,EAAE,CAAC;IACR,GAAG,IAAI;IACP,cAAc,EAAE,IAAI,UAAU,EAAE;IAChC,QAAQ,EAAE,CAAC;CACZ,CAAC,CAAC;AAEH,4DAA4D;AAC5D,EAAE,CAAC,QAAQ,CAAC;IACV,QAAQ,EAAE,CAAC;CACZ,CAAC,CAAC;AAEH,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE;IAChB,QAAQ,EAAE,CAAC;CACZ,CAAC,CAAC;AAEH,MAAM,cAAc,GAClB,wXAAwX,CAAC;AAC3X,MAAM,eAAe,GAAG,UAAG,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;AAEnD,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC,CAAC;AACtD,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,cAAc,EAAE,eAAe,EAAE,CAAC,CAAC;AACvD,EAAE,CAAC,QAAQ,CAAC;IACV,IAAI,EAAE,UAAG,CAAC,MAAM,CAAC,kEAAkE,CAAC;IACpF,KAAK,EAAE,CAAC;IACR,cAAc,EAAE,cAAc;CAC/B,CAAC,CAAC;AAEH,EAAE,CAAC,QAAQ,CAAC;IACV,IAAI,EAAE,UAAG,CAAC,MAAM,CAAC,kEAAkE,CAAC;IACpF,KAAK,EAAE,CAAC;IACR,cAAc,EAAE,eAAe;CAChC,CAAC,CAAC;AAEH,eAAe;AACf,sBAAsB;AACtB,uBAAuB;AACvB,MAAM;AACN,UAAU;AACV,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;AAC/B,cAAc;AACd,uCAAuC;AACvC,qCAAqC;AACrC,cAAc;AACd,mCAAmC;AACnC,iCAAiC;AAEjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE,CAAC;IACzC,aAAa;IACb,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACnC,CAAC;AAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;IAC1C,aAAa;IACb,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC"}

package/lib/esm/_type_test.js

@@ -0,0 +1,57 @@
+import * as btc from './index.js';
+import { hex } from '@scure/base';
+import { secp256k1 as secp } from '@noble/curves/secp256k1';
+const privKey1 = hex.decode('0101010101010101010101010101010101010101010101010101010101010101');
+const P1 = secp.getPublicKey(privKey1, true);
+const wpkh = btc.p2wpkh(P1);
+const tx = new btc.Transaction();
+// Basic input test
+tx.addInput({
+    txid: hex.decode('0af50a00a22f74ece24c12cd667c290d3a35d48124a69f4082700589172a3aa2'),
+    index: 0,
+    ...wpkh,
+    finalScriptSig: new Uint8Array(),
+    sequence: 1,
+});
+// Doesn't force any fields on input addition (only on sign)
+tx.addInput({
+    sequence: 1,
+});
+tx.updateInput(0, {
+    sequence: 1,
+});
+const nonWitnessUtxo = '0200000001aad73931018bd25f84ae400b68848be09db706eac2ac18298babee71ab656f8b0000000048473044022058f6fc7c6a33e1b31548d481c826c015bd30135aad42cd67790dab66d2ad243b02204a1ced2604c6735b6393e5b41691dd78b00f0c5942fb9f751856faa938157dba01feffffff0280f0fa020000000017a9140fb9463421696b82c833af241c78c17ddbde493487d0f20a270100000017a91429ca74f8a08f81999428185c97b5d852e4063f618765000000';
+const nonWitnessUtxoB = hex.decode(nonWitnessUtxo);
+tx.updateInput(0, { nonWitnessUtxo: nonWitnessUtxo });
+tx.updateInput(0, { nonWitnessUtxo: nonWitnessUtxoB });
+tx.addInput({
+    txid: hex.decode('0af50a00a22f74ece24c12cd667c290d3a35d48124a69f4082700589172a3aa2'),
+    index: 0,
+    nonWitnessUtxo: nonWitnessUtxo,
+});
+tx.addInput({
+    txid: hex.decode('0af50a00a22f74ece24c12cd667c290d3a35d48124a69f4082700589172a3aa2'),
+    index: 0,
+    nonWitnessUtxo: nonWitnessUtxoB,
+});
+// Should fail!
+// tx.updateInput(0, {
+//   nonWitnessUtxo: 1,
+// });
+// Outputs
+tx.addOutput({ amount: 123n });
+// should fail
+// tx.updateOutput(0, { amount: '1' });
+// tx.updateOutput(0, { amount: 1 });
+// should fail
+// tx.addOutput({ amount: '123' });
+// tx.addOutput({ amount: 123 });
+for (let i = 0; i < tx.inputsLength; i++) {
+    // @ts-ignore
+    console.log('I', tx.getInput(i));
+}
+for (let i = 0; i < tx.outputsLength; i++) {
+    // @ts-ignore
+    console.log('O', tx.getOutput(i));
+}
+//# sourceMappingURL=_type_test.js.map

package/lib/esm/_type_test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_type_test.js","sourceRoot":"","sources":["../../src/_type_test.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,EAAE,SAAS,IAAI,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAE5D,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,kEAAkE,CAAC,CAAC;AAChG,MAAM,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AAE7C,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAE5B,MAAM,EAAE,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;AAEjC,mBAAmB;AACnB,EAAE,CAAC,QAAQ,CAAC;IACV,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,kEAAkE,CAAC;IACpF,KAAK,EAAE,CAAC;IACR,GAAG,IAAI;IACP,cAAc,EAAE,IAAI,UAAU,EAAE;IAChC,QAAQ,EAAE,CAAC;CACZ,CAAC,CAAC;AAEH,4DAA4D;AAC5D,EAAE,CAAC,QAAQ,CAAC;IACV,QAAQ,EAAE,CAAC;CACZ,CAAC,CAAC;AAEH,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE;IAChB,QAAQ,EAAE,CAAC;CACZ,CAAC,CAAC;AAEH,MAAM,cAAc,GAClB,wXAAwX,CAAC;AAC3X,MAAM,eAAe,GAAG,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;AAEnD,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC,CAAC;AACtD,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,cAAc,EAAE,eAAe,EAAE,CAAC,CAAC;AACvD,EAAE,CAAC,QAAQ,CAAC;IACV,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,kEAAkE,CAAC;IACpF,KAAK,EAAE,CAAC;IACR,cAAc,EAAE,cAAc;CAC/B,CAAC,CAAC;AAEH,EAAE,CAAC,QAAQ,CAAC;IACV,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,kEAAkE,CAAC;IACpF,KAAK,EAAE,CAAC;IACR,cAAc,EAAE,eAAe;CAChC,CAAC,CAAC;AAEH,eAAe;AACf,sBAAsB;AACtB,uBAAuB;AACvB,MAAM;AACN,UAAU;AACV,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;AAC/B,cAAc;AACd,uCAAuC;AACvC,qCAAqC;AACrC,cAAc;AACd,mCAAmC;AACnC,iCAAiC;AAEjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE,CAAC;IACzC,aAAa;IACb,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACnC,CAAC;AAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;IAC1C,aAAa;IACb,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC"}