@psf/bch-js 6.5.0 → 6.5.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@psf/bch-js",
-  "version": "6.5.0",
+  "version": "6.5.2",
   "description": "A JavaScript library for working with Bitcoin Cash, eCash, and SLP Tokens",
   "author": "Chris Troutner <chris.troutner@gmail.com>",
   "contributors": [

package/src/psf-slp-indexer.js

@@ -449,6 +449,18 @@ class PsfSlpIndexer {
    * @apiGroup PSF SLP
    * @apiDescription Get token icon and other media associated with a token.
    *
+   * 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:
    * (async () => {
    *   try {
@@ -520,7 +532,7 @@ class PsfSlpIndexer {
 
       throw new Error('Input tokenId must be a string.')
     } catch (error) {
-      console.log('error: ', error)
+      // console.log('error: ', error)
       if (error.response && error.response.data) throw error.response.data
       else throw error
     }

package/test/integration/chains/bchn/psf-slp-indexer.integration.js

@@ -156,26 +156,28 @@ describe('#psf-slp-indexer', () => {
     })
   })
 
-  describe('#getTokenData2', () => {
-    it('should get token data', async () => {
-      const tokenId =
-        'd9aafa7acb514c597caf440ae268b5e4e955f2687e05f044cdf8fd9550d9a27b'
-
-      // bchjs.PsfSlpIndexer.restURL = 'http://localhost:3000/v5/'
-      const result = await bchjs.PsfSlpIndexer.getTokenData2(tokenId)
-      console.log('result: ', result)
-
-      assert.property(result, 'tokenStats')
-      assert.property(result, 'mutableData')
-      assert.property(result, 'immutableData')
-      assert.property(result, 'tokenIcon')
-      assert.property(result, 'fullSizedUrl')
-      assert.property(result, 'optimizedTokenIcon')
-      assert.property(result, 'optimizedFullSizedUrl')
-      assert.property(result, 'iconRepoCompatible')
-      assert.property(result, 'ps002Compatible')
-    })
-  })
+  // This test is commented out because it can not succeed in the BVT without
+  // tripping rate limits.
+  // describe('#getTokenData2', () => {
+  //   it('should get token data', async () => {
+  //     const tokenId =
+  //       'd9aafa7acb514c597caf440ae268b5e4e955f2687e05f044cdf8fd9550d9a27b'
+  //
+  //     // bchjs.PsfSlpIndexer.restURL = 'http://localhost:3000/v5/'
+  //     const result = await bchjs.PsfSlpIndexer.getTokenData2(tokenId)
+  //     // console.log('result: ', result)
+  //
+  //     assert.property(result, 'tokenStats')
+  //     assert.property(result, 'mutableData')
+  //     assert.property(result, 'immutableData')
+  //     assert.property(result, 'tokenIcon')
+  //     assert.property(result, 'fullSizedUrl')
+  //     assert.property(result, 'optimizedTokenIcon')
+  //     assert.property(result, 'optimizedFullSizedUrl')
+  //     assert.property(result, 'iconRepoCompatible')
+  //     assert.property(result, 'ps002Compatible')
+  //   })
+  // })
 })
 
 // Promise-based sleep function