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

fix(getTokenData2): Adding token icon lookup

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.1",
         "axios": "0.27.2",
         "bcryptjs": "2.4.3",
         "glob": "7.1.6",
@@ -1445,9 +1445,9 @@
       "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.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",
@@ -20957,9 +20957,9 @@
       "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.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",

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.1",
     "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,66 @@ 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 tokenData = await this.bchjs.PsfSlpIndexer.getTokenData2(tokenId)
+
+      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: () => {}
   }
 }