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

feat(getTokenData2): Adding token icon and media retrieval

LICENSE.md

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) 2021 Permissionless Software Foundation
+Copyright (c) 2022 Permissionless Software Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package-lock.json

@@ -9,12 +9,12 @@
       "version": "1.0.0",
       "license": "MIT",
       "dependencies": {
-        "@psf/bch-js": "6.4.1",
+        "@psf/bch-js": "6.5.1",
         "axios": "0.27.2",
         "bcryptjs": "2.4.3",
         "glob": "7.1.6",
         "ipfs": "0.62.3",
-        "ipfs-coord": "8.0.2",
+        "ipfs-coord": "8.0.5",
         "ipfs-http-client": "55.0.0",
         "jsonrpc-lite": "2.2.0",
         "jsonwebtoken": "8.5.1",
@@ -36,7 +36,7 @@
         "nodemailer": "6.7.5",
         "passport-local": "1.0.0",
         "public-ip": "4.0.4",
-        "semver": "^7.3.5",
+        "semver": "7.3.5",
         "winston": "3.3.3",
         "winston-daily-rotate-file": "4.5.0"
       },
@@ -1481,10 +1481,9 @@
       "license": "BSD-3-Clause"
     },
     "node_modules/@psf/bch-js": {
-      "version": "6.4.1",
-      "resolved": "http://94.130.170.209:4873/@psf%2fbch-js/-/bch-js-6.4.1.tgz",
-      "integrity": "sha512-/BLGzWH02VqaDNeY05QGMhrCtYDw5bXn45Egz+L5FLcyZaOqONR4kl80T6a8xvTPcREO4R+AjGTRBpfjdikwpA==",
-      "license": "MIT",
+      "version": "6.5.1",
+      "resolved": "https://registry.npmjs.org/@psf/bch-js/-/bch-js-6.5.1.tgz",
+      "integrity": "sha512-W52V6NCte/LJZ2TMJwXorq2FdwMMzjS94sh4slebrcUp6oHiAG+/NouQ4ID/I1DEJQlQnQpf2j3zxveCimDERQ==",
       "dependencies": {
         "@chris.troutner/bip32-utils": "1.0.5",
         "@psf/bip21": "2.0.1",
@@ -8840,10 +8839,9 @@
       }
     },
     "node_modules/ipfs-coord": {
-      "version": "8.0.2",
-      "resolved": "http://94.130.170.209:4873/ipfs-coord/-/ipfs-coord-8.0.2.tgz",
-      "integrity": "sha512-CdUH4GLLFArUDb8LIRAXxPlhbRQ44A5PEWB4J9zzDB3by93O7DLEgjqPqLDolalzrtiQBVzoARO/exZvdxBF+w==",
-      "license": "MIT",
+      "version": "8.0.5",
+      "resolved": "https://registry.npmjs.org/ipfs-coord/-/ipfs-coord-8.0.5.tgz",
+      "integrity": "sha512-V4pqR+MU290ZxFRE+Rx/7JuxR7LsOFBLuL0av3eVU5ZQWqeF/Zi9vh52zCqpp1IBCXi4QXNZGlysvm16xFDXww==",
       "dependencies": {
         "axios": "0.21.4",
         "bch-encrypt-lib": "2.0.0",
@@ -12855,10 +12853,9 @@
       }
     },
     "node_modules/moment": {
-      "version": "2.29.3",
-      "resolved": "http://94.130.170.209:4873/moment/-/moment-2.29.3.tgz",
-      "integrity": "sha512-c6YRvhEo//6T2Jz/vVtYzqBzwvPT95JBQ+smCytzf7c50oMZRsR/a4w88aD34I+/QVSfnoAnSBFPJHItlOMJVw==",
-      "license": "MIT",
+      "version": "2.29.4",
+      "resolved": "https://registry.npmjs.org/moment/-/moment-2.29.4.tgz",
+      "integrity": "sha512-5LC9SOxjSc2HF6vO2CyuTDNivEdoz2IvyJJGj6X8DJ0eFyfszE0QiEd+iXmBvUP3WHxSjFH/vIsA0EN00cgr8w==",
       "engines": {
         "node": "*"
       }
@@ -13339,7 +13336,7 @@
     "node_modules/node-fetch": {
       "name": "@achingbrain/node-fetch",
       "version": "2.6.7",
-      "resolved": "http://94.130.170.209:4873/@achingbrain%2fnode-fetch/-/node-fetch-2.6.7.tgz",
+      "resolved": "https://registry.npmjs.org/@achingbrain/node-fetch/-/node-fetch-2.6.7.tgz",
       "integrity": "sha512-iTASGs+HTFK5E4ZqcMsHmeJ4zodyq8L38lZV33jwqcBJYoUt3HjN4+ot+O9/0b+ke8ddE7UgOtVuZN/OkV19/g==",
       "license": "MIT",
       "engines": {
@@ -13396,12 +13393,11 @@
       }
     },
     "node_modules/nodemon": {
-      "version": "2.0.16",
-      "resolved": "http://94.130.170.209:4873/nodemon/-/nodemon-2.0.16.tgz",
-      "integrity": "sha512-zsrcaOfTWRuUzBn3P44RDliLlp263Z/76FPoHFr3cFFkOz0lTPAcIw8dCzfdVIx/t3AtDYCZRCDkoCojJqaG3w==",
+      "version": "2.0.19",
+      "resolved": "https://registry.npmjs.org/nodemon/-/nodemon-2.0.19.tgz",
+      "integrity": "sha512-4pv1f2bMDj0Eeg/MhGqxrtveeQ5/G/UVe9iO6uTZzjnRluSA4PVWf8CW99LUPwGB3eNIA7zUFoP77YuI7hOc0A==",
       "dev": true,
       "hasInstallScript": true,
-      "license": "MIT",
       "dependencies": {
         "chokidar": "^3.5.2",
         "debug": "^3.2.7",
@@ -13409,10 +13405,10 @@
         "minimatch": "^3.0.4",
         "pstree.remy": "^1.1.8",
         "semver": "^5.7.1",
+        "simple-update-notifier": "^1.0.7",
         "supports-color": "^5.5.0",
         "touch": "^3.1.0",
-        "undefsafe": "^2.0.5",
-        "update-notifier": "^5.1.0"
+        "undefsafe": "^2.0.5"
       },
       "bin": {
         "nodemon": "bin/nodemon.js"
@@ -18624,10 +18620,9 @@
       }
     },
     "node_modules/semver": {
-      "version": "7.3.7",
-      "resolved": "http://94.130.170.209:4873/semver/-/semver-7.3.7.tgz",
-      "integrity": "sha512-QlYTucUYOews+WeEujDoEGziz4K6c47V/Bd+LjSSYcA94p+DmINdf7ncaUinThfvZyu13lN9OY1XDxt8C0Tw0g==",
-      "license": "ISC",
+      "version": "7.3.5",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz",
+      "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==",
       "dependencies": {
         "lru-cache": "^6.0.0"
       },
@@ -18972,6 +18967,27 @@
       "integrity": "sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ==",
       "license": "MIT"
     },
+    "node_modules/simple-update-notifier": {
+      "version": "1.0.7",
+      "resolved": "https://registry.npmjs.org/simple-update-notifier/-/simple-update-notifier-1.0.7.tgz",
+      "integrity": "sha512-BBKgR84BJQJm6WjWFMHgLVuo61FBDSj1z/xSFUIozqO6wO7ii0JxCqlIud7Enr/+LhlbNI0whErq96P2qHNWew==",
+      "dev": true,
+      "dependencies": {
+        "semver": "~7.0.0"
+      },
+      "engines": {
+        "node": ">=8.10.0"
+      }
+    },
+    "node_modules/simple-update-notifier/node_modules/semver": {
+      "version": "7.0.0",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.0.0.tgz",
+      "integrity": "sha512-+GB6zVA9LWh6zovYQLALHwv5rb2PHGlJi3lfiqIHxR0uuwCgefcOJc59v9fv1w8GbStwxuuqqAjI9NMAOOgq1A==",
+      "dev": true,
+      "bin": {
+        "semver": "bin/semver.js"
+      }
+    },
     "node_modules/single-line-log": {
       "version": "1.1.2",
       "resolved": "http://94.130.170.209:4873/single-line-log/-/single-line-log-1.1.2.tgz",
@@ -23159,9 +23175,9 @@
       "integrity": "sha1-p3c2C1s5oaLlEG+OhY8v0tBgxXA="
     },
     "@psf/bch-js": {
-      "version": "6.4.1",
-      "resolved": "http://94.130.170.209:4873/@psf%2fbch-js/-/bch-js-6.4.1.tgz",
-      "integrity": "sha512-/BLGzWH02VqaDNeY05QGMhrCtYDw5bXn45Egz+L5FLcyZaOqONR4kl80T6a8xvTPcREO4R+AjGTRBpfjdikwpA==",
+      "version": "6.5.1",
+      "resolved": "https://registry.npmjs.org/@psf/bch-js/-/bch-js-6.5.1.tgz",
+      "integrity": "sha512-W52V6NCte/LJZ2TMJwXorq2FdwMMzjS94sh4slebrcUp6oHiAG+/NouQ4ID/I1DEJQlQnQpf2j3zxveCimDERQ==",
       "requires": {
         "@chris.troutner/bip32-utils": "1.0.5",
         "@psf/bip21": "2.0.1",
@@ -28399,9 +28415,9 @@
       }
     },
     "ipfs-coord": {
-      "version": "8.0.2",
-      "resolved": "http://94.130.170.209:4873/ipfs-coord/-/ipfs-coord-8.0.2.tgz",
-      "integrity": "sha512-CdUH4GLLFArUDb8LIRAXxPlhbRQ44A5PEWB4J9zzDB3by93O7DLEgjqPqLDolalzrtiQBVzoARO/exZvdxBF+w==",
+      "version": "8.0.5",
+      "resolved": "https://registry.npmjs.org/ipfs-coord/-/ipfs-coord-8.0.5.tgz",
+      "integrity": "sha512-V4pqR+MU290ZxFRE+Rx/7JuxR7LsOFBLuL0av3eVU5ZQWqeF/Zi9vh52zCqpp1IBCXi4QXNZGlysvm16xFDXww==",
       "requires": {
         "axios": "0.21.4",
         "bch-encrypt-lib": "2.0.0",
@@ -31446,9 +31462,9 @@
       "dev": true
     },
     "moment": {
-      "version": "2.29.3",
-      "resolved": "http://94.130.170.209:4873/moment/-/moment-2.29.3.tgz",
-      "integrity": "sha512-c6YRvhEo//6T2Jz/vVtYzqBzwvPT95JBQ+smCytzf7c50oMZRsR/a4w88aD34I+/QVSfnoAnSBFPJHItlOMJVw=="
+      "version": "2.29.4",
+      "resolved": "https://registry.npmjs.org/moment/-/moment-2.29.4.tgz",
+      "integrity": "sha512-5LC9SOxjSc2HF6vO2CyuTDNivEdoz2IvyJJGj6X8DJ0eFyfszE0QiEd+iXmBvUP3WHxSjFH/vIsA0EN00cgr8w=="
     },
     "moment-timezone": {
       "version": "0.5.34",
@@ -31797,7 +31813,7 @@
     },
     "node-fetch": {
       "version": "npm:@achingbrain/node-fetch@2.6.7",
-      "resolved": "http://94.130.170.209:4873/@achingbrain%2fnode-fetch/-/node-fetch-2.6.7.tgz",
+      "resolved": "https://registry.npmjs.org/@achingbrain/node-fetch/-/node-fetch-2.6.7.tgz",
       "integrity": "sha512-iTASGs+HTFK5E4ZqcMsHmeJ4zodyq8L38lZV33jwqcBJYoUt3HjN4+ot+O9/0b+ke8ddE7UgOtVuZN/OkV19/g=="
     },
     "node-forge": {
@@ -31831,9 +31847,9 @@
       "integrity": "sha512-6VtMpwhsrixq1HDYSBBHvW0GwiWawE75dS3oal48VqRhUvKJNnKnJo2RI/bCVQubj1vgrgscMNW4DHaD6xtMCg=="
     },
     "nodemon": {
-      "version": "2.0.16",
-      "resolved": "http://94.130.170.209:4873/nodemon/-/nodemon-2.0.16.tgz",
-      "integrity": "sha512-zsrcaOfTWRuUzBn3P44RDliLlp263Z/76FPoHFr3cFFkOz0lTPAcIw8dCzfdVIx/t3AtDYCZRCDkoCojJqaG3w==",
+      "version": "2.0.19",
+      "resolved": "https://registry.npmjs.org/nodemon/-/nodemon-2.0.19.tgz",
+      "integrity": "sha512-4pv1f2bMDj0Eeg/MhGqxrtveeQ5/G/UVe9iO6uTZzjnRluSA4PVWf8CW99LUPwGB3eNIA7zUFoP77YuI7hOc0A==",
       "dev": true,
       "requires": {
         "chokidar": "^3.5.2",
@@ -31842,10 +31858,10 @@
         "minimatch": "^3.0.4",
         "pstree.remy": "^1.1.8",
         "semver": "^5.7.1",
+        "simple-update-notifier": "^1.0.7",
         "supports-color": "^5.5.0",
         "touch": "^3.1.0",
-        "undefsafe": "^2.0.5",
-        "update-notifier": "^5.1.0"
+        "undefsafe": "^2.0.5"
       },
       "dependencies": {
         "debug": {
@@ -35475,9 +35491,9 @@
       }
     },
     "semver": {
-      "version": "7.3.7",
-      "resolved": "http://94.130.170.209:4873/semver/-/semver-7.3.7.tgz",
-      "integrity": "sha512-QlYTucUYOews+WeEujDoEGziz4K6c47V/Bd+LjSSYcA94p+DmINdf7ncaUinThfvZyu13lN9OY1XDxt8C0Tw0g==",
+      "version": "7.3.5",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz",
+      "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==",
       "requires": {
         "lru-cache": "^6.0.0"
       }
@@ -35737,6 +35753,23 @@
         }
       }
     },
+    "simple-update-notifier": {
+      "version": "1.0.7",
+      "resolved": "https://registry.npmjs.org/simple-update-notifier/-/simple-update-notifier-1.0.7.tgz",
+      "integrity": "sha512-BBKgR84BJQJm6WjWFMHgLVuo61FBDSj1z/xSFUIozqO6wO7ii0JxCqlIud7Enr/+LhlbNI0whErq96P2qHNWew==",
+      "dev": true,
+      "requires": {
+        "semver": "~7.0.0"
+      },
+      "dependencies": {
+        "semver": {
+          "version": "7.0.0",
+          "resolved": "https://registry.npmjs.org/semver/-/semver-7.0.0.tgz",
+          "integrity": "sha512-+GB6zVA9LWh6zovYQLALHwv5rb2PHGlJi3lfiqIHxR0uuwCgefcOJc59v9fv1w8GbStwxuuqqAjI9NMAOOgq1A==",
+          "dev": true
+        }
+      }
+    },
     "single-line-log": {
       "version": "1.1.2",
       "resolved": "http://94.130.170.209:4873/single-line-log/-/single-line-log-1.1.2.tgz",

package.json

@@ -23,12 +23,12 @@
   },
   "repository": "Permissionless-Software-Foundation/ipfs-bch-wallet-consumer",
   "dependencies": {
-    "@psf/bch-js": "6.4.1",
+    "@psf/bch-js": "6.5.1",
     "axios": "0.27.2",
     "bcryptjs": "2.4.3",
     "glob": "7.1.6",
     "ipfs": "0.62.3",
-    "ipfs-coord": "8.0.2",
+    "ipfs-coord": "8.0.5",
     "ipfs-http-client": "55.0.0",
     "jsonrpc-lite": "2.2.0",
     "jsonwebtoken": "8.5.1",
@@ -50,7 +50,7 @@
     "nodemailer": "6.7.5",
     "passport-local": "1.0.0",
     "public-ip": "4.0.4",
-    "semver": "^7.3.5",
+    "semver": "7.3.5",
     "winston": "3.3.3",
     "winston-daily-rotate-file": "4.5.0"
   },

production/docker/docker-compose.yml

@@ -4,7 +4,7 @@ version: '3.9'
 
 services:
   mongo-bch-consumer:
-    image: mongo
+    image: mongo:4.2.0
     container_name: mongo-bch-consumer
     ports:
       - '5555:27017' # <host port>:<container port>
@@ -14,7 +14,7 @@ services:
     restart: always
 
   ipfs-bch-consumer:
-    image: ipfs/go-ipfs:v0.13.0
+    image: ipfs/go-ipfs:v0.14.0
     container_name: ipfs-bch-consumer
     environment:
       MY_ENV_VAR: 'placeholder'
@@ -26,11 +26,12 @@ services:
     mem_limit: 2000mb
     ports:
       - 4001:4001
+      - 4003:4003
       - 172.17.0.1:5001:5001
       - 172.17.0.1:8080:8080
     volumes:
       - ../data/go-ipfs/data:/data/ipfs
-      - ../../swarm.key:/data/ipfs/swarm.key
+    #  - ../../swarm.key:/data/ipfs/swarm.key
     # https://docs.docker.com/compose/compose-file/compose-file-v3/#command
     # https://github.com/ipfs/go-ipfs/blob/91c52657166bcf86f2476926e4fe56694dc26562/Dockerfile#L115
     command:

production/docker/start-production.sh

@@ -33,6 +33,6 @@ export CONSUMER_ENV=production
 export IPFS_HOST=172.17.0.1
 export IPFS_API_PORT=5001
 export IPFS_TCP_PORT=4001
-#export IPFS_WS_PORT=5269
+export IPFS_WS_PORT=4003
 
 npm start

src/adapters/bch/index.js

@@ -429,7 +429,7 @@ class BchAdapter {
     }
   }
 
-  async getTokenData (tokenId) {
+  async getTokenData (tokenId, withTxHistory = false) {
     try {
       // Throw an error if this IPFS node has not yet made a connection to a
       // wallet service provider.
@@ -441,7 +441,8 @@ class BchAdapter {
 
       const rpcData = {
         endpoint: 'getTokenData',
-        tokenId
+        tokenId,
+        withTxHistory
       }
 
       // Generate a UUID for the call.
@@ -471,6 +472,49 @@ class BchAdapter {
     }
   }
 
+  // Get token icon and other media associated with the token.
+  async getTokenData2 (tokenId) {
+    try {
+      // Throw an error if this IPFS node has not yet made a connection to a
+      // wallet service provider.
+      const selectedProvider =
+        this.ipfs.ipfsCoordAdapter.state.selectedServiceProvider
+      if (!selectedProvider) {
+        throw new Error('No BCH Wallet Service provider available yet.')
+      }
+
+      const rpcData = {
+        endpoint: 'getTokenData2',
+        tokenId
+      }
+
+      // Generate a UUID for the call.
+      const rpcId = this.uid()
+
+      // Generate a JSON RPC command.
+      const cmd = this.jsonrpc.request(rpcId, 'bch', rpcData)
+      const cmdStr = JSON.stringify(cmd)
+      console.log('cmdStr: ', cmdStr)
+
+      // Send the RPC command to selected wallet service.
+      const thisNode = this.ipfs.ipfsCoordAdapter.ipfsCoord.thisNode
+      await this.ipfs.ipfsCoordAdapter.ipfsCoord.useCases.peer.sendPrivateMessage(
+        selectedProvider,
+        cmdStr,
+        thisNode
+      )
+
+      // Wait for data to come back from the wallet service.
+      const data = await this.waitForRPCResponse(rpcId)
+
+      return data
+    } catch (err) {
+      console.log('getTokenData2() error: ', err)
+      wlogger.error('Error in adapters/bch.js/getTokenData2()')
+      throw err
+    }
+  }
+
   // Returns a promise that resolves to data when the RPC response is recieved.
   async waitForRPCResponse (rpcId) {
     try {

src/adapters/ipfs/index.js

@@ -5,6 +5,7 @@
 // Local libraries
 const IpfsAdapter = require('./ipfs')
 const IpfsCoordAdapter = require('./ipfs-coord')
+const config = require('../../../config')
 
 class IPFS {
   constructor (localConfig = {}) {
@@ -20,6 +21,7 @@ class IPFS {
     this.ipfsAdapter = new IpfsAdapter()
     this.IpfsCoordAdapter = IpfsCoordAdapter
     this.process = process
+    this.config = config
 
     this.ipfsCoordAdapter = {} // placeholder
 
@@ -40,8 +42,9 @@ class IPFS {
 
       // Start ipfs-coord
       this.ipfsCoordAdapter = new this.IpfsCoordAdapter({
-        ipfs: this.ipfs
-        // eventEmitter: this.eventEmitter
+        ipfs: this.ipfs,
+        tcpPort: this.config.ipfsTcpPort,
+        wsPort: this.config.ipfsWsPort
       })
       await this.ipfsCoordAdapter.start()
       console.log('ipfs-coord is ready.')

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

@@ -556,64 +556,27 @@ class BchRESTControllerLib {
   }
 
   /**
-   * @api {REST} /bch getTokenData
-   * @apiPermission public
-   * @apiName getTokenData
-   * @apiGroup REST BCH
-   * @apiDescription Get data associated with a token
-   * Given a token ID, this endpoint will retrieve the IPFS CIDs associated with
-   * the tokens mutable and immutable data. This is extension of the PS002
-   * specification for mutable data for tokens:
-   * https://github.com/Permissionless-Software-Foundation/specifications/blob/master/ps002-slp-mutable-data.md
-   *
-   *  - jsonrpc: "" - jsonrpc version
-   *  - id: "" - jsonrpc id
-   *  - result: {} - Result of the petition with the RPC information
-   *      - success: - Request status
-   *      - getTokenData: - Address public key
-   *
-   * @apiExample Example usage:
-   * {"jsonrpc":"2.0","id":"555","method":"bch","params":{ "endpoint": "getTokenData", "tokenId": "c85042ab08a2099f27de880a30f9a42874202751d834c42717a20801a00aab0d" }}
-   *
-   * @apiSuccessExample {json} Success-Response:
-   *  {
-   *     "jsonrpc":"2.0",
-   *     "id":"555",
-   *     "result":{
-   *        "method":"bch",
-   *        "reciever":"QmU86vLVbUY1UhziKB6rak7GPKRA2QHWvzNm2AjEvXNsT6",
-   *        "value":{
-   *          "success": true,
-   *          "status": 200,
-   *          "endpoint": "getTokenData",
-   *          "tokenData": {
-   *            "genesisData": {
-   *              "type": 1,
-   *              "ticker": 'MT2',
-   *              "name": 'Mutable Token',
-   *              "tokenId": 'c85042ab08a2099f27de880a30f9a42874202751d834c42717a20801a00aab0d',
-   *              "documentUri": 'ipfs://bafybeie7oxpsr7evcnlptecxfdhaqlot4732phukd2ekgvuzoir2frost4',
-   *              "documentHash": '56ed1a5768076a318d02b5db64e125544dca57ab6b2cc7ca61dfa4645d244463',
-   *              "decimals": 0,
-   *              "mintBatonIsActive": true,
-   *              "tokensInCirculationBN": '1000',
-   *              "tokensInCirculationStr": '1000',
-   *              "blockCreated": 739412,
-   *              "totalBurned": '0',
-   *              "totalMinted": '1000'
-   *            },
-   *            "immutableData": 'ipfs://bafybeie7oxpsr7evcnlptecxfdhaqlot4732phukd2ekgvuzoir2frost4',
-   *            "mutableData": 'ipfs://bafybeigotuony53ley3n63hqwyxiqruqn5uamskmci6f645putnc46jju4'
-   *          }
-   *        }
-   *     }
-   *  }
-   */
+    * @api {REST} /bch getTokenData
+    * @apiPermission public
+    * @apiName getTokenData
+    * @apiGroup REST BCH
+    * @apiDescription Get data associated with a token
+    *
+    * Given a token ID, this endpoint will retrieve the IPFS CIDs associated with
+    * the tokens mutable and immutable data. This is extension of the PS002
+    * specification for mutable data for tokens:
+    * https://github.com/Permissionless-Software-Foundation/specifications/blob/master/ps002-slp-mutable-data.md
+    *
+    *
+    * @apiExample Example usage:
+    * curl -H "Content-Type: application/json" -X POST -d '{ "tokenId": "43eddfb11c9941edffb8c8815574bb0a43969a7b1de39ad14cd043eaa24fd38d", "withTxHistory": true }' https://bc01-ca-bch-consumer.fullstackcash.nl/bch/getTokenData
+    */
   async getTokenData (ctx) {
     try {
       const tokenId = ctx.request.body.tokenId
+      const withTxHistory = !!ctx.request.body.withTxHistory
 
-      const data = await this.adapters.bch.getTokenData(tokenId)
+      const data = await this.adapters.bch.getTokenData(tokenId, withTxHistory)
       console.log(`getTokenData data: ${JSON.stringify(data, null, 2)}`)
 
       ctx.body = data

test/unit/adapters/bch.adapter.unit.js

@@ -344,4 +344,34 @@ describe('#bch-use-case', () => {
       }
     })
   })
+
+  describe('#getTokenData2', () => {
+    it('should validate a utxo', async () => {
+      // Force connection to a wallet service
+      uut.ipfs.ipfsCoordAdapter.state = {
+        selectedServiceProvider: 'abc123'
+      }
+
+      // Mock depenencies
+      sandbox.stub(uut, 'waitForRPCResponse').resolves({ key: 'value' })
+
+      const tokenId = 'blah'
+
+      const result = await uut.getTokenData2(tokenId)
+      // console.log('result: ', result)
+
+      assert.equal(result.key, 'value')
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+        await uut.getTokenData2()
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        // console.log(err)
+        assert.equal(err.message, 'test error')
+      }
+    })
+  })
 })

test/unit/mocks/adapters/index.js

@@ -2,12 +2,20 @@
   Mocks for the Adapter library.
 */
 
-const ipfs = {
-  ipfsAdapter: {
-    ipfs: {}
-  },
-  ipfsCoordAdapter: {
-    ipfsCoord: {
+class IpfsAdapter {
+  constructor () {
+    this.ipfs = {
+      files: {
+        stat: () => {}
+      }
+    }
+  }
+}
+
+class IpfsCoordAdapter {
+  constructor () {
+
+    this.ipfsCoord = {
       useCases: {
         peer: {
           sendPrivateMessage: () => {}
@@ -17,13 +25,21 @@ const ipfs = {
         peerData: []
       }
     },
-    peerInputHandler: () => {},
-    state: {
+
+    this.peerInputHandler = () => {}
+
+    this.state = {
       serviceProviders: []
     }
   }
 }
 
+const ipfs = {
+  ipfsAdapter: new IpfsAdapter(),
+  ipfsCoordAdapter: new IpfsCoordAdapter()
+}
+ipfs.ipfs = ipfs.ipfsAdapter.ipfs
+
 const localdb = {
   Users: class Users {
     static findById () {}