@scure/btc-signer 0.5.0 → 1.0.0

package/index.ts

@@ -26,6 +26,23 @@ const concat = P.concatBytes;
 // Make base58check work
 export const base58check = _b58(sha256);
 
+export function cloneDeep<T>(obj: T): T {
+  if (Array.isArray(obj)) return obj.map((i) => cloneDeep(i)) as unknown as T;
+  // slice of nodejs Buffer doesn't copy
+  else if (obj instanceof Uint8Array) return Uint8Array.from(obj) as unknown as T;
+  // immutable
+  else if (['number', 'bigint', 'boolean', 'string', 'undefined'].includes(typeof obj)) return obj;
+  // null is object
+  else if (obj === null) return obj;
+  // should be last, so it won't catch other types
+  else if (typeof obj === 'object') {
+    return Object.fromEntries(
+      Object.entries(obj).map(([k, v]) => [k, cloneDeep(v)])
+    ) as unknown as T;
+  }
+  throw new Error(`cloneDeep: unknown type=${obj} (${typeof obj})`);
+}
+
 enum PubT {
   ecdsa,
   schnorr,
@@ -463,7 +480,7 @@ const PSBTGlobal = {
   outputCount:      [0x05, false,      CompactSizeLen, [2], [2],    false],
   txModifiable:     [0x06, false,      P.U8,           [],  [2],    false],   // TODO: bitfield
   version:          [0xfb, false,      P.U32LE,        [],  [0, 2], false],
-  propietary:       [0xfc, BytesInf,   BytesInf,       [],  [0, 2], false],
+  proprietary:      [0xfc, BytesInf,   BytesInf,       [],  [0, 2], false],
 } as const;
 // prettier-ignore
 const PSBTInput = {
@@ -492,7 +509,7 @@ const PSBTInput = {
   tapBip32Derivation:     [0x16, Bytes32,             TaprootBIP32Der,  [],  [0, 2], false],
   tapInternalKey:         [0x17, false,               PubKeySchnorr,    [],  [0, 2], false],
   tapMerkleRoot:          [0x18, false,               Bytes32,          [],  [0, 2], false],
-  propietary:             [0xfc, BytesInf,            BytesInf,         [],  [0, 2], false],
+  proprietary:            [0xfc, BytesInf,            BytesInf,         [],  [0, 2], false],
 } as const;
 // All other keys removed when finalizing
 const PSBTInputFinalKeys: (keyof TransactionInput)[] = [
@@ -525,7 +542,7 @@ const PSBTOutput = {
   tapInternalKey:     [0x05, false,         PubKeySchnorr,   [],  [0, 2], false],
   tapTree:            [0x06, false,         tapTree,         [],  [0, 2], false],
   tapBip32Derivation: [0x07, PubKeySchnorr, TaprootBIP32Der, [],  [0, 2], false],
-  propietary:         [0xfc, BytesInf,      BytesInf,        [],  [0, 2], false],
+  proprietary:        [0xfc, BytesInf,      BytesInf,        [],  [0, 2], false],
 } as const;
 
 // Can be modified even on signed input
@@ -564,10 +581,11 @@ function PSBTKeyMap<T extends PSBTKeyMap>(psbtEnum: T): P.CoderType<PSBTKeyMapKe
         const val = value[name];
         if (val === undefined) continue;
         const [type, kc, vc] = psbtEnum[name];
-        if (!kc) out.push({ key: { type, key: P.EMPTY }, value: vc.encode(val) });
-        else {
+        if (!kc) {
+          out.push({ key: { type, key: P.EMPTY }, value: vc.encode(val) });
+        } else {
           // Low level interface, returns keys as is (with duplicates). Useful for debug
-          const kv: [Bytes, Bytes][] = val.map(
+          const kv: [Bytes, Bytes][] = val!.map(
             ([k, v]: [P.UnwrapCoder<typeof kc>, P.UnwrapCoder<typeof vc>]) => [
               kc.encode(k),
               vc.encode(v),
@@ -1538,10 +1556,7 @@ function cleanFinalInput(i: TransactionInput) {
 }
 
 export type TransactionOutput = P.UnwrapCoder<typeof PSBTOutputCoder>;
-export type TransactionOutputUpdate = ExtendType<
-  TransactionOutput,
-  { amount?: string | number; script?: string }
->;
+export type TransactionOutputUpdate = ExtendType<TransactionOutput, { script?: string }>;
 export type TransactionOutputRequired = {
   script: Bytes;
   amount: bigint;
@@ -1642,6 +1657,17 @@ function validateOpts(opts: TxOpts) {
 }
 
 export class Transaction {
+  private global: PSBTKeyMapKeys<typeof PSBTGlobal> = {};
+  private inputs: TransactionInput[] = []; // use getInput()
+  private outputs: TransactionOutput[] = []; // use getOutput()
+  readonly opts: ReturnType<typeof validateOpts>;
+  constructor(opts: TxOpts = {}) {
+    const _opts = (this.opts = validateOpts(opts));
+    // Merge with global structure of PSBTv2
+    if (_opts.lockTime !== DEFAULT_LOCKTIME) this.global.fallbackLocktime = _opts.lockTime;
+    this.global.txVersion = _opts.version;
+  }
+
   // Import
   static fromRaw(raw: Bytes, opts: TxOpts = {}) {
     const parsed = RawTx.decode(raw);
@@ -1687,7 +1713,7 @@ export class Transaction {
       ...i,
       ...parsed.global.unsignedTx?.outputs[j],
     }));
-    tx.global = { ...parsed.global, txVersion: version }; // just in case propietary/unknown fields
+    tx.global = { ...parsed.global, txVersion: version }; // just in case proprietary/unknown fields
     if (lockTime !== DEFAULT_LOCKTIME) tx.global.fallbackLocktime = lockTime;
     return tx;
   }
@@ -1725,16 +1751,6 @@ export class Transaction {
       outputs,
     });
   }
-  private global: PSBTKeyMapKeys<typeof PSBTGlobal> = {};
-  private inputs: TransactionInput[] = [];
-  private outputs: TransactionOutput[] = [];
-  readonly opts: ReturnType<typeof validateOpts>;
-  constructor(opts: TxOpts = {}) {
-    const _opts = (this.opts = validateOpts(opts));
-    // Merge with global structure of PSBTv2
-    if (_opts.lockTime !== DEFAULT_LOCKTIME) this.global.fallbackLocktime = _opts.lockTime;
-    this.global.txVersion = _opts.version;
-  }
 
   // BIP370 lockTime (https://github.com/bitcoin/bips/blob/master/bip-0370.mediawiki#determining-lock-time)
   get lockTime() {
@@ -1884,6 +1900,13 @@ export class Transaction {
     if (!Number.isSafeInteger(idx) || 0 > idx || idx >= this.inputs.length)
       throw new Error(`Wrong input index=${idx}`);
   }
+  getInput(idx: number) {
+    this.checkInputIdx(idx);
+    return cloneDeep(this.inputs[idx]);
+  }
+  get inputsLength() {
+    return this.inputs.length;
+  }
   // Modification
   private normalizeInput(
     i: TransactionInputUpdate,
@@ -1934,6 +1957,13 @@ export class Transaction {
     if (!Number.isSafeInteger(idx) || 0 > idx || idx >= this.outputs.length)
       throw new Error(`Wrong output index=${idx}`);
   }
+  getOutput(idx: number) {
+    this.checkOutputIdx(idx);
+    return cloneDeep(this.outputs[idx]);
+  }
+  get outputsLength() {
+    return this.outputs.length;
+  }
   private normalizeOutput(
     o: TransactionOutputUpdate,
     cur?: TransactionOutput,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scure/btc-signer",
-  "version": "0.5.0",
-  "description": "Audited minimal library for creating, signing & decoding Bitcoin transactions: with Schnorr, Taproot, UTXO & PSBT",
+  "version": "1.0.0",
+  "description": "Audited & minimal library for creating, signing & decoding Bitcoin transactions: with Schnorr, Taproot, UTXO & PSBT",
   "files": [
     "index.js",
     "index.js.map",
@@ -14,17 +14,17 @@
   "module": "index.js",
   "types": "index.d.ts",
   "dependencies": {
-    "@noble/curves": "~0.8.0",
-    "@noble/hashes": "~1.2.0",
-    "@scure/base": "~1.1.0",
+    "@noble/curves": "~1.0.0",
+    "@noble/hashes": "~1.3.0",
+    "@scure/base": "~1.1.1",
     "micro-packed": "~0.3.2"
   },
   "devDependencies": {
-    "@scure/bip32": "~1.1.0",
+    "@scure/bip32": "~1.3.0",
     "micro-packed-debugger": "0.3.1",
     "micro-should": "0.4.0",
-    "prettier": "2.6.2",
-    "typescript": "4.7.3"
+    "prettier": "2.8.4",
+    "typescript": "5.0.2"
   },
   "author": "Paul Miller (https://paulmillr.com)",
   "license": "MIT",