Merge pull request #234 from Permissionless-Software-Foundation/dh-psfSlpIndexer

feat(slpindexer): Added bchjs.PsfSlpIndexer.getTokenData()

README.md

@@ -107,11 +107,15 @@ This open source software is developed and maintained by the [Permissionless Sof
 </div>
 
 
-## IPFS Releases
+## IPFS & Radicle Releases
 
 Copies of this repository are also published on [IPFS](https://ipfs.io).
 
-- v4.5.4: QmWv3pxJy3MH8vU5nLUVyzqFxfNKXLQQEnz1rgStNuQijd
+- v6.2.10: `bafybeifsioj3ba77u2763nsyuzq53gtbdxsnqpoipvdl4immj6ytznjaoy`
+- (with dependencies, node v14.18.2 and npm v8.8.0): `bafybeihfendd4oj6uxvvecm7sluobwwhpb5wdcxhvhmx56e667nxdncd4a`
+
+They are also posted to the Radicle:
+- v6.2.10: `rad:git:hnrkkroqnbfwj6uxpfjuhspoxnfm4i8e6oqwy`
 
 ## License
 

src/psf-slp-indexer.js

@@ -41,7 +41,7 @@ class PsfSlpIndexer {
     this.rawTransaction = new RawTransaction(config)
     this.slpUtils = new SlpUtils(config)
 
-  // _this = this
+    // _this = this
   }
 
   /**
@@ -374,6 +374,73 @@ class PsfSlpIndexer {
       return false
     }
   }
+
+  /**
+   * @api PsfSlpIndexer.getTokenData()  getTokenData()
+   * @apiName Token Data
+   * @apiGroup PSF SLP
+   * @apiDescription Get mutable and immutable data if the token contains them.
+   *
+   * @apiExample Example usage:
+   * (async () => {
+   *   try {
+   *     let tokenData = await bchjs.PsfSlpIndexer.getTokenData('a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2')
+   *     console.log(tokenData)
+   *   } catch(error) {
+   *    console.error(error)
+   *   }
+   * })()
+   *
+   * {
+   *   genesisData: {
+   *     type: 1,
+   *     ticker: 'TROUT',
+   *     name: "Trout's test token",
+   *     tokenId: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
+   *     documentUri: 'troutsblog.com',
+   *     documentHash: '',
+   *     decimals: 2,
+   *     mintBatonIsActive: true,
+   *     tokensInCirculationBN: '100098953386',
+   *     tokensInCirculationStr: '100098953386',
+   *     blockCreated: 622414,
+   *     totalBurned: '1046614',
+   *     totalMinted: '100100000000'
+   *     ]
+   *   },
+   *  immutableData :{
+   *     issuer:"FullStack.cash.",
+   *     website:"https://fullstack.cash/",
+   *     dateCreated:"2022-01-11"
+   *   },
+   *  mutableData :{
+   *    "tokenIcon":"https://gateway.ipfs.io/ipfs/bafybeiehitanirn5gmhqjg44xrmdtomn4n5lu5yjoepsvgpswk5mggaw6i/LP_logo-1.png",
+   *    "about":"Mutable data managed with npm package: https://www.npmjs.com/package/slp-mutable-data"
+   *   }
+   * }
+   *
+   */
+  async getTokenData (tokenId) {
+    try {
+      const url = `${this.restURL}psf/slp/token/data`
+      // console.log(`url: ${url}`)
+
+      // Handle single address.
+      if (typeof tokenId === 'string') {
+        const response = await axios.post(
+          // 'https://bchn.fullstack.cash/v5/psf/slp/token/data/',
+          url,
+          { tokenId },
+          this.axiosOptions
+        )
+        return response.data
+      }
+      throw new Error('Input tokenId must be a string.')
+    } catch (error) {
+      if (error.response && error.response.data) throw error.response.data
+      else throw error
+    }
+  }
 }
 
 module.exports = PsfSlpIndexer

src/slp/nft1.js

@@ -147,7 +147,7 @@ class Nft1 {
     // Loop through the tokenUtxos array and find the minting baton.
     let mintBatonUtxo
     for (let i = 0; i < tokenUtxos.length; i++) {
-      if (tokenUtxos[i].utxoType === 'minting-baton') {
+      if (tokenUtxos[i].utxoType === 'minting-baton' || tokenUtxos[i].type === 'baton') {
         mintBatonUtxo = tokenUtxos[i]
       }
     }

src/utxo.js

@@ -125,6 +125,7 @@ class UTXO {
             thisUtxo.qty = thisSlpUtxo.qty
             thisUtxo.tokenId = thisSlpUtxo.tokenId
             thisUtxo.address = thisSlpUtxo.address
+            thisUtxo.tokenType = thisSlpUtxo.tokenType
 
             break
           }
@@ -151,19 +152,37 @@ class UTXO {
 
       // Get token UTXOs
       let type1TokenUtxos = utxos.filter(
-        x => x.isSlp === true && x.type === 'token'
+        x => x.isSlp === true && x.type === 'token' && x.tokenType === 1
       )
 
       // Hydrate the UTXOs with additional token data.
       type1TokenUtxos = await this.hydrateTokenData(type1TokenUtxos)
 
-      // Collect and hydrate any baton UTXOs
+      // Collect and hydrate any type1 baton UTXOs
       const bchUtxos = utxos.filter(x => x.isSlp === false)
       let type1BatonUtxos = utxos.filter(
-        x => x.isSlp === true && x.type === 'baton'
+        x => x.isSlp === true && x.type === 'baton' && x.tokenType === 1
       )
       type1BatonUtxos = await this.hydrateTokenData(type1BatonUtxos)
 
+      // Collect and hydrate NFT Group tokens
+      let nftGroupTokenUtxos = utxos.filter(
+        x => x.isSlp === true && x.type === 'token' && x.tokenType === 129
+      )
+      nftGroupTokenUtxos = await this.hydrateTokenData(nftGroupTokenUtxos)
+
+      // Collect and hydrate any Group baton UTXOs
+      let groupBatonUtxos = utxos.filter(
+        x => x.isSlp === true && x.type === 'baton' && x.tokenType === 129
+      )
+      groupBatonUtxos = await this.hydrateTokenData(groupBatonUtxos)
+
+      // Collect and hydrate NFT child tokens
+      let nftChildTokenUtxos = utxos.filter(
+        x => x.isSlp === true && x.type === 'token' && x.tokenType === 65
+      )
+      nftChildTokenUtxos = await this.hydrateTokenData(nftChildTokenUtxos)
+
       // Isolate any UTXOs that are marked null by the SLP indexer.
       const nullUtxos = utxos.filter(x => x.isSlp === null)
 
@@ -175,7 +194,13 @@ class UTXO {
             tokens: type1TokenUtxos,
             mintBatons: type1BatonUtxos
           },
-          nft: {} // Allocated for future support of NFT spec.
+          group: {
+            tokens: nftGroupTokenUtxos,
+            mintBatons: groupBatonUtxos
+          },
+          nft: {
+            tokens: nftChildTokenUtxos
+          }
         },
         nullUtxos
       }
@@ -229,14 +254,16 @@ class UTXO {
         thisUtxo.documentHash = genData[0].tokenData.documentHash
         thisUtxo.decimals = genData[0].tokenData.decimals
 
-        // Calculate the real token quantity
-        const qty = new BigNumber(thisUtxo.qty).dividedBy(
-          10 ** parseInt(thisUtxo.decimals)
-        )
-        thisUtxo.qtyStr = qty.toString()
+        if (thisUtxo.type !== 'baton') {
+          // Calculate the real token quantity
+          const qty = new BigNumber(thisUtxo.qty).dividedBy(
+            10 ** parseInt(thisUtxo.decimals)
+          )
+          thisUtxo.qtyStr = qty.toString()
 
-        // tokenQty is property expected by SLP.tokentype1.js library
-        thisUtxo.tokenQty = thisUtxo.qtyStr
+          // tokenQty is property expected by SLP.tokentype1.js library
+          thisUtxo.tokenQty = thisUtxo.qtyStr
+        }
       }
 
       return utxoAry

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

@@ -124,6 +124,24 @@ describe('#psf-slp-indexer', () => {
       }
     })
   })
+
+  describe('#getTokenData', () => {
+    it('should get token data', async () => {
+      const tokenId =
+        'f055256b938f1ecfa270459d6f12c7c8c82b66d3263c03d5074445a2b1a498a3'
+
+      const result = await bchjs.PsfSlpIndexer.getTokenData(tokenId)
+      // console.log('result: ', result)
+
+      assert.property(result, 'genesisData')
+      assert.property(result, 'immutableData')
+      assert.property(result, 'mutableData')
+
+      assert.isObject(result.genesisData)
+      assert.isObject(result.immutableData)
+      assert.isObject(result.mutableData)
+    })
+  })
 })
 
 // Promise-based sleep function

test/integration/chains/bchn/utxo-integration.js

@@ -83,10 +83,8 @@ describe('#UTXO', () => {
       assert.equal(result.slpUtxos.type1.mintBatons.length, 0)
     })
 
-    // TODO: NFTs are currently not identified as different than normal BCH UTXOs.
-    // The psf-slp-indexer needs to be updated to fix this issue.
-    it('should handle minting batons', async () => {
-      const addr = 'simpleledger:qrm0c67wwqh0w7wjxua2gdt2xggnm90xwsr5k22euj'
+    it('should handle Type1 minting batons', async () => {
+      const addr = 'simpleledger:qz5l5yzz9r09hw9aadcz53elp2knx6gyg5qk3s8md7'
 
       const result = await bchjs.Utxo.get(addr)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
@@ -105,13 +103,23 @@ describe('#UTXO', () => {
       assert.equal(result.slpUtxos.type1.tokens.length, 0)
     })
 
-    it('should handle Group NFTs', async () => {
-      const addr = 'bitcoincash:qrnghwrfgccf3s5e9wnglzxegcnhje9rkcwv2eka33'
+    it('should filter Group tokens and mint batons', async () => {
+      const addr = 'bitcoincash:qzeqcrpe5fcnslv8rfqjq4gh4gzdwytmdc4qmh0ztv'
 
       const result = await bchjs.Utxo.get(addr)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
-      assert.equal(result.nullUtxos.length, 0)
+      assert.isAbove(result.slpUtxos.group.tokens.length, 0)
+      assert.isAbove(result.slpUtxos.group.mintBatons.length, 0)
+    })
+
+    it('should filter NFTs', async () => {
+      const addr = 'simpleledger:qq7vp2kvejsql898a2760kuq6xz00h0a5vuwu9lywu'
+
+      const result = await bchjs.Utxo.get(addr)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.isAbove(result.slpUtxos.nft.tokens.length, 0)
     })
   })
 })

test/unit/fixtures/psf-slp-indexer-mock.js

@@ -144,10 +144,23 @@ const tokenData01 = {
   qty: {}
 }
 
+const tokenData = {
+  genesisData: tokenStats.tokenData,
+  immutableData: {
+    issuer: 'Launchpad Intellectual Property, Inc.',
+    website: 'http://launchpadip.com/',
+    dateCreated: '2022-01-11'
+  },
+  mutableData: {
+    tokenIcon: 'https://gateway.ipfs.io/ipfs/bafybeiehitanirn5gmhqjg44xrmdtomn4n5lu5yjoepsvgpswk5mggaw6i/LP_logo-1.png',
+    about: 'Mutable data managed with npm package: https://www.npmjs.com/package/slp-mutable-data'
+  }
+}
 module.exports = {
   tokenStats,
   txData,
   balance,
   status,
-  tokenData01
+  tokenData01,
+  tokenData
 }

test/unit/psf-slp-indexer.js

@@ -336,4 +336,79 @@ describe('#PsfSlpIndexer', () => {
       assert.equal(result, false)
     })
   })
+
+  describe('#getTokenData', () => {
+    it('should GET token data', async () => {
+      // Stub the network call.
+      sandbox.stub(axios, 'post').resolves({ data: mockData.tokenData })
+
+      const tokenId =
+        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+      const result = await bchjs.PsfSlpIndexer.getTokenData(tokenId)
+      assert.property(result, 'genesisData')
+      assert.property(result, 'immutableData')
+      assert.property(result, 'mutableData')
+
+      assert.isObject(result.genesisData)
+      assert.isObject(result.immutableData)
+      assert.isObject(result.mutableData)
+
+      assert.property(result.genesisData, 'type')
+      assert.property(result.genesisData, 'ticker')
+      assert.property(result.genesisData, 'name')
+      assert.property(result.genesisData, 'tokenId')
+      assert.property(result.genesisData, 'documentUri')
+      assert.property(result.genesisData, 'documentHash')
+      assert.property(result.genesisData, 'decimals')
+      assert.property(result.genesisData, 'mintBatonIsActive')
+      assert.property(result.genesisData, 'tokensInCirculationBN')
+      assert.property(result.genesisData, 'tokensInCirculationStr')
+      assert.property(result.genesisData, 'blockCreated')
+      assert.property(result.genesisData, 'totalBurned')
+      assert.property(result.genesisData, 'totalMinted')
+    })
+
+    it('should throw an error for improper input', async () => {
+      try {
+        const tokenId = 12345
+
+        await bchjs.PsfSlpIndexer.getTokenData(tokenId)
+        assert.equal(true, false, 'Unexpected result!')
+      } catch (err) {
+        // console.log(`err: `, err)
+        assert.include(err.message, 'Input tokenId must be a string.')
+      }
+    })
+
+    it('should handle axios error', async () => {
+      try {
+        // Stub the network call.
+        sandbox.stub(axios, 'post').throws(new Error('test error'))
+
+        const tokenId =
+          'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+        await bchjs.PsfSlpIndexer.getTokenData(tokenId)
+        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+        assert.equal(true, false, 'Unexpected result!')
+      } catch (err) {
+        assert.include(err.message, 'test error')
+      }
+    })
+
+    it('should handle request error', async () => {
+      try {
+        // Stub the network call.
+        const testErr = new Error()
+        testErr.response = { data: { status: 422 } }
+        sandbox.stub(axios, 'post').throws(testErr)
+
+        const tokenId =
+          'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+        await bchjs.PsfSlpIndexer.getTokenData(tokenId)
+        assert.equal(true, false, 'Unexpected result!')
+      } catch (err) {
+        assert.equal(err.status, 422)
+      }
+    })
+  })
 })