@psf/bch-js 5.1.0 → 5.2.3

package/test/unit/fixtures/utxo-mocks.js

@@ -280,10 +280,214 @@ const electrumxUtxos = {
   ]
 }
 
+const fulcrumUtxos01 = {
+  success: true,
+  utxos: [
+    {
+      height: 674512,
+      tx_hash:
+        'acbb0d3ceef55aa3e5fafc19335ae4bf2f8edba3c0567547dfd402391db32230',
+      tx_pos: 1,
+      value: 546
+    },
+    {
+      height: 674512,
+      tx_hash:
+        'acbb0d3ceef55aa3e5fafc19335ae4bf2f8edba3c0567547dfd402391db32230',
+      tx_pos: 2,
+      value: 546
+    },
+    {
+      height: 674512,
+      tx_hash:
+        'eeddccc4d716f04157ea132ac93a48040fea34a6b57f3d8f0cccb7d1a731ab2b',
+      tx_pos: 1,
+      value: 546
+    },
+    {
+      height: 674513,
+      tx_hash:
+        '705bcc442e5a2770e560b528f52a47b1dcc9ce9ab6a8de9dfdefa55177f00d04',
+      tx_pos: 1,
+      value: 546
+    },
+    {
+      height: 674513,
+      tx_hash:
+        '705bcc442e5a2770e560b528f52a47b1dcc9ce9ab6a8de9dfdefa55177f00d04',
+      tx_pos: 2,
+      value: 546
+    },
+    {
+      height: 674513,
+      tx_hash:
+        '705bcc442e5a2770e560b528f52a47b1dcc9ce9ab6a8de9dfdefa55177f00d04',
+      tx_pos: 3,
+      value: 38134
+    }
+  ]
+}
+
+const fulcrumUtxos02 = {
+  success: true,
+  utxos: [
+    {
+      height: 674513,
+      tx_hash:
+        '705bcc442e5a2770e560b528f52a47b1dcc9ce9ab6a8de9dfdefa55177f00d04',
+      tx_pos: 3,
+      value: 38134
+    }
+  ]
+}
+
+const psfSlpIndexerUtxos01 = {
+  balance: {
+    utxos: [
+      {
+        txid:
+          'acbb0d3ceef55aa3e5fafc19335ae4bf2f8edba3c0567547dfd402391db32230',
+        vout: 1,
+        type: 'token',
+        qty: '10000000000',
+        tokenId:
+          'acbb0d3ceef55aa3e5fafc19335ae4bf2f8edba3c0567547dfd402391db32230',
+        address: 'bitcoincash:qrm0c67wwqh0w7wjxua2gdt2xggnm90xws00a3lezv'
+      },
+      {
+        txid:
+          'acbb0d3ceef55aa3e5fafc19335ae4bf2f8edba3c0567547dfd402391db32230',
+        vout: 2,
+        type: 'baton',
+        tokenId:
+          'acbb0d3ceef55aa3e5fafc19335ae4bf2f8edba3c0567547dfd402391db32230',
+        address: 'bitcoincash:qrm0c67wwqh0w7wjxua2gdt2xggnm90xws00a3lezv'
+      }
+    ],
+    txs: [
+      {
+        txid:
+          'acbb0d3ceef55aa3e5fafc19335ae4bf2f8edba3c0567547dfd402391db32230',
+        height: 674512
+      }
+    ],
+    balances: [
+      {
+        tokenId:
+          'acbb0d3ceef55aa3e5fafc19335ae4bf2f8edba3c0567547dfd402391db32230',
+        qty: '10000000000'
+      }
+    ]
+  }
+}
+
+const tokenUtxos01 = [
+  {
+    txid: '384e1b8197e8de7d38f98317af2cf5f6bcb50007c46943b3498a6fab6e8aeb7c',
+    vout: 1,
+    type: 'token',
+    qty: '10000000',
+    tokenId: 'a436c8e1b6bee3d701c6044d190f76f774be83c36de8d34a988af4489e86dd37',
+    address: 'bitcoincash:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvg8nfhq4m'
+  },
+  {
+    txid: '4fc789405d58ec612c69eba29aa56cf0c7f228349801114138424eb68df4479d',
+    vout: 1,
+    type: 'token',
+    qty: '100000000',
+    tokenId: 'df808a41672a0a0ae6475b44f272a107bc9961b90f29dc918d71301f24fe92fb',
+    address: 'bitcoincash:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvg8nfhq4m'
+  },
+  {
+    txid: '42054bba4d69bfe7801ece0cffc754194b04239034fdfe9dbe321ef76c9a2d93',
+    vout: 5,
+    type: 'token',
+    qty: '4764',
+    tokenId: 'f05faf13a29c7f5e54ab921750aafb6afaa953db863bd2cf432e918661d4132f',
+    address: 'bitcoincash:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvg8nfhq4m'
+  },
+  {
+    txid: '06938d0a0d15aa76524ffe61fe111d6d2b2ea9dd8dcd4c7c7744614ced370861',
+    vout: 5,
+    type: 'token',
+    qty: '238',
+    tokenId: 'f05faf13a29c7f5e54ab921750aafb6afaa953db863bd2cf432e918661d4132f',
+    address: 'bitcoincash:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvg8nfhq4m'
+  }
+]
+
+const genesisData01 = {
+  tokenData: {
+    type: 1,
+    ticker: 'sleven',
+    name: 'sleven',
+    tokenId: 'a436c8e1b6bee3d701c6044d190f76f774be83c36de8d34a988af4489e86dd37',
+    documentUri: 'sleven',
+    documentHash: '',
+    decimals: 7,
+    mintBatonIsActive: false,
+    tokensInCirculationBN: '770059999999',
+    tokensInCirculationStr: '770059999999',
+    blockCreated: 555483,
+    totalBurned: '7711234568',
+    totalMinted: '777771234567'
+  }
+}
+
+const genesisData02 = {
+  tokenData: {
+    type: 1,
+    ticker: 'NAKAMOTO',
+    name: 'NAKAMOTO',
+    tokenId: 'df808a41672a0a0ae6475b44f272a107bc9961b90f29dc918d71301f24fe92fb',
+    documentUri: '',
+    documentHash: '',
+    decimals: 8,
+    mintBatonIsActive: false,
+    tokensInCirculationBN: '2099260968799900',
+    tokensInCirculationStr: '2099260968799900',
+    blockCreated: 555671,
+    totalBurned: '739031200100',
+    totalMinted: '2100000000000000'
+  }
+}
+
+const genesisData03 = {
+  tokenData: {
+    type: 1,
+    ticker: 'AUDC',
+    name: 'AUD Coin',
+    tokenId: 'f05faf13a29c7f5e54ab921750aafb6afaa953db863bd2cf432e918661d4132f',
+    documentUri: 'audcoino@gmail.com',
+    documentHash: '',
+    decimals: 6,
+    mintBatonIsActive: false,
+    tokensInCirculationBN: '974791786216512742',
+    tokensInCirculationStr: '974791786216512742',
+    blockCreated: 603311,
+    totalBurned: '1025208213783487258',
+    totalMinted: '2000000000000000000'
+  }
+}
+
+const noUtxoErr = {
+  success: false,
+  error:
+    'Key not found in database [bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7]'
+}
+
 module.exports = {
   mockUtxoData,
   mockHydratedUtxos,
   mockTwoHydratedAddrs,
   mockEveryUtxoType,
-  electrumxUtxos
+  electrumxUtxos,
+  fulcrumUtxos01,
+  fulcrumUtxos02,
+  psfSlpIndexerUtxos01,
+  tokenUtxos01,
+  genesisData01,
+  genesisData02,
+  genesisData03,
+  noUtxoErr
 }

package/test/unit/psf-slp-indexer.js

@@ -71,6 +71,7 @@ describe('#PsfSlpIndexer', () => {
       assert.isArray(result.balance.txs)
       assert.isArray(result.balance.balances)
     })
+
     it('should throw an error for improper input', async () => {
       try {
         const addr = 12345
@@ -82,6 +83,7 @@ describe('#PsfSlpIndexer', () => {
         assert.include(err.message, 'Input address must be a string.')
       }
     })
+
     it('should handle axios error', async () => {
       try {
         // Stub the network call.
@@ -96,6 +98,7 @@ describe('#PsfSlpIndexer', () => {
         assert.include(err.message, 'test error')
       }
     })
+
     it('should handle request error', async () => {
       try {
         // Stub the network call.
@@ -139,6 +142,7 @@ describe('#PsfSlpIndexer', () => {
       assert.property(result.tokenData, 'totalMinted')
       assert.property(result.tokenData, 'txs')
     })
+
     it('should throw an error for improper input', async () => {
       try {
         const tokenId = 12345
@@ -150,6 +154,7 @@ describe('#PsfSlpIndexer', () => {
         assert.include(err.message, 'Input tokenId must be a string.')
       }
     })
+
     it('should handle axios error', async () => {
       try {
         // Stub the network call.
@@ -164,6 +169,7 @@ describe('#PsfSlpIndexer', () => {
         assert.include(err.message, 'test error')
       }
     })
+
     it('should handle request error', async () => {
       try {
         // Stub the network call.
@@ -215,6 +221,7 @@ describe('#PsfSlpIndexer', () => {
       assert.property(result.txData, 'tokenDocHash')
       assert.property(result.txData, 'isValidSlp')
     })
+
     it('should throw an error for improper input', async () => {
       try {
         const txid = 12345
@@ -226,6 +233,7 @@ describe('#PsfSlpIndexer', () => {
         assert.include(err.message, 'Input txid must be a string.')
       }
     })
+
     it('should handle axios error', async () => {
       try {
         // Stub the network call.
@@ -249,6 +257,7 @@ describe('#PsfSlpIndexer', () => {
       sandbox.stub(axios, 'post').rejects(testErr)
 
       // Stub the call to the full node
+      sandbox.stub(bchjs.PsfSlpIndexer, 'checkBlacklist').resolves(false)
       sandbox
         .stub(bchjs.PsfSlpIndexer.rawTransaction, 'getTxData')
         .resolves({ txid: 'fakeTxid' })
@@ -259,6 +268,72 @@ describe('#PsfSlpIndexer', () => {
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
       assert.equal(result.txData.txid, 'fakeTxid')
+      assert.equal(result.txData.isValidSlp, false)
+    })
+
+    it('should return isValidSlp=null for blacklisted token', async () => {
+      // Stub the call to the SLP indexer.
+      const testErr = {
+        response: { data: { error: 'Key not found in database' } }
+      }
+      sandbox.stub(axios, 'post').rejects(testErr)
+
+      // Stub the call to the full node
+      sandbox.stub(bchjs.PsfSlpIndexer, 'checkBlacklist').resolves(true)
+      sandbox
+        .stub(bchjs.PsfSlpIndexer.rawTransaction, 'getTxData')
+        .resolves({ txid: 'fakeTxid' })
+
+      const txid =
+        'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2'
+      const result = await bchjs.PsfSlpIndexer.tx(txid)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.equal(result.txData.txid, 'fakeTxid')
+      assert.equal(result.txData.isValidSlp, null)
+    })
+  })
+
+  describe('#checkBlacklist', () => {
+    it('should return true if txid contains token in blacklist', async () => {
+      // Mock dependencies
+      sandbox
+        .stub(bchjs.PsfSlpIndexer.slpUtils, 'decodeOpReturn')
+        .resolves(mockData.tokenData01)
+
+      const txid =
+        '302113c11b90edc5f36c073d2f8a75e1e0eaf59b56235491a843d3819cd6a85f'
+
+      const result = await bchjs.PsfSlpIndexer.checkBlacklist(txid)
+      // console.log('result: ', result)
+
+      assert.equal(result, true)
+    })
+
+    it('should return false if there is an error', async () => {
+      // Force an error
+      sandbox
+        .stub(bchjs.PsfSlpIndexer.slpUtils, 'decodeOpReturn')
+        .rejects(new Error('test error'))
+
+      const result = await bchjs.PsfSlpIndexer.checkBlacklist()
+
+      assert.equal(result, false)
+    })
+
+    it('should return false if there is no tokenId match', async () => {
+      // Mock dependencies
+      mockData.tokenData01.tokenId = 'abc123'
+      sandbox
+        .stub(bchjs.PsfSlpIndexer.slpUtils, 'decodeOpReturn')
+        .resolves(mockData.tokenData01)
+
+      const txid =
+        '302113c11b90edc5f36c073d2f8a75e1e0eaf59b56235491a843d3819cd6a85f'
+
+      const result = await bchjs.PsfSlpIndexer.checkBlacklist(txid)
+
+      assert.equal(result, false)
     })
   })
 })

package/test/unit/utxo-unit.js

@@ -15,7 +15,7 @@ describe('#utxo', () => {
   beforeEach(() => (sandbox = sinon.createSandbox()))
   afterEach(() => sandbox.restore())
 
-  describe('#get', () => {
+  describe('#getOld', () => {
     it('should get hydrated and filtered UTXOs for an address', async () => {
       // Mock dependencies.
       sandbox.stub(bchjs.Utxo.electrumx, 'utxo').resolves(mockData.mockUtxoData)
@@ -25,7 +25,7 @@ describe('#utxo', () => {
 
       const addr = 'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9'
 
-      const result = await bchjs.Utxo.get(addr)
+      const result = await bchjs.Utxo.getOld(addr)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
       assert.isArray(result)
@@ -46,7 +46,7 @@ describe('#utxo', () => {
 
         const addr = 'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9'
 
-        await bchjs.Utxo.get(addr)
+        await bchjs.Utxo.getOld(addr)
 
         assert.fail('Unexpected code path')
       } catch (err) {
@@ -66,7 +66,7 @@ describe('#utxo', () => {
         'bitcoincash:qqh793x9au6ehvh7r2zflzguanlme760wuzehgzjh9'
       ]
 
-      const result = await bchjs.Utxo.get(addr)
+      const result = await bchjs.Utxo.getOld(addr)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
       assert.isArray(result)
@@ -88,7 +88,7 @@ describe('#utxo', () => {
           addrs.push(addr)
         }
 
-        await bchjs.Utxo.get(addrs)
+        await bchjs.Utxo.getOld(addrs)
 
         assert.fail('Unexpected code path')
       } catch (err) {
@@ -105,7 +105,7 @@ describe('#utxo', () => {
 
       const addr = 'simpleledger:qrm0c67wwqh0w7wjxua2gdt2xggnm90xwsr5k22euj'
 
-      const result = await bchjs.Utxo.get(addr)
+      const result = await bchjs.Utxo.getOld(addr)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
       assert.isArray(result)
@@ -133,7 +133,7 @@ describe('#utxo', () => {
       const addr = 'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9'
       const useWhitelist = true
 
-      const result = await bchjs.Utxo.get(addr, useWhitelist)
+      const result = await bchjs.Utxo.getOld(addr, useWhitelist)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
       assert.isArray(result)
@@ -188,4 +188,114 @@ describe('#utxo', () => {
       assert.equal(result.satoshis, 800)
     })
   })
+
+  describe('#hydrateTokenData', () => {
+    it('should hydrate token UTXOs', async () => {
+      // Mock dependencies
+      sandbox
+        .stub(bchjs.Utxo.psfSlpIndexer, 'tokenStats')
+        .onCall(0)
+        .resolves(mockData.genesisData01)
+        .onCall(1)
+        .resolves(mockData.genesisData02)
+        .onCall(2)
+        .resolves(mockData.genesisData03)
+
+      const result = await bchjs.Utxo.hydrateTokenData(mockData.tokenUtxos01)
+      // console.log('result: ', result)
+
+      assert.equal(result.length, 4)
+      assert.property(result[0], 'qtyStr')
+      assert.property(result[0], 'ticker')
+      assert.property(result[0], 'name')
+      assert.property(result[0], 'documentUri')
+      assert.property(result[0], 'documentHash')
+    })
+
+    it('should should catch and throw errors', async () => {
+      try {
+        // Force error
+        sandbox
+          .stub(bchjs.Utxo.psfSlpIndexer, 'tokenStats')
+          .rejects(new Error('test error'))
+
+        await bchjs.Utxo.hydrateTokenData(mockData.tokenUtxos01)
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.equal(err.message, 'test error')
+      }
+    })
+  })
+
+  describe('#get', () => {
+    it('should throw an error if input is not a string', async () => {
+      try {
+        const addr = 123
+
+        await bchjs.Utxo.get(addr)
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'address input must be a string')
+      }
+    })
+
+    it('should return UTXO information', async () => {
+      // mock dependencies
+      sandbox
+        .stub(bchjs.Utxo.electrumx, 'utxo')
+        .resolves(mockData.fulcrumUtxos01)
+      sandbox
+        .stub(bchjs.Utxo.psfSlpIndexer, 'balance')
+        .resolves(mockData.psfSlpIndexerUtxos01)
+      // Mock function to return the same input. Good enough for this test.
+      sandbox.stub(bchjs.Utxo, 'hydrateTokenData').resolves(x => x)
+
+      const addr = 'simpleledger:qrm0c67wwqh0w7wjxua2gdt2xggnm90xwsr5k22euj'
+
+      const result = await bchjs.Utxo.get(addr)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      // Assert expected properties exist
+      assert.property(result, 'address')
+      assert.property(result, 'bchUtxos')
+      assert.property(result, 'slpUtxos')
+      assert.property(result.slpUtxos, 'type1')
+      assert.property(result.slpUtxos.type1, 'tokens')
+      assert.property(result.slpUtxos.type1, 'mintBatons')
+      assert.property(result.slpUtxos, 'nft')
+      assert.property(result, 'nullUtxos')
+
+      assert.equal(result.bchUtxos.length, 4)
+      assert.equal(result.slpUtxos.type1.tokens.length, 1)
+      assert.equal(result.slpUtxos.type1.mintBatons.length, 1)
+      assert.equal(result.nullUtxos.length, 0)
+    })
+
+    it('should handle an address with no SLP UTXOs', async () => {
+      // mock dependencies
+      sandbox
+        .stub(bchjs.Utxo.electrumx, 'utxo')
+        .resolves(mockData.fulcrumUtxos02)
+
+      // Force psf-slp-indexer to return no UTXOs
+      sandbox
+        .stub(bchjs.Utxo.psfSlpIndexer, 'balance')
+        .rejects(mockData.noUtxoErr)
+
+      // Mock function to return the same input. Good enough for this test.
+      sandbox.stub(bchjs.Utxo, 'hydrateTokenData').resolves(() => [])
+
+      const addr = 'simpleledger:qrm0c67wwqh0w7wjxua2gdt2xggnm90xwsr5k22euj'
+
+      const result = await bchjs.Utxo.get(addr)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.equal(result.bchUtxos.length, 1)
+      assert.equal(result.slpUtxos.type1.tokens.length, 0)
+      assert.equal(result.slpUtxos.type1.mintBatons.length, 0)
+      assert.equal(result.nullUtxos.length, 0)
+    })
+  })
 })