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

fix(getTokenData): JSON controller accepts flag for showing tx history

package-lock.json

@@ -9,7 +9,7 @@
       "version": "2.0.0",
       "license": "MIT",
       "dependencies": {
-        "@psf/bch-js": "6.4.1",
+        "@psf/bch-js": "6.4.5",
         "axios": "0.27.2",
         "bcryptjs": "2.4.3",
         "glob": "7.1.6",
@@ -1445,10 +1445,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.4.5",
+      "resolved": "https://registry.npmjs.org/@psf/bch-js/-/bch-js-6.4.5.tgz",
+      "integrity": "sha512-sH72zbJJI5oe9EUMczFQb0jCaNQb8rc3/86E6xXKl3325HCwBqE80BX7JFvZ97Qv1gGxwp/3WROp59v6Dz2NKA==",
       "dependencies": {
         "@chris.troutner/bip32-utils": "1.0.5",
         "@psf/bip21": "2.0.1",
@@ -12259,6 +12258,8 @@
     "node_modules/node-fetch": {
       "name": "@achingbrain/node-fetch",
       "version": "2.6.7",
+      "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": {
         "node": "4.x || >=6.0.0"
@@ -21294,9 +21295,9 @@
       "version": "1.1.0"
     },
     "@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.4.5",
+      "resolved": "https://registry.npmjs.org/@psf/bch-js/-/bch-js-6.4.5.tgz",
+      "integrity": "sha512-sH72zbJJI5oe9EUMczFQb0jCaNQb8rc3/86E6xXKl3325HCwBqE80BX7JFvZ97Qv1gGxwp/3WROp59v6Dz2NKA==",
       "requires": {
         "@chris.troutner/bip32-utils": "1.0.5",
         "@psf/bip21": "2.0.1",
@@ -28910,7 +28911,9 @@
       }
     },
     "node-fetch": {
-      "version": "npm:@achingbrain/node-fetch@2.6.7"
+      "version": "npm:@achingbrain/node-fetch@2.6.7",
+      "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": {
       "version": "1.3.1",

package.json

@@ -24,7 +24,7 @@
   },
   "repository": "Permissionless-Software-Foundation/ipfs-bch-wallet-service",
   "dependencies": {
-    "@psf/bch-js": "6.4.1",
+    "@psf/bch-js": "6.4.5",
     "axios": "0.27.2",
     "bcryptjs": "2.4.3",
     "glob": "7.1.6",

src/controllers/json-rpc/bch/index.js

@@ -704,6 +704,9 @@ class BCHRPC {
    * specification for mutable data for tokens:
    * https://github.com/Permissionless-Software-Foundation/specifications/blob/master/ps002-slp-mutable-data.md
    *
+   * If optional parameter 'withTxHistory' is true, data will include the
+   * transaction history of the token.
+   *
    *  - jsonrpc: "" - jsonrpc version
    *  - id: "" - jsonrpc id
    *  - result: {} - Result of the petition with the RPC information
@@ -711,7 +714,7 @@ class BCHRPC {
    *      - tokenData: - Address public key
    *
    * @apiExample Example usage:
-   * {"jsonrpc":"2.0","id":"555","method":"bch","params":{ "endpoint": "getTokenData", "tokenId": "c85042ab08a2099f27de880a30f9a42874202751d834c42717a20801a00aab0d" }}
+   * {"jsonrpc":"2.0","id":"555","method":"bch","params":{ "endpoint": "getTokenData", "tokenId": "c85042ab08a2099f27de880a30f9a42874202751d834c42717a20801a00aab0d", "withTxHistory": true }}
    *
    * @apiSuccessExample {json} Success-Response:
    *  {
@@ -754,7 +757,9 @@ class BCHRPC {
       const tokenId = rpcData.payload.params.tokenId
       // console.log('tokenId: ', tokenId)
 
-      const tokenData = await this.bchjs.PsfSlpIndexer.getTokenData(tokenId)
+      const withTxHistory = !!rpcData.payload.params.withTxHistory
+
+      const tokenData = await this.bchjs.PsfSlpIndexer.getTokenData(tokenId, withTxHistory)
 
       const retObj = {
         success: true,

test/integration/controllers/json-rpc/bch.integration.js

@@ -106,12 +106,28 @@ describe('#BCH', () => {
       }
 
       const result = await uut.getTokenData(rpcData)
-      console.log('result: ', result)
+      // console.log('result: ', result)
 
       // assert.equal(result.isValid, true)
       assert.property(result.tokenData, 'immutableData')
       assert.property(result.tokenData, 'mutableData')
       assert.equal(result.success, true)
     })
+
+    it('should return data for a token with tx history', async () => {
+      const rpcData = {
+        payload: {
+          params: {
+            tokenId: '43eddfb11c9941edffb8c8815574bb0a43969a7b1de39ad14cd043eaa24fd38d',
+            withTxHistory: true
+          }
+        }
+      }
+
+      const result = await uut.getTokenData(rpcData)
+      // console.log('result: ', result)
+
+      assert.isArray(result.tokenData.genesisData.txs)
+    })
   })
 })