Fg

.github/workflows/main_ci.yml

@@ -0,0 +1,60 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  unit:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [14, 'lts/*']
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+    steps:
+      - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 # v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@eeb10cff27034e7acf239c5d29f62154018672fd # v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: https://registry.npmjs.org/
+          cache: 'npm'
+      - run: npm i
+      - run: npm run unit
+  coverage:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [14, 'lts/*']
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+    steps:
+      - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 # v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@eeb10cff27034e7acf239c5d29f62154018672fd # v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: https://registry.npmjs.org/
+          cache: 'npm'
+      - run: npm i
+      - run: npm run coverage
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [14, 'lts/*']
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+    steps:
+      - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 # v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@eeb10cff27034e7acf239c5d29f62154018672fd # v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: https://registry.npmjs.org/
+          cache: 'npm'
+      - run: npm i
+      - run: npm run standard

README.md

@@ -36,7 +36,16 @@ let utxos = [
     txId: '...',
     vout: 0,
     ...,
-    value: 10000
+    value: 10000,
+    // For use with PSBT:
+    // not needed for coinSelect, but will be passed on to inputs later
+    nonWitnessUtxo: Buffer.from('...full raw hex of txId tx...', 'hex'),
+    // OR
+    // if your utxo is a segwit output, you can use witnessUtxo instead
+    witnessUtxo: {
+      script: Buffer.from('... scriptPubkey hex...', 'hex'),
+      value: 10000 // 0.0001 BTC and is the exact same as the value above
+    }
   }
 ]
 let targets = [
@@ -56,9 +65,17 @@ console.log(fee)
 // .inputs and .outputs will be undefined if no solution was found
 if (!inputs || !outputs) return
 
-let txb = new bitcoin.TransactionBuilder()
-
-inputs.forEach(input => txb.addInput(input.txId, input.vout))
+let psbt = new bitcoin.Psbt()
+
+inputs.forEach(input =>
+  psbt.addInput({
+    hash: input.txId,
+    index: input.vout,
+    nonWitnessUtxo: input.nonWitnessUtxo,
+    // OR (not both)
+    witnessUtxo: input.witnessUtxo,
+  })
+)
 outputs.forEach(output => {
   // watch out, outputs may have been added that you need to provide
   // an output address/script for
@@ -67,7 +84,10 @@ outputs.forEach(output => {
     wallet.nextChangeAddress()
   }
 
-  txb.addOutput(output.address, output.value)
+  psbt.addOutput({
+    address: output.address,
+    value: output.value,
+  })
 })
 ```
 

index.d.ts

@@ -0,0 +1,20 @@
+export interface UTXO {
+    txid: string | Buffer,
+    vout: number,
+    value: number,
+    nonWitnessUtxo? : Buffer,
+    witnessUtxo? : {
+        script: Buffer,
+        value: number
+    }
+}
+export interface Target {
+    address: string,
+    value?: number
+}
+export interface SelectedUTXO {
+    inputs?: UTXO[],
+    outputs?: Target[],
+    fee: number
+}
+export default function coinSelect(utxos: UTXO[], outputs: Target[], feeRate: number): SelectedUTXO;