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

feat(categorizeToken): New field to Offer model, for UI display

package.json

@@ -52,11 +52,11 @@
     "koa2-ratelimit": "0.9.1",
     "libp2p": "^0.36.2",
     "line-reader": "0.4.0",
-    "minimal-slp-wallet": "5.0.3",
+    "minimal-slp-wallet": "5.1.0",
     "mongoose": "5.13.13",
     "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
     "nodemailer": "6.7.5",
-    "p2wdb": "1.4.0",
+    "p2wdb": "2.2.3",
     "passport-local": "1.0.0",
     "public-ip": "^4.0.4",
     "winston": "3.3.3",
@@ -67,19 +67,12 @@
     "bch-token-sweep": "2.1.2",
     "chai": "4.3.0",
     "coveralls": "2.11.4",
-    "eslint": "7.19.0",
-    "eslint-config-prettier": "7.2.0",
-    "eslint-config-standard": "16.0.2",
-    "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-prettier": "3.3.1",
-    "eslint-plugin-promise": "^4.3.1",
-    "eslint-plugin-standard": "4.0.0",
     "husky": "4.3.8",
     "mocha": "10.0.0",
     "nyc": "15.1.0",
     "semantic-release": "19.0.3",
     "sinon": "9.2.4",
-    "standard": "16.0.4",
+    "standard": "17.0.0",
     "uuid": "8.3.2"
   },
   "release": {

production/docker/docker-compose.yml

@@ -70,10 +70,10 @@ services:
     restart: always
 
   bch-dex:
-    build:
-      context: ./bch-dex/
-      dockerfile: Dockerfile
-    #image: christroutner/bch-dex:v1.9.2
+    #build:
+    #  context: ./bch-dex/
+    #  dockerfile: Dockerfile
+    image: christroutner/bch-dex:v1.9.6
     container_name: bch-dex
     environment:
       CONSUMER_URL: 'https://free-bch.fullstack.cash'

production/rpi-docker/docker-compose.yml

@@ -67,10 +67,10 @@ services:
     restart: always
 
   bch-dex:
-    #build:
-    # context: ./bch-dex/
-    #  dockerfile: Dockerfile
-    image: christroutner/bch-dex-rpi:v1.8.3
+    build:
+     context: ./bch-dex/
+     dockerfile: Dockerfile
+    #image: christroutner/bch-dex-rpi:v1.9.8
     container_name: bch-dex
     environment:
       CONSUMER_URL: 'https://free-bch.fullstack.cash'

production/scripts/sweep-nfts.js

@@ -64,6 +64,8 @@ async function sweepNfts () {
           if (thisToken.tokenType === 65) {
             console.log(`NFT ${thisToken.ticker} (${thisToken.name}) found. Sweeping to ${rootAddr}`)
 
+            await walletRoot.initialize()
+
             // Send BCH to the child address, to pay for transaction fees.
             const receiver1 = [{
               address: cashAddress,
@@ -76,6 +78,8 @@ async function sweepNfts () {
             console.log('Waiting for indexers to update...')
             await bchjs.Util.sleep(120000)
 
+            await walletChild.initialize()
+
             // Send NFT to root address.
             const receiver2 = [{
               address: rootAddr,

src/adapters/index.js

@@ -37,6 +37,7 @@ class Adapters {
     this.bch = new BCHAdapter()
     this.config = config
     this.wallet = new WalletAdapter()
+    localConfig.bchWallet = this.wallet.bchWallet
     this.p2wdb = new P2wdbAdapter(localConfig)
     this.webhook = new Webhook()
 
@@ -70,6 +71,10 @@ class Adapters {
 
         // Wait until a webhook is established with the P2WDB
         await this.webhook.waitUntilSuccess(this.config.webhookTarget)
+
+        // Overwrite instances of wallet used by P2WDB lib.
+        this.p2wdb.bchWallet = this.wallet.bchWallet
+        this.p2wdb.bchjs = this.wallet.bchWallet.bchjs
       }
 
       console.log('Async Adapters have been started.')

src/adapters/localdb/models/offer.js

@@ -27,6 +27,7 @@ const Offer = new mongoose.Schema({
   timestamp: { type: Number },
   globalTimestamp: { type: String },
   localTimestamp: { type: String },
+  displayCategory: { type: String },
 
   // SWaP Protocol Properties
   lokadId: { type: String },

src/adapters/p2wdb-adapter.js

@@ -12,9 +12,9 @@ const config = require('../../config')
 class P2wdbAdapter {
   constructor (localConfig = {}) {
     // Dependency injection
-    this.bchjs = localConfig.bchjs
-    if (!this.bchjs) {
-      throw new Error('Must pass an instance of bch-js when instantiating p2wdb.js adapter.')
+    this.bchWallet = localConfig.bchWallet
+    if (!this.bchWallet) {
+      throw new Error('Must pass an instance of minimal-slp-wallet as bchWallet when instantiating p2wdb.js adapter.')
     }
 
     // Encapsulate dependencies
@@ -22,6 +22,7 @@ class P2wdbAdapter {
     this.config = config
     this.Write = Write
     this.Read = Read
+    this.bchjs = this.bchWallet.bchjs
 
     // Allow the localConfig to overwrite the config file values.
     this.p2wdbURL = localConfig.p2wdbURL || config.p2wdbUrl
@@ -51,6 +52,10 @@ class P2wdbAdapter {
   // settings.
   instantiateWriteLib (wif) {
     try {
+      if (!wif) {
+        throw new Error('WIF input required when calling instantiateWriteLib()')
+      }
+
       // Object used to configure the Write library.
       let configObj = {}
 
@@ -62,7 +67,8 @@ class P2wdbAdapter {
           wif,
           serverURL: this.p2wdbURL,
           restURL: this.bchjs.restURL,
-          apiToken: this.bchjs.apiToken
+          apiToken: this.bchjs.apiToken,
+          bchWallet: this.bchWallet
         }
       } else {
         // Use web 3 infrastructure.
@@ -72,7 +78,8 @@ class P2wdbAdapter {
           wif,
           serverURL: this.p2wdbURL,
           interface: 'consumer-api',
-          restURL: this.config.consumerUrl
+          restURL: this.config.consumerUrl,
+          bchWallet: this.bchWallet
         }
       }
 

src/adapters/wallet.js

@@ -20,9 +20,10 @@ class WalletAdapter {
     // Encapsulate dependencies
     this.jsonFiles = new JsonFiles()
     this.WALLET_FILE = WALLET_FILE
-    this.BchWallet = BchWallet
     this.config = config
     this.bitcoinJs = bitcoinJs
+    this.BchWallet = BchWallet
+    this.bchWallet = {} // Will be replaced when initialized.
   }
 
   // Open the wallet file, or create one if the file doesn't exist.
@@ -91,6 +92,7 @@ class WalletAdapter {
 
       // Wait for wallet to initialize.
       await this.bchWallet.walletInfoPromise
+      await this.bchWallet.initialize()
       console.log(`BCH wallet initialized. Wallet address: ${this.bchWallet.walletInfo.cashAddress}`)
       // console.log(`this.bchWallet.walletInfo: ${JSON.stringify(this.bchWallet.walletInfo, null, 2)}`)
 

src/use-cases/offer/index.js

@@ -80,6 +80,12 @@ class OfferUseCases {
       const offerEntity = this.offerEntity.validate(offerObj)
       console.log('offerEntity: ', offerEntity)
 
+      // Generate a 'display category' for the token. This will allow the
+      // front end UI to figure out how to display the token.
+      const displayCategory = await this.categorizeToken(offerEntity)
+      console.log('displayCategory: ', displayCategory)
+      offerEntity.displayCategory = displayCategory
+
       // Add offer to the local database.
       const offerModel = new this.OfferModel(offerEntity)
       await offerModel.save()
@@ -91,6 +97,48 @@ class OfferUseCases {
     }
   }
 
+  // Categorize the token for display purposes. This will categorize a token
+  // into one of these categories:
+  // - nft
+  // - group
+  // - fungible
+  // - simple-nft
+  //
+  // The first three are easy to categorize. The simple-nft is a fungible token
+  // with a quantity of 1, decimals of 0, and no minting baton. Categorizing this
+  // type of token is the main reason why this function exists.
+  async categorizeToken (offerData) {
+    try {
+      console.log(`categorizeToken(): ${JSON.stringify(offerData, null, 2)}`)
+
+      const tokenId = offerData.tokenId
+
+      const tokenData = await this.adapters.wallet.bchWallet.getTokenData(tokenId)
+      console.log(`tokenData: ${JSON.stringify(tokenData, null, 2)}`)
+
+      if (tokenData.genesisData.type === 65) {
+        return 'nft'
+      }
+
+      // Create a set of checks to detect a simple NFT
+      const isType1 = tokenData.genesisData.type === 1
+      const hasNoMintingBaton = !tokenData.genesisData.mintBatonIsActive
+      const hasNoDecimals = !tokenData.genesisData.decimals
+      const hasQtyOfOne = parseInt(tokenData.genesisData.tokensInCirculationStr) === 1
+
+      if (isType1 && hasNoMintingBaton && hasNoDecimals && hasQtyOfOne) {
+        return 'simple-nft'
+      }
+
+      if (isType1) return 'fungible'
+
+      throw new Error(`Unknown token type: ${tokenData.genesisData.type}`)
+    } catch (err) {
+      console.error('Error in use-cases/offer/index.js categorizeToken(): ', err)
+      throw err
+    }
+  }
+
   async listOffers () {
     try {
       return this.OfferModel.find({}).sort('-timestamp')
@@ -122,15 +170,21 @@ class OfferUseCases {
       }
 
       // Verify that UTXO for sale is unspent. Abort if it's been spent.
-      const txid = offerInfo.utxoTxid
-      const vout = offerInfo.utxoVout
-      const utxoStatus = await this.adapters.bchjs.Blockchain.getTxOut(
-        txid,
-        vout
-      )
+      // const txid = offerInfo.utxoTxid
+      // const vout = offerInfo.utxoVout
+
+      const utxo = {
+        tx_hash: offerInfo.utxoTxid,
+        tx_pos: offerInfo.utxoVout
+      }
+      const utxoStatus = await this.adapters.wallet.bchWallet.utxoIsValid(utxo)
+      // const utxoStatus = await this.adapters.bchjs.Blockchain.getTxOut(
+      //   txid,
+      //   vout
+      // )
       console.log('utxoStatus: ', utxoStatus)
-      if (utxoStatus === null) {
-        console.log(`utxo txid: ${txid}, vout: ${vout}`)
+      if (!utxoStatus) {
+        console.log(`utxo txid: ${offerInfo.utxoTxid}, vout: ${offerInfo.utxoVout}`)
 
         // TODO: Mark this Offer as 'dead'
 
@@ -212,6 +266,9 @@ class OfferUseCases {
       await this.adapters.wallet.bchWallet.walletInfoPromise
       // console.log(`utxos: ${JSON.stringify(this.adapters.wallet.bchWallet.utxos.utxoStore, null, 2)}`)
 
+      // Refresh the wallet UTXOs
+      await this.adapters.wallet.bchWallet.initialize()
+
       // Ensure the app wallet has enough funds to write to the P2WDB.
       const wif = this.adapters.wallet.bchWallet.walletInfo.privateKey
       const canWriteToP2WDB = await this.adapters.p2wdb.checkForSufficientFunds(wif)
@@ -362,6 +419,8 @@ class OfferUseCases {
             tx_hash: thisOffer.utxoTxid,
             tx_pos: thisOffer.utxoVout
           }
+          // console.log(`Checking this UTXO: ${JSON.stringify(utxo, null, 2)}`)
+
           utxoStatus = await this.adapters.wallet.bchWallet.utxoIsValid(utxo)
           // console.log('utxoStatus: ', utxoStatus)
         } catch (err) {
@@ -379,7 +438,7 @@ class OfferUseCases {
         }
 
         // If the Offer UTXO is spent, delete the Offer model.
-        if (utxoStatus === null) {
+        if (!utxoStatus) {
           console.log(`Spent UTXO detected. Deleting this Offer: ${JSON.stringify(thisOffer, null, 2)}`)
           await thisOffer.remove()
         }

src/use-cases/order.js

@@ -225,7 +225,7 @@ class OrderLib {
         }
 
         // If the Order UTXO is spent, delete the Order model.
-        if (utxoStatus === null) {
+        if (!utxoStatus) {
           console.log(`Spent UTXO detected. Deleting this Order: ${JSON.stringify(thisOrder, null, 2)}`)
           await thisOrder.remove()
         }

test/unit/adapters/p2wdb.adapter.unit.js

@@ -5,31 +5,34 @@
 // Public npm libraries.
 const assert = require('chai').assert
 const sinon = require('sinon')
-const BCHJS = require('@psf/bch-js')
+// const BCHJS = require('@psf/bch-js')
+const BchWallet = require('minimal-slp-wallet/index.js')
 
 // Local libraries.
 const P2wdbAdapter = require('../../../src/adapters/p2wdb-adapter')
 
 describe('#P2wdbAdapter', () => {
-  let uut, sandbox
+  let uut, sandbox, bchWallet
 
-  beforeEach(() => {
-    const bchjs = new BCHJS()
+  beforeEach(async () => {
+    // const bchjs = new BCHJS()
+    bchWallet = new BchWallet()
+    await bchWallet.walletInfoPromise
 
-    uut = new P2wdbAdapter({ bchjs })
+    uut = new P2wdbAdapter({ bchWallet })
     sandbox = sinon.createSandbox()
   })
 
   afterEach(() => sandbox.restore())
 
   describe('#constructor', () => {
-    it('should throw error if bch-js is not passed in', () => {
+    it('should throw error if bchWallet is not passed in', () => {
       try {
         uut = new P2wdbAdapter()
 
         assert.fail('Unexpected coded path')
       } catch (err) {
-        assert.include(err.message, 'Must pass an instance of bch-js when instantiating p2wdb.js adapter.')
+        assert.include(err.message, 'Must pass an instance of minimal-slp-wallet as bchWallet when instantiating p2wdb.js adapter.')
       }
     })
   })
@@ -82,7 +85,7 @@ describe('#P2wdbAdapter', () => {
         assert.fail('Unexpected code path')
       } catch (err) {
         // console.log(err)
-        assert.include(err.message, 'WIF private key required')
+        assert.include(err.message, 'WIF input required when calling instantiateWriteLib()')
       }
     })
   })

test/unit/mocks/adapters/wallet.js

@@ -34,6 +34,7 @@ class MockBchWallet {
         tokenTicker: 'TROUT'
       }]
     }
+    this.getTokenData = async () => {}
 
     // Environment variable is used by wallet-balance.unit.js to force an error.
     if (process.env.NO_UTXO) {

test/unit/mocks/use-cases/offer-mock-data.js

@@ -0,0 +1,136 @@
+/*
+  Mocking data for Offer Use Case unit tests.
+*/
+
+const nftOffer01 = {
+ "messageType": 1,
+ "messageClass": 1,
+ "tokenId": "eb93f05553ff088bffb0ec687519e83c59e5108c160f7c25a4b6c45109d7e40b",
+ "buyOrSell": "sell",
+ "rateInBaseUnit": 7672536,
+ "minUnitsToExchange": 7672536,
+ "numTokens": 1,
+ "utxoTxid": "c736d73e274df20e9b069b4990d1a264fb80aa98d67cc6c7a39e42bff48e7c04",
+ "utxoVout": 1,
+ "timestamp": 1662930309998,
+ "globaltimestamp": "2022-09-11T21:05:09.998Z",
+ "localTimestamp": "9/11/2022, 9:05:09 PM",
+ "txid": "4266862b8358664996038d8c29d49dc0f3d3058fd1ef3d567b084e6b16ceb5b2",
+ "p2wdbHash": "zdpuArq7rCuVCGPyTnWpLjy9AYsh8yrbwjGdKwg2GDDALkM8t",
+ "offerStatus": "posted",
+ "makerAddr": "bitcoincash:qrqlz63cwmu0hcmsrfnd8jemn3atkpaqds6tf4ksrr",
+ "ticker": "TV001",
+ "tokenType": 65
+}
+
+const nftTokenData01 = {
+ "genesisData": {
+   "type": 65,
+   "ticker": "TV001",
+   "name": "Introduction to NFTs on BCH",
+   "tokenId": "eb93f05553ff088bffb0ec687519e83c59e5108c160f7c25a4b6c45109d7e40b",
+   "documentUri": "ipfs://bafybeibmgilu4lk3uivwyzhtm7jorl5zbsluewqmcsxs6otzrphh33okk4",
+   "documentHash": "c1731268f4873f1928438abdaf6ffc546d86a1817dc6f3c6bc73fbdfb4664f10",
+   "decimals": 0,
+   "mintBatonIsActive": false,
+   "tokensInCirculationBN": "1",
+   "tokensInCirculationStr": "1",
+   "blockCreated": 740395,
+   "totalBurned": "0",
+   "totalMinted": "1",
+   "parentGroupId": "030563ddd65772d8e9b79b825529ed53c7d27037507b57c528788612b4911107"
+ },
+ "immutableData": "ipfs://bafybeibmgilu4lk3uivwyzhtm7jorl5zbsluewqmcsxs6otzrphh33okk4",
+ "mutableData": "ipfs://bafybeifzhunfpodsztsj5x4ypopngkxuapbxwaxaxkahaybdktk6joqtlq"
+}
+
+const simpleNftOffer01 = {
+  "messageType": 1,
+  "messageClass": 1,
+  "tokenId": "a80c89d2f9f7ad7584743587c4950a0f28514ba8054e8cec4e871747cf9c162c",
+  "buyOrSell": "sell",
+  "rateInBaseUnit": 76725,
+  "minUnitsToExchange": 76725,
+  "numTokens": 1,
+  "utxoTxid": "dd51a8bf96c8ab16a2935b09e51650e1769a1fa75cce9f0455abdbf72071d3c2",
+  "utxoVout": 1,
+  "timestamp": 1662930102814,
+  "globaltimestamp": "2022-09-11T21:01:42.814Z",
+  "localTimestamp": "9/11/2022, 9:01:42 PM",
+  "txid": "4013177602ee75bbc5c4a67ea8d6d80e4f3d12b9c46ae2a6643911f48257b578",
+  "p2wdbHash": "zdpuAzyLPFBwFWbNi8XQuxgAx9aBNGWZEGqib7KE6Hp3AEEhq",
+  "offerStatus": "posted",
+  "makerAddr": "bitcoincash:qrqlz63cwmu0hcmsrfnd8jemn3atkpaqds6tf4ksrr",
+  "ticker": "BAA",
+  "tokenType": 1
+}
+
+const simpleNftTokenData01 = {
+  "genesisData": {
+    "type": 1,
+    "ticker": "BAA",
+    "name": "Bitcoin AI Art 001",
+    "tokenId": "a80c89d2f9f7ad7584743587c4950a0f28514ba8054e8cec4e871747cf9c162c",
+    "documentUri": "ipfs://bafybeifevvtnap3m3fsjbwnvpknvzhqihl2ouuypio33f2vtwqejipgpkq",
+    "documentHash": "d6213e5629d01fd2cd714cde709e11b888c0ba441e05bb1cc649f8b784df5a6c",
+    "decimals": 0,
+    "mintBatonIsActive": false,
+    "tokensInCirculationBN": "1",
+    "tokensInCirculationStr": "1",
+    "blockCreated": 757238,
+    "totalBurned": "0",
+    "totalMinted": "1"
+  },
+  "immutableData": "ipfs://bafybeifevvtnap3m3fsjbwnvpknvzhqihl2ouuypio33f2vtwqejipgpkq",
+  "mutableData": "ipfs://bafybeibqnsmmh6bkf2wwextetki4tly65z4r4qkrrpl5xwgvzdzjley6wm"
+}
+
+const fungibleOffer01 = {
+  "messageType": 1,
+  "messageClass": 1,
+  "tokenId": "a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2",
+  "buyOrSell": "sell",
+  "rateInBaseUnit": 7672,
+  "minUnitsToExchange": 7672,
+  "numTokens": 1,
+  "utxoTxid": "822dc4c765cc68314479c7707bba28028eacab6013bb683b1680dbcc9c95b286",
+  "utxoVout": 1,
+  "timestamp": 1662930501091,
+  "globaltimestamp": "2022-09-11T21:08:21.091Z",
+  "localTimestamp": "9/11/2022, 9:08:21 PM",
+  "txid": "7ee0ec32e116b068ff43c5516fa500058d14f53037ba5cc729e78eb51d1f1ffd",
+  "p2wdbHash": "zdpuB2gHDvmByfvPFLJgEAaRyUi1cwnD45Qt66y4f5tnMXFo7",
+  "offerStatus": "posted",
+  "makerAddr": "bitcoincash:qrqlz63cwmu0hcmsrfnd8jemn3atkpaqds6tf4ksrr",
+  "ticker": "TROUT",
+  "tokenType": 1
+}
+
+const fungibleTokenData01 = {
+  "genesisData": {
+    "type": 1,
+    "ticker": "TROUT",
+    "name": "Trout's test token",
+    "tokenId": "a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2",
+    "documentUri": "troutsblog.com",
+    "documentHash": "",
+    "decimals": 2,
+    "mintBatonIsActive": true,
+    "tokensInCirculationBN": "100097954686",
+    "tokensInCirculationStr": "100097954686",
+    "blockCreated": 622414,
+    "totalBurned": "2045314",
+    "totalMinted": "100100000000"
+  },
+  "immutableData": "troutsblog.com",
+  "mutableData": ""
+}
+
+module.exports = {
+  nftOffer01,
+  nftTokenData01,
+  simpleNftOffer01,
+  simpleNftTokenData01,
+  fungibleOffer01,
+  fungibleTokenData01
+}

test/unit/use-cases/offer.use-case.unit.js

@@ -13,6 +13,7 @@ const sinon = require('sinon')
 const OfferLib = require('../../../src/use-cases/offer')
 const OrderUseCase = require('../../../src/use-cases/order')
 const adapters = require('../mocks/adapters')
+const mockData = require('../mocks/use-cases/offer-mock-data.js')
 
 describe('#offer-use-case', () => {
   let uut
@@ -118,6 +119,7 @@ describe('#offer-use-case', () => {
         },
         coinbase: false
       })
+      sandbox.stub(uut, 'categorizeToken').resolves('fungible')
 
       const result = await uut.createOffer(offerObj)
       // console.log('result: ', result)
@@ -125,4 +127,39 @@ describe('#offer-use-case', () => {
       assert.equal(result, true)
     })
   })
+
+  describe('#categorizeToken', () => {
+    it('should categorize an NFT', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.adapters.wallet.bchWallet, 'getTokenData').resolves(mockData.nftTokenData01)
+
+      const offerData = mockData.nftOffer01
+
+      const result = await uut.categorizeToken(offerData)
+
+      assert.equal(result, 'nft')
+    })
+
+    it('should categorize a simple NFT', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.adapters.wallet.bchWallet, 'getTokenData').resolves(mockData.simpleNftTokenData01)
+
+      const offerData = mockData.simpleNftOffer01
+
+      const result = await uut.categorizeToken(offerData)
+
+      assert.equal(result, 'simple-nft')
+    })
+
+    it('should categorize a fungible token', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.adapters.wallet.bchWallet, 'getTokenData').resolves(mockData.fungibleTokenData01)
+
+      const offerData = mockData.fungibleOffer01
+
+      const result = await uut.categorizeToken(offerData)
+
+      assert.equal(result, 'fungible')
+    })
+  })
 })