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

fix(getTokenData2()): Adding updateCache argument

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,7 +9,7 @@
       "version": "2.0.0",
       "license": "MIT",
       "dependencies": {
-        "@psf/bch-js": "6.4.5",
+        "@psf/bch-js": "6.5.7",
         "axios": "0.27.2",
         "bcryptjs": "2.4.3",
         "glob": "7.1.6",
@@ -1445,14 +1445,15 @@
       "license": "BSD-3-Clause"
     },
     "node_modules/@psf/bch-js": {
-      "version": "6.4.5",
-      "resolved": "https://registry.npmjs.org/@psf/bch-js/-/bch-js-6.4.5.tgz",
-      "integrity": "sha512-sH72zbJJI5oe9EUMczFQb0jCaNQb8rc3/86E6xXKl3325HCwBqE80BX7JFvZ97Qv1gGxwp/3WROp59v6Dz2NKA==",
+      "version": "6.5.7",
+      "resolved": "http://94.130.170.209:4873/@psf%2fbch-js/-/bch-js-6.5.7.tgz",
+      "integrity": "sha512-V9UweiRCCU4UzM51Ct2Szhpv6V0B686t5ZjMHNkPu8zyJ9+H7mQfteeQECHK5j38QHvLchfUOif5WWQxP6GRVQ==",
+      "license": "MIT",
       "dependencies": {
         "@chris.troutner/bip32-utils": "1.0.5",
         "@psf/bip21": "2.0.1",
         "@psf/bitcoincash-ops": "2.0.0",
-        "@psf/bitcoincashjs-lib": "4.0.2",
+        "@psf/bitcoincashjs-lib": "4.0.3",
         "@psf/coininfo": "4.0.0",
         "axios": "0.26.1",
         "bc-bip68": "1.0.5",
@@ -1491,10 +1492,14 @@
     },
     "node_modules/@psf/bitcoincash-ops": {
       "version": "2.0.0",
+      "resolved": "http://94.130.170.209:4873/@psf%2fbitcoincash-ops/-/bitcoincash-ops-2.0.0.tgz",
+      "integrity": "sha512-M3PWqRpeJq6rli2NqWGbas76z9TrdGOmNuDFACBWBMctPucEAsFQY2AmyFHRSa7hEwythwvrPh9AG/n6ehmEog==",
       "license": "MIT"
     },
     "node_modules/@psf/bitcoincashjs-lib": {
-      "version": "4.0.2",
+      "version": "4.0.3",
+      "resolved": "http://94.130.170.209:4873/@psf%2fbitcoincashjs-lib/-/bitcoincashjs-lib-4.0.3.tgz",
+      "integrity": "sha512-sJYi7jYUqR7S+Z8TjN3W/5Lcju7xcIBxYLhIEpnOF+jR9kMt0ftpVjQBt8vVsJZUD8ArL9bf59oDETjdOUcdGQ==",
       "license": "MIT",
       "dependencies": {
         "@psf/bitcoincash-ops": "^2.0.0",
@@ -1526,6 +1531,8 @@
     },
     "node_modules/@psf/pushdata-bitcoin": {
       "version": "1.2.2",
+      "resolved": "http://94.130.170.209:4873/@psf%2fpushdata-bitcoin/-/pushdata-bitcoin-1.2.2.tgz",
+      "integrity": "sha512-e1qkZLJFU6Ldg7TMBgSkiR5U1NfpRgSIr2ppk8BeED/Q9wUc9DEVAjXfPMD65xgXdqnlyFEtLbpPMWwyydMVUQ==",
       "license": "MIT",
       "dependencies": {
         "@psf/bitcoincash-ops": "^2.0.0"
@@ -2928,6 +2935,8 @@
     },
     "node_modules/bech32": {
       "version": "1.1.4",
+      "resolved": "http://94.130.170.209:4873/bech32/-/bech32-1.1.4.tgz",
+      "integrity": "sha512-s0IrSOzLlbvX7yp4WBfPITzpAU8sqQcpsmwXDiKwrG4r491vwCO/XpejasRNl0piBMe/DvP4Tz0mIS/X1DPJBQ==",
       "license": "MIT"
     },
     "node_modules/before-after-hook": {
@@ -11040,6 +11049,8 @@
     },
     "node_modules/merkle-lib": {
       "version": "2.0.10",
+      "resolved": "http://94.130.170.209:4873/merkle-lib/-/merkle-lib-2.0.10.tgz",
+      "integrity": "sha1-grjbrnXieneFOItz+ddyXQ9vMyY=",
       "license": "MIT"
     },
     "node_modules/methods": {
@@ -19026,6 +19037,8 @@
     },
     "node_modules/typeforce": {
       "version": "1.18.0",
+      "resolved": "http://94.130.170.209:4873/typeforce/-/typeforce-1.18.0.tgz",
+      "integrity": "sha512-7uc1O8h1M1g0rArakJdf0uLRSSgFcYexrVoKo+bzJd32gd4gDy2L/Z+8/FjPnU9ydY3pEnVPtr9FyscYY60K1g==",
       "license": "MIT"
     },
     "node_modules/uc.micro": {
@@ -20957,14 +20970,14 @@
       "version": "1.1.0"
     },
     "@psf/bch-js": {
-      "version": "6.4.5",
-      "resolved": "https://registry.npmjs.org/@psf/bch-js/-/bch-js-6.4.5.tgz",
-      "integrity": "sha512-sH72zbJJI5oe9EUMczFQb0jCaNQb8rc3/86E6xXKl3325HCwBqE80BX7JFvZ97Qv1gGxwp/3WROp59v6Dz2NKA==",
+      "version": "6.5.7",
+      "resolved": "http://94.130.170.209:4873/@psf%2fbch-js/-/bch-js-6.5.7.tgz",
+      "integrity": "sha512-V9UweiRCCU4UzM51Ct2Szhpv6V0B686t5ZjMHNkPu8zyJ9+H7mQfteeQECHK5j38QHvLchfUOif5WWQxP6GRVQ==",
       "requires": {
         "@chris.troutner/bip32-utils": "1.0.5",
         "@psf/bip21": "2.0.1",
         "@psf/bitcoincash-ops": "2.0.0",
-        "@psf/bitcoincashjs-lib": "4.0.2",
+        "@psf/bitcoincashjs-lib": "4.0.3",
         "@psf/coininfo": "4.0.0",
         "axios": "0.26.1",
         "bc-bip68": "1.0.5",
@@ -21002,10 +21015,14 @@
       }
     },
     "@psf/bitcoincash-ops": {
-      "version": "2.0.0"
+      "version": "2.0.0",
+      "resolved": "http://94.130.170.209:4873/@psf%2fbitcoincash-ops/-/bitcoincash-ops-2.0.0.tgz",
+      "integrity": "sha512-M3PWqRpeJq6rli2NqWGbas76z9TrdGOmNuDFACBWBMctPucEAsFQY2AmyFHRSa7hEwythwvrPh9AG/n6ehmEog=="
     },
     "@psf/bitcoincashjs-lib": {
-      "version": "4.0.2",
+      "version": "4.0.3",
+      "resolved": "http://94.130.170.209:4873/@psf%2fbitcoincashjs-lib/-/bitcoincashjs-lib-4.0.3.tgz",
+      "integrity": "sha512-sJYi7jYUqR7S+Z8TjN3W/5Lcju7xcIBxYLhIEpnOF+jR9kMt0ftpVjQBt8vVsJZUD8ArL9bf59oDETjdOUcdGQ==",
       "requires": {
         "@psf/bitcoincash-ops": "^2.0.0",
         "@psf/pushdata-bitcoin": "^1.2.2",
@@ -21032,6 +21049,8 @@
     },
     "@psf/pushdata-bitcoin": {
       "version": "1.2.2",
+      "resolved": "http://94.130.170.209:4873/@psf%2fpushdata-bitcoin/-/pushdata-bitcoin-1.2.2.tgz",
+      "integrity": "sha512-e1qkZLJFU6Ldg7TMBgSkiR5U1NfpRgSIr2ppk8BeED/Q9wUc9DEVAjXfPMD65xgXdqnlyFEtLbpPMWwyydMVUQ==",
       "requires": {
         "@psf/bitcoincash-ops": "^2.0.0"
       }
@@ -22066,7 +22085,9 @@
       "version": "2.4.3"
     },
     "bech32": {
-      "version": "1.1.4"
+      "version": "1.1.4",
+      "resolved": "http://94.130.170.209:4873/bech32/-/bech32-1.1.4.tgz",
+      "integrity": "sha512-s0IrSOzLlbvX7yp4WBfPITzpAU8sqQcpsmwXDiKwrG4r491vwCO/XpejasRNl0piBMe/DvP4Tz0mIS/X1DPJBQ=="
     },
     "before-after-hook": {
       "version": "2.2.2",
@@ -27836,7 +27857,9 @@
       "dev": true
     },
     "merkle-lib": {
-      "version": "2.0.10"
+      "version": "2.0.10",
+      "resolved": "http://94.130.170.209:4873/merkle-lib/-/merkle-lib-2.0.10.tgz",
+      "integrity": "sha1-grjbrnXieneFOItz+ddyXQ9vMyY="
     },
     "methods": {
       "version": "1.1.2"
@@ -33283,7 +33306,9 @@
       }
     },
     "typeforce": {
-      "version": "1.18.0"
+      "version": "1.18.0",
+      "resolved": "http://94.130.170.209:4873/typeforce/-/typeforce-1.18.0.tgz",
+      "integrity": "sha512-7uc1O8h1M1g0rArakJdf0uLRSSgFcYexrVoKo+bzJd32gd4gDy2L/Z+8/FjPnU9ydY3pEnVPtr9FyscYY60K1g=="
     },
     "uc.micro": {
       "version": "1.0.6",

package.json

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

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

@@ -79,6 +79,10 @@ class BCHRPC {
         case 'getTokenData':
           await this.rateLimit.limiter(rpcData.from)
           return await this.getTokenData(rpcData)
+
+        case 'getTokenData2':
+          await this.rateLimit.limiter(rpcData.from)
+          return await this.getTokenData2(rpcData)
       }
     } catch (err) {
       console.error('Error in BCHRPC/rpcRouter()')
@@ -788,6 +792,68 @@ class BCHRPC {
       }
     }
   }
+
+  /**
+   * @api {JSON} /bch getTokenData2
+   * @apiPermission public
+   * @apiName getTokenData2
+   * @apiGroup JSON BCH
+   * @apiDescription Get token icon and other media
+   *
+   * Get the icon for a token, given it's token ID.
+   * This function expects a string input of a token ID property.
+   * This function returns an object with a tokenIcon property that contains
+   * the URL to the icon.
+   *
+   * The output object always have these properties:
+   * - tokenIcon: A url to the token icon, if it exists.
+   * - tokenStats: Data about the token from psf-slp-indexer.
+   * - optimizedTokenIcon: An alternative, potentially more optimal, url to the token icon, if it exists.
+   * - iconRepoCompatible: true if the token icon is available via token.bch.sx
+   * - ps002Compatible: true if the token icon is compatible with PS007 specification.
+   *
+   * @apiExample Example usage:
+   * {"jsonrpc":"2.0","id":"555","method":"bch","params":{ "endpoint": "getTokenData2", "tokenId": "c85042ab08a2099f27de880a30f9a42874202751d834c42717a20801a00aab0d", "withTxHistory": true }}
+   *
+   */
+  async getTokenData2 (rpcData) {
+    try {
+      // console.log('createUser rpcData: ', rpcData)
+
+      const tokenId = rpcData.payload.params.tokenId
+      // console.log('tokenId: ', tokenId)
+
+      const updateCache = rpcData.payload.params.updateCache
+
+      const tokenData = await this.bchjs.PsfSlpIndexer.getTokenData2(tokenId, updateCache)
+
+      const retObj = {
+        success: true,
+        status: 200,
+        endpoint: 'getTokenData2',
+        tokenData
+      }
+      // retObj.status = 200
+
+      return retObj
+    } catch (err) {
+      console.error('Error in JSON RPC BCH utxoIsValid()')
+
+      // Handle different error formats.
+      let error = err
+      if (err.error && typeof err.error === 'string') {
+        error = new Error(err.error)
+      }
+
+      // Return an error response
+      return {
+        success: false,
+        status: 422,
+        message: error.message,
+        endpoint: 'getTokenData2'
+      }
+    }
+  }
 }
 
 module.exports = BCHRPC

test/unit/controllers/json-rpc/bch.json-rpc.controller.unit.js

@@ -638,4 +638,52 @@ describe('#BCHRPC', () => {
       assert.equal(result.endpoint, 'getTokenData')
     })
   })
+
+  describe('#getTokenData2', () => {
+    it('should return data from PsfSlpIndexer.getTokenData2()', async () => {
+      // Mock dependencies
+      sandbox
+        .stub(uut.bchjs.PsfSlpIndexer, 'getTokenData2')
+        .resolves({ a: 'b' })
+
+      const rpcData = {
+        payload: {
+          params: {
+            tokenId: 'c85042ab08a2099f27de880a30f9a42874202751d834c42717a20801a00aab0d'
+          }
+        }
+      }
+
+      const result = await uut.getTokenData2(rpcData)
+      // console.log('result: ', result)
+
+      assert.equal(result.success, true)
+      assert.equal(result.status, 200)
+      assert.equal(result.endpoint, 'getTokenData2')
+      assert.property(result, 'tokenData')
+    })
+
+    it('should catch and return errors', async () => {
+      // Mock dependencies
+      sandbox
+        .stub(uut.bchjs.PsfSlpIndexer, 'getTokenData2')
+        .rejects(new Error('test error'))
+
+      const rpcData = {
+        payload: {
+          params: {
+            tokenId: 'c85042ab08a2099f27de880a30f9a42874202751d834c42717a20801a00aab0d'
+          }
+        }
+      }
+
+      const result = await uut.getTokenData2(rpcData)
+      // console.log('result: ', result)
+
+      assert.equal(result.success, false)
+      assert.equal(result.status, 422)
+      assert.equal(result.message, 'test error')
+      assert.equal(result.endpoint, 'getTokenData2')
+    })
+  })
 })

test/unit/mocks/adapters/index.js

@@ -89,7 +89,8 @@ const bchjs = {
     chunk100: () => {}
   },
   PsfSlpIndexer: {
-    getTokenData: () => {}
+    getTokenData: () => {},
+    getTokenData2: () => {}
   }
 }