Merge pull request #91 from Permissionless-Software-Foundation/ct-unstable

Production improvements

production/docker/bch-dex-ui/Dockerfile

@@ -46,11 +46,11 @@ WORKDIR /home/safeuser
 
 # Clone the rest.bitcoin.com repository
 WORKDIR /home/safeuser
-RUN git clone https://github.com/Permissionless-Software-Foundation/bch-dex-ui-v2
+RUN git clone https://github.com/Permissionless-Software-Foundation/bch-dex-ui-v3
 
 # Switch to the desired branch. `master` is usually stable,
 # and `stage` has the most up-to-date changes.
-WORKDIR /home/safeuser/bch-dex-ui-v2
+WORKDIR /home/safeuser/bch-dex-ui-v3
 
 # For development: switch to unstable branch
 RUN git checkout ct-unstable
@@ -61,13 +61,13 @@ RUN git checkout ct-unstable
 RUN npm install
 
 # Build the site
-RUN CI=true npm run build
+RUN npm run build
 
 # Load the NGINX image.
 FROM nginx
 EXPOSE 80
 
 # Copy the files built in the first container to the new NGINX container.
-COPY --from=builder /home/safeuser/bch-dex-ui-v2/build /usr/share/nginx/html
+COPY --from=builder /home/safeuser/bch-dex-ui-v3/build /usr/share/nginx/html
 
 #USER safeuser

src/adapters/localdb/models/order.js

@@ -10,20 +10,20 @@ import mongoose from 'mongoose'
 
 const Order = new mongoose.Schema({
   // Token data
-  tokenId: { type: String },
-  utxoTxid: { type: String },
-  utxoVout: { type: Number },
-  ticker: { type: String },
-  tokenType: { type: Number },
+  tokenId: { type: String, required: true },
+  utxoTxid: { type: String, required: true },
+  utxoVout: { type: Number, required: true },
+  ticker: { type: String, required: true },
+  tokenType: { type: Number, required: true },
 
   // Trade data
-  buyOrSell: { type: String },
-  numTokens: { type: Number },
-  rateInBaseUnit: { type: String },
+  buyOrSell: { type: String, required: true },
+  numTokens: { type: Number, required: true },
+  rateInBaseUnit: { type: String, required: true },
   minUnitsToExchange: { type: String },
   p2wdbTxid: { type: String },
   p2wdbHash: { type: String },
-  makerAddr: { type: String },
+  makerAddr: { type: String, required: true },
 
   // Authentication data
   signature: { type: String },
@@ -32,13 +32,16 @@ const Order = new mongoose.Schema({
   offerPubKey: { type: String },
 
   // Wallet Data
-  hdIndex: { type: Number }, // HD index address holding the UTXO for this offer.
+  hdIndex: { type: Number, required: true }, // HD index address holding the UTXO for this offer.
 
   // SWaP Protocol Properties
   lokadId: { type: String },
   messageType: { type: Number },
   messageClass: { type: Number },
-  nostrEventId: { type: String } // Nostr Event Id.
+  nostrEventId: { type: String, required: true }, // Nostr Event Id.
+
+  // Additional properties found in createOrder
+  dataType: { type: String, required: true }
 })
 
 export default mongoose.model('order', Order)

src/adapters/wallet.js

@@ -362,7 +362,7 @@ class WalletAdapter {
       throw err
     }
 
-  // return true
+    // return true
   }
 
   // Move tokens to an address controlled by the HD wallet, to generate a
@@ -467,6 +467,13 @@ class WalletAdapter {
   // then broadcasting the transaction to the network.
   async completeTx (hex, hdIndex) {
     try {
+      // Input validation
+      if (!hex || typeof hex !== 'string') {
+        throw new Error('hex must be a string!')
+      }
+      if (typeof hdIndex !== 'number' || hdIndex < 0) {
+        throw new Error('hdIndex must be a non-negative number!')
+      }
       // console.log('hex: ', hex)
       console.log('completeTx() hdIndex: ', hdIndex)
 
@@ -583,6 +590,16 @@ class WalletAdapter {
   async moveTokensFromCustomWallet (inObj = {}) {
     try {
       const { tokenId, qty, wallet } = inObj
+      // Input validation
+      if (!tokenId || typeof tokenId !== 'string') {
+        throw new Error('tokenId must be a string!')
+      }
+      if (!qty) {
+        throw new Error('qty must be a number!')
+      }
+      if (!wallet) {
+        throw new Error('wallet is required!')
+      }
 
       const keyPair = await this.getKeyPair()
       console.log('keyPair: ', keyPair)
@@ -607,17 +624,16 @@ class WalletAdapter {
       )
 
       const txid = await wallet.sendTokens(receiver, 3)
-      console.log('txid: ', txid)
       const utxoInfo = {
         txid,
         vout: 1,
-        hdIndex: wallet.walletInfo.hdIndex,
+        hdIndex: keyPair.hdIndex,
         tokenType: tokenUtxos[0].tokenType
       }
 
       return utxoInfo
     } catch (err) {
-      console.error('Error in wallet.js/moveTokens()')
+      console.error('Error in wallet.js/moveTokensFromCustomWallet()')
       throw err
     }
   }

test/unit/adapters/order-pagination.unit.js

@@ -47,7 +47,15 @@ describe('#OrderPagination', () => {
       timestamp: 'timestamp',
       localTimestamp: 'localTimestamp',
       txid: 'txid',
-      p2wdbHash: 'p2wdbHash'
+      p2wdbHash: 'p2wdbHash',
+      hdIndex: 0,
+      nostrEventId: 'nostrEventId',
+      dataType: 'dataType',
+      makerAddr: 'makerAddr',
+      rateInBaseUnit: 'rateInBaseUnit',
+      minUnitsToExchange: 'minUnitsToExchange',
+      ticker: 'ticker',
+      tokenType: 1
     })
     await order.save()
   })

test/unit/adapters/wallet.unit.js

@@ -0,0 +1,138 @@
+
+/*
+  Unit tests for the adapter/wallet.js library.
+*/
+
+// Global npm libraries
+import { assert } from 'chai'
+import sinon from 'sinon'
+
+import WalletAdapter from '../../../src/adapters/wallet.js'
+import { MockBchWallet } from '../mocks/adapters/wallet.js'
+
+describe('#wallet', () => {
+  let uut
+  let sandbox
+
+  beforeEach(() => {
+    uut = new WalletAdapter()
+    uut.bchWallet = new MockBchWallet()
+    uut.bitcoinJs = {
+      Transaction: {
+        fromHex: () => { return { } },
+        SIGHASH_ALL: () => { return { } }
+      },
+      TransactionBuilder: {
+        fromTransaction: () => { return { sign: () => { return { } }, build: () => { return { toHex: () => { return 'hex' } } } } }
+      },
+      ECPair: {
+        fromWIF: () => { return { } }
+      }
+    }
+    sandbox = sinon.createSandbox()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  describe('#moveTokensFromCustomWallet', () => {
+    it('should move tokens from a custom wallet', async () => {
+      sandbox.stub(uut, 'getKeyPair').resolves({
+        cashAddress: 'cashAddress',
+        wif: 'wif',
+        hdIndex: 11
+      })
+
+      const customWallet = new MockBchWallet()
+      customWallet.sendTokens = () => { return 'move token tx id result' }
+      customWallet.utxos.utxoStore.slpUtxos.type1.tokens = [
+        {
+          tokenId: 'tokenId',
+          tokenType: 1,
+          qty: 1
+        }
+      ]
+      const inObj = {
+        qty: 1,
+        wallet: customWallet,
+        tokenId: 'tokenId'
+      }
+      const result = await uut.moveTokensFromCustomWallet(inObj)
+      assert.equal(result.txid, 'move token tx id result')
+      assert.equal(result.hdIndex, 11)
+      assert.equal(result.tokenType, 1)
+      assert.equal(result.vout, 1)
+    })
+    it('should throw an error if the wallet is not provided', async () => {
+      try {
+        const inObj = {
+          qty: 1,
+          tokenId: 'tokenId'
+        }
+        await uut.moveTokensFromCustomWallet(inObj)
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.equal(error.message, 'wallet is required!')
+      }
+    })
+    it('should throw an error if the tokenId is not provided', async () => {
+      try {
+        const inObj = {
+          qty: 1,
+          wallet: new MockBchWallet()
+        }
+        await uut.moveTokensFromCustomWallet(inObj)
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.equal(error.message, 'tokenId must be a string!')
+      }
+    })
+    it('should throw an error if the qty is not provided', async () => {
+      try {
+        const inObj = {
+          tokenId: 'tokenId',
+          wallet: new MockBchWallet()
+        }
+        await uut.moveTokensFromCustomWallet(inObj)
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.equal(error.message, 'qty must be a number!')
+      }
+    })
+  })
+  describe('#completeTx', () => {
+    it('should complete a transaction', async () => {
+      sandbox.stub(uut, 'getKeyPair').resolves({
+        cashAddress: 'bitcoincash:qzl0d3gcqeypv4cy7gh8rgdszxa9vvm2acv7fqtd00',
+        wif: 'L5D2UAam8tvo3uii5kpgaGyjvVMimdrXu8nWGQSQjuuAix6ji1YQ',
+        hdIndex: 11
+      })
+      sandbox.stub(uut, 'deseralizeTx').resolves({
+        txid: 'complete tx id result'
+      })
+      sandbox.stub(uut.retryQueue, 'addToQueue').resolves('complete tx id result')
+
+      const hex = 'hex'
+      const hdIndex = 11
+      const txid = await uut.completeTx(hex, hdIndex)
+      assert.equal(txid, 'complete tx id result')
+    })
+    it('should throw an error if the hex is not provided', async () => {
+      try {
+        const hdIndex = 11
+        await uut.completeTx(null, hdIndex)
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.equal(error.message, 'hex must be a string!')
+      }
+    })
+    it('should throw an error if the hdIndex is not provided', async () => {
+      try {
+        const hex = 'hex'
+        await uut.completeTx(hex, null)
+        assert.fail('Unexpected code path')
+      } catch (error) {
+        assert.equal(error.message, 'hdIndex must be a non-negative number!')
+      }
+    })
+  })
+})

util/users/production/getUsers.js

@@ -0,0 +1,21 @@
+import mongoose from 'mongoose'
+// import config from '../../config/index.js'
+import User from '../../../src/adapters/localdb/models/users.js'
+
+const mongooseConnectStr = 'mongodb://172.17.0.1:5666/bch-swap-service-prod'
+
+async function getUsers () {
+  // Connect to the Mongo Database.
+  mongoose.Promise = global.Promise
+  mongoose.set('useCreateIndex', true) // Stop deprecation warning.
+  await mongoose.connect(
+    mongooseConnectStr,
+    { useNewUrlParser: true, useUnifiedTopology: true }
+  )
+
+  const users = await User.find({}, '-password')
+  console.log(`users: ${JSON.stringify(users, null, 2)}`)
+
+  mongoose.connection.close()
+}
+getUsers()

util/wallet/sweep-funds2.js

@@ -0,0 +1,83 @@
+/*
+  This script will travers the HD wallet and sweep funds and tokens back
+  into the root address (index 0). That root address needs to have funds
+  to pay for the transactions.
+
+  This version will traverse the HD index of the wallet until it reaches
+  the value in the nextAddress property. This ensures that all UTXOs
+  that could be used by the wallet have been swept.
+*/
+
+// Public npm libraries
+import BCHJS from '@psf/bch-js'
+
+import BchTokenSweep from 'bch-token-sweep'
+
+// Local libraries
+import WalletAdapter from '../../src/adapters/wallet.js'
+
+async function sweepFunds () {
+  try {
+    // Open the wallet files.
+    const wallet = new WalletAdapter()
+    const walletInfo = await wallet.openWallet()
+    const bchWallet = await wallet.instanceWallet(walletInfo)
+    console.log('walletInfo: ', walletInfo)
+
+    const lastIndex = walletInfo.nextAddress
+
+    const rootAddr = walletInfo.cashAddress
+    const rootWif = walletInfo.privateKey
+    console.log(`Sweeping all funds into root address ${rootAddr}...`)
+
+    // Generate an HD tree
+    const bchjs = new BCHJS()
+    const rootSeed = await bchjs.Mnemonic.toSeed(walletInfo.mnemonic)
+    const masterHDNode = bchjs.HDNode.fromSeed(rootSeed)
+
+    let hdIndex = 1
+
+    do {
+      // Generate a keypair from the HD wallet.
+      const childNode = masterHDNode.derivePath(`m/44'/245'/0'/0/${hdIndex}`)
+      const cashAddress = bchjs.HDNode.toCashAddress(childNode)
+      const wifToSweep = bchjs.HDNode.toWIF(childNode)
+
+      console.log(`\nSweeping HD Index ${hdIndex} with address ${cashAddress}`)
+
+      try {
+        // Sweep tokens from address
+        const sweeper = new BchTokenSweep(
+          wifToSweep,
+          rootWif,
+          bchWallet,
+          550,
+          rootAddr
+        )
+        await sweeper.populateObjectFromNetwork()
+
+        const hex = await sweeper.sweepTo(rootAddr)
+        // console.log(`hex: ${hex}`)
+
+        const txid = await sweeper.blockchain.broadcast(hex)
+
+        // console.log('Transaction ID', txid)
+        console.log(`Swept HD index ${hdIndex}. TXID: ${txid}`)
+
+        // Wait between loop iterations.
+        await bchjs.Util.sleep(3000)
+      } catch (err) {
+        console.log(`error message with index ${hdIndex}: ${err}`)
+      }
+
+      hdIndex++
+    } while (hdIndex <= lastIndex)
+
+    console.log(`${lastIndex} empty addresses detected. Exiting.`)
+
+    console.log('\n\nDo not forget to reset the nextAddress property in the wallet.json file!\n\n')
+  } catch (err) {
+    console.error('Error in sweepFunds(): ', err)
+  }
+}
+sweepFunds()