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

Better error handling for tokens without mutable data

production/docker/docker-compose.yml

@@ -73,7 +73,7 @@ services:
     #build:
     #  context: ./bch-dex/
     #  dockerfile: Dockerfile
-    image: christroutner/bch-dex:v1.9.6
+    image: christroutner/bch-dex:v1.13.0
     container_name: bch-dex
     environment:
       CONSUMER_URL: 'https://free-bch.fullstack.cash'
@@ -97,7 +97,7 @@ services:
     #build:
     #  context: ./bch-dex-ui/
     #  dockerfile: Dockerfile
-    image: christroutner/bch-dex-ui:v1.6.6
+    image: christroutner/bch-dex-ui:v1.12.0
     container_name: dex-ui
     environment:
       SERVER: 'http://192.168.2.3'

production/rpi-docker/docker-compose.yml

@@ -46,7 +46,7 @@ services:
     image: christroutner/p2wdb-rpi:v3.0.10
     container_name: p2wdb
     environment:
-      CONSUMER_URL: 'https://free-bch.fullstack.cash'
+      CONSUMER_URL: 'https://wa-usa-bch-consumer.fullstackcash.nl'
       DEBUG_LEVEL: 1
     logging:
       driver: 'json-file'
@@ -67,13 +67,14 @@ services:
     restart: always
 
   bch-dex:
-    build:
-     context: ./bch-dex/
-     dockerfile: Dockerfile
-    #image: christroutner/bch-dex-rpi:v1.9.8
+    #build:
+    # context: ./bch-dex/
+    # dockerfile: Dockerfile
+    image: christroutner/bch-dex-rpi:v1.13.0
     container_name: bch-dex
     environment:
-      CONSUMER_URL: 'https://free-bch.fullstack.cash'
+      #CONSUMER_URL: 'https://free-bch.fullstack.cash'
+      CONSUMER_URL: 'https://wa-usa-bch-consumer.fullstackcash.nl'
     logging:
       driver: 'json-file'
       options:
@@ -94,7 +95,7 @@ services:
     #build:
     #  context: ./bch-dex-ui/
     #  dockerfile: Dockerfile
-    image: christroutner/bch-dex-ui-rpi:v1.7.5
+    image: christroutner/bch-dex-ui-rpi:v1.13.0
     container_name: dex-ui
     logging:
       driver: 'json-file'

src/adapters/localdb/models/offer.js

@@ -28,6 +28,8 @@ const Offer = new mongoose.Schema({
   globalTimestamp: { type: String },
   localTimestamp: { type: String },
   displayCategory: { type: String },
+  nsfw: { type: Boolean, default: false },
+  flags: { type: Array },
 
   // SWaP Protocol Properties
   lokadId: { type: String },

src/controllers/rest-api/offer/controller.js

@@ -49,14 +49,47 @@ class OfferRESTControllerLib {
     }
   }
 
-  // curl -X GET http://localhost:5700/offer/list
+  // curl -X GET http://localhost:5700/offer/list/all/0
   async listOffers (ctx) {
     try {
-      const offers = await _this.useCases.offer.listOffers()
+      let page = ctx.params.page
+      if (!page) page = 0
+
+      const offers = await _this.useCases.offer.listOffers(page)
 
       ctx.body = offers
     } catch (err) {
-      console.log('Error in listOffers REST API handler.')
+      console.log('Error in listOffers REST API handler: ', err)
+      _this.handleError(ctx, err)
+    }
+  }
+
+  // curl -X GET http://localhost:5700/offer/list/nft/0
+  async listNftOffers (ctx) {
+    try {
+      let page = ctx.params.page
+      if (!page) page = 0
+
+      const offers = await _this.useCases.offer.listNftOffers(page)
+
+      ctx.body = offers
+    } catch (err) {
+      console.log('Error in listNftOffers REST API handler: ', err)
+      _this.handleError(ctx, err)
+    }
+  }
+
+  // curl -X GET http://localhost:5700/offer/list/fungible/0
+  async listFungibleOffers (ctx) {
+    try {
+      let page = ctx.params.page
+      if (!page) page = 0
+
+      const offers = await _this.useCases.offer.listFungibleOffers(page)
+
+      ctx.body = offers
+    } catch (err) {
+      console.log('Error in Fungible REST API handler: ', err)
       _this.handleError(ctx, err)
     }
   }

src/controllers/rest-api/offer/index.js

@@ -50,8 +50,10 @@ class OfferRouter {
 
     // Define the routes and attach the controller.
     this.router.post('/', _this.offerRESTController.createOffer)
-    this.router.get('/list', _this.offerRESTController.listOffers)
     this.router.post('/take', _this.offerRESTController.takeOffer)
+    this.router.get('/list/all/:page', _this.offerRESTController.listOffers)
+    this.router.get('/list/nft/:page', _this.offerRESTController.listNftOffers)
+    this.router.get('/list/fungible/:page', _this.offerRESTController.listFungibleOffers)
 
     // Attach the Controller routes to the Koa app.
     app.use(_this.router.routes())

src/controllers/rest-api/p2wdb/controller.js

@@ -45,12 +45,23 @@ class P2WDBRESTControllerLib {
         const counterOffer = ctx.request.body
 
         await _this.useCases.offer.acceptCounterOffer(counterOffer)
+
+        //
       } else if (dataType.includes('offer')) {
         // Detect and handle new Offers
         console.log('offer data detected')
 
         const offerObj = ctx.request.body
         await _this.useCases.offer.createOffer(offerObj)
+
+        //
+      } else if (dataType.includes('flag')) {
+        // Detect and handle data generated by users flagging NSFW Offers.
+        const flagData = ctx.request.body
+        console.log('Flag type data received: ', flagData)
+
+        // const p2wdbHash = flagData.p2wdbHash
+        await _this.useCases.offer.flagOffer(flagData)
       } else {
         console.log('Could not route P2WDB webhook data.')
       }

src/use-cases/offer/index.js

@@ -13,10 +13,17 @@
   a partially signed transaction.
  */
 
+// Global npm libraries
+const axios = require('axios')
+
 // Local libraries
 const OfferEntity = require('../../entities/offer')
 const config = require('../../../config')
 
+const DEFAULT_ENTRIES_PER_PAGE = 20
+const NFT_ENTRIES_PER_PAGE = 6
+const FUNGIBLE_ENTRIES_PER_PAGE = 20
+
 class OfferUseCases {
   constructor (localConfig = {}) {
     // console.log('User localConfig: ', localConfig)
@@ -35,6 +42,7 @@ class OfferUseCases {
 
     // Encapsulate dependencies
     this.config = config
+    this.axios = axios
 
     this.offerEntity = new OfferEntity()
     this.OfferModel = this.adapters.localdb.Offer
@@ -80,12 +88,22 @@ class OfferUseCases {
       const offerEntity = this.offerEntity.validate(offerObj)
       console.log('offerEntity: ', offerEntity)
 
+      // Get data about the token.
+      const tokenId = offerEntity.tokenId
+      const tokenData = await this.adapters.wallet.bchWallet.getTokenData(tokenId)
+      console.log(`tokenData: ${JSON.stringify(tokenData, null, 2)}`)
+
       // 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)
+      const displayCategory = await this.categorizeToken(offerEntity, tokenData)
       console.log('displayCategory: ', displayCategory)
       offerEntity.displayCategory = displayCategory
 
+      // Detect if user set the NSFW flag.
+      let nsfw = false
+      nsfw = await this.detectNsfw(tokenData)
+      offerEntity.nsfw = nsfw
+
       // Add offer to the local database.
       const offerModel = new this.OfferModel(offerEntity)
       await offerModel.save()
@@ -97,6 +115,45 @@ class OfferUseCases {
     }
   }
 
+  // By default this function returns false, to indicate the NFT is safe for work.
+  // If the user who created the token sets the nsfw property in the mutable data,
+  // this function will return true.
+  async detectNsfw (tokenData) {
+    try {
+      let nsfw = false
+
+      const mutableCid = tokenData.mutableData
+
+      // If there is no mutable IPFS CID, then skip this token.
+      if (!mutableCid.includes('ipfs://')) return nsfw
+
+      // Revove the ipfs:// prefix.
+      const cid = mutableCid.substring(7)
+
+      // Retrieve the mutable data from Filecoin/IPFS.
+      const url = `https://${cid}.ipfs.w3s.link/data.json`
+      const result = await axios.get(url)
+      const mutableData = result.data
+      console.log(`mutableData: ${JSON.stringify(mutableData, null, 2)}`)
+
+      // Logical tests
+      const hasNsfw = !!mutableData.nsfw
+      const nsfwSetTrue = mutableData.nsfw === true
+      const nsfwStringTrue = mutableData.nsfw === 'true'
+      const nsfwDetected = hasNsfw && (nsfwSetTrue || nsfwStringTrue)
+
+      if (nsfwDetected) {
+        console.log('NSFW flag set as true')
+        nsfw = true
+      }
+
+      return nsfw
+    } catch (err) {
+      console.error('Error in detectNsfw(): ', err)
+      return false
+    }
+  }
+
   // Categorize the token for display purposes. This will categorize a token
   // into one of these categories:
   // - nft
@@ -107,14 +164,14 @@ class OfferUseCases {
   // 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) {
+  async categorizeToken (offerData, tokenData) {
     try {
-      console.log(`categorizeToken(): ${JSON.stringify(offerData, null, 2)}`)
+      // 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)}`)
+      // 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'
@@ -139,15 +196,64 @@ class OfferUseCases {
     }
   }
 
-  async listOffers () {
+  async listOffers (page = 0) {
     try {
-      return this.OfferModel.find({}).sort('-timestamp')
+      const data = await this.OfferModel.find({})
+      // Sort entries so newest entries show first.
+        .sort('-timestamp')
+      // Skip to the start of the selected page.
+        .skip(page * DEFAULT_ENTRIES_PER_PAGE)
+      // Only return 20 results.
+        .limit(DEFAULT_ENTRIES_PER_PAGE)
+
+      return data
     } catch (error) {
       console.error('Error in use-cases/offer/listOffers()')
       throw error
     }
   }
 
+  async listNftOffers (page = 0, nsfw = false) {
+    try {
+      const data = await this.OfferModel.find({
+        displayCategory: { $ne: 'fungible' },
+        nsfw
+      })
+      // Sort entries so newest entries show first.
+        .sort('-timestamp')
+      // Skip to the start of the selected page.
+        .skip(page * NFT_ENTRIES_PER_PAGE)
+      // Only return 20 results.
+        .limit(NFT_ENTRIES_PER_PAGE)
+
+      // console.log('listNftOffers() returning this data: ', data)
+
+      return data
+    } catch (error) {
+      console.error('Error in use-cases/offer/listNftOffers()')
+      throw error
+    }
+  }
+
+  async listFungibleOffers (page = 0) {
+    try {
+      const data = await this.OfferModel.find({ displayCategory: 'fungible' })
+      // Sort entries so newest entries show first.
+        .sort('-timestamp')
+      // Skip to the start of the selected page.
+        .skip(page * FUNGIBLE_ENTRIES_PER_PAGE)
+      // Only return 20 results.
+        .limit(FUNGIBLE_ENTRIES_PER_PAGE)
+
+      // console.log('listFungibleOffers() returning this data: ', data)
+
+      return data
+    } catch (error) {
+      console.error('Error in use-cases/offer/listFungibleOffers()')
+      throw error
+    }
+  }
+
   // Generate phase 2 of 3 - take the other side of an Offer.
   // Based on this example:
   // https://github.com/Permission=less-Software-Foundation/bch-js-examples/blob/master/bch/applications/collaborate/sell-slp/e2e-exchange/step2-purchase-tx.js
@@ -457,6 +563,34 @@ class OfferUseCases {
       throw err
     }
   }
+
+  async flagOffer (flagData) {
+    console.log(`flagData: ${JSON.stringify(flagData, null, 2)}`)
+
+    const p2wdbHash = flagData.data.p2wdbHash
+
+    // Get the offer from the database.
+    const offer = await this.findOfferByHash(p2wdbHash)
+    console.log(`Flagging this offer: ${JSON.stringify(offer, null, 2)}`)
+
+    if (!offer) {
+      throw new Error(`Offer ${p2wdbHash} not found in the database.`)
+    }
+
+    // Add the raw flag data to the database model.
+    offer.flags.push(flagData)
+
+    // If flag count is 3 or more, mark the Offer as NSFW
+    const flagCnt = offer.flags.length
+    if (flagCnt >= 3) {
+      offer.nsfw = true
+    }
+
+    // Save the updated offer data to the database.
+    await offer.save()
+
+    return true
+  }
 }
 
 module.exports = OfferUseCases

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

@@ -74,6 +74,9 @@ describe('#offer-use-case', () => {
 
       // Mock dependencies
       sandbox.stub(uut.adapters.bchjs.Blockchain, 'getTxOut').resolves(null)
+      sandbox.stub(uut.adapters.wallet.bchWallet, 'getTokenData').resolves({})
+      sandbox.stub(uut, 'categorizeToken').resolves('nft')
+      sandbox.stub(uut, 'detectNsfw').resolves(false)
 
       const result = await uut.createOffer(offerObj)
       // console.log('result: ', result)
@@ -120,6 +123,8 @@ describe('#offer-use-case', () => {
         coinbase: false
       })
       sandbox.stub(uut, 'categorizeToken').resolves('fungible')
+      sandbox.stub(uut.adapters.wallet.bchWallet, 'getTokenData').resolves({})
+      sandbox.stub(uut, 'detectNsfw').resolves(false)
 
       const result = await uut.createOffer(offerObj)
       // console.log('result: ', result)
@@ -131,33 +136,36 @@ describe('#offer-use-case', () => {
   describe('#categorizeToken', () => {
     it('should categorize an NFT', async () => {
       // Mock dependencies
-      sandbox.stub(uut.adapters.wallet.bchWallet, 'getTokenData').resolves(mockData.nftTokenData01)
+      // sandbox.stub(uut.adapters.wallet.bchWallet, 'getTokenData').resolves(mockData.nftTokenData01)
 
       const offerData = mockData.nftOffer01
+      const tokenData = mockData.nftTokenData01
 
-      const result = await uut.categorizeToken(offerData)
+      const result = await uut.categorizeToken(offerData, tokenData)
 
       assert.equal(result, 'nft')
     })
 
     it('should categorize a simple NFT', async () => {
       // Mock dependencies
-      sandbox.stub(uut.adapters.wallet.bchWallet, 'getTokenData').resolves(mockData.simpleNftTokenData01)
+      // sandbox.stub(uut.adapters.wallet.bchWallet, 'getTokenData').resolves(mockData.simpleNftTokenData01)
 
       const offerData = mockData.simpleNftOffer01
+      const tokenData = mockData.simpleNftTokenData01
 
-      const result = await uut.categorizeToken(offerData)
+      const result = await uut.categorizeToken(offerData, tokenData)
 
       assert.equal(result, 'simple-nft')
     })
 
     it('should categorize a fungible token', async () => {
       // Mock dependencies
-      sandbox.stub(uut.adapters.wallet.bchWallet, 'getTokenData').resolves(mockData.fungibleTokenData01)
+      // sandbox.stub(uut.adapters.wallet.bchWallet, 'getTokenData').resolves(mockData.fungibleTokenData01)
 
       const offerData = mockData.fungibleOffer01
+      const tokenData = mockData.fungibleTokenData01
 
-      const result = await uut.categorizeToken(offerData)
+      const result = await uut.categorizeToken(offerData, tokenData)
 
       assert.equal(result, 'fungible')
     })