@psf/bch-js 5.1.0 → 5.2.0

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

@@ -21,7 +21,8 @@ const tokenStats = {
     totalMinted: '1',
     txs: [
       {
-        txid: '13cad617d523c8eb4ab11fff19c010e0e0a4ea4360b58e0c8c955a45a146a669',
+        txid:
+          '13cad617d523c8eb4ab11fff19c010e0e0a4ea4360b58e0c8c955a45a146a669',
         height: 722420,
         type: 'GENESIS',
         qty: '1'
@@ -39,11 +40,14 @@ const txData = {
     locktime: 0,
     vin: [
       {
-        txid: '8370db30d94761ab9a11b71ecd22541151bf6125c8c613f0f6fab8ab794565a7',
+        txid:
+          '8370db30d94761ab9a11b71ecd22541151bf6125c8c613f0f6fab8ab794565a7',
         vout: 0,
         scriptSig: {
-          asm: '304402207e9631c53dfc8a9a793d1916469628c6b7c5780c01c2f676d51ef21b0ba4926f022069feb471ec869a49f8d108d0aaba04e7cd36e60a7500109d86537f55698930d4[ALL|FORKID] 02791b19a39165dbd83403d6df268d44fd621da30581b0b6e5cb15a7101ed58851',
-          hex: '47304402207e9631c53dfc8a9a793d1916469628c6b7c5780c01c2f676d51ef21b0ba4926f022069feb471ec869a49f8d108d0aaba04e7cd36e60a7500109d86537f55698930d4412102791b19a39165dbd83403d6df268d44fd621da30581b0b6e5cb15a7101ed58851'
+          asm:
+            '304402207e9631c53dfc8a9a793d1916469628c6b7c5780c01c2f676d51ef21b0ba4926f022069feb471ec869a49f8d108d0aaba04e7cd36e60a7500109d86537f55698930d4[ALL|FORKID] 02791b19a39165dbd83403d6df268d44fd621da30581b0b6e5cb15a7101ed58851',
+          hex:
+            '47304402207e9631c53dfc8a9a793d1916469628c6b7c5780c01c2f676d51ef21b0ba4926f022069feb471ec869a49f8d108d0aaba04e7cd36e60a7500109d86537f55698930d4412102791b19a39165dbd83403d6df268d44fd621da30581b0b6e5cb15a7101ed58851'
         },
         sequence: 4294967295,
         address: 'bitcoincash:qpvsg9vl9a5mlf37a7n3yce6pktdctn73qwgaqm3wq',
@@ -58,16 +62,20 @@ const txData = {
         value: 0,
         n: 0,
         scriptPubKey: {
-          asm: 'OP_RETURN 5262419 1 47454e45534953 54524f5554 54726f75742773207465737420746f6b656e 74726f757473626c6f672e636f6d 0 2 2 000000174876e800',
-          hex: '6a04534c500001010747454e455349530554524f55541254726f75742773207465737420746f6b656e0e74726f757473626c6f672e636f6d4c000102010208000000174876e800',
+          asm:
+            'OP_RETURN 5262419 1 47454e45534953 54524f5554 54726f75742773207465737420746f6b656e 74726f757473626c6f672e636f6d 0 2 2 000000174876e800',
+          hex:
+            '6a04534c500001010747454e455349530554524f55541254726f75742773207465737420746f6b656e0e74726f757473626c6f672e636f6d4c000102010208000000174876e800',
           type: 'nulldata'
         },
         tokenQtyStr: '0',
         tokenQty: 0
       }
     ],
-    hex: '0200000001a7654579abb8faf6f013c6c82561bf51115422cd1eb7119aab6147d930db7083000000006a47304402207e9631c53dfc8a9a793d1916469628c6b7c5780c01c2f676d51ef21b0ba4926f022069feb471ec869a49f8d108d0aaba04e7cd36e60a7500109d86537f55698930d4412102791b19a39165dbd83403d6df268d44fd621da30581b0b6e5cb15a7101ed58851ffffffff040000000000000000476a04534c500001010747454e455349530554524f55541254726f75742773207465737420746f6b656e0e74726f757473626c6f672e636f6d4c000102010208000000174876e80022020000000000001976a914db4d39ceb7794ffe5d06855f249e1d3a7f1b024088ac22020000000000001976a914db4d39ceb7794ffe5d06855f249e1d3a7f1b024088accec20000000000001976a9145904159f2f69bfa63eefa712633a0d96dc2e7e8888ac00000000',
-    blockhash: '0000000000000000009f65225a3e12e23a7ea057c869047e0f36563a1f410267',
+    hex:
+      '0200000001a7654579abb8faf6f013c6c82561bf51115422cd1eb7119aab6147d930db7083000000006a47304402207e9631c53dfc8a9a793d1916469628c6b7c5780c01c2f676d51ef21b0ba4926f022069feb471ec869a49f8d108d0aaba04e7cd36e60a7500109d86537f55698930d4412102791b19a39165dbd83403d6df268d44fd621da30581b0b6e5cb15a7101ed58851ffffffff040000000000000000476a04534c500001010747454e455349530554524f55541254726f75742773207465737420746f6b656e0e74726f757473626c6f672e636f6d4c000102010208000000174876e80022020000000000001976a914db4d39ceb7794ffe5d06855f249e1d3a7f1b024088ac22020000000000001976a914db4d39ceb7794ffe5d06855f249e1d3a7f1b024088accec20000000000001976a9145904159f2f69bfa63eefa712633a0d96dc2e7e8888ac00000000',
+    blockhash:
+      '0000000000000000009f65225a3e12e23a7ea057c869047e0f36563a1f410267',
     confirmations: 97398,
     time: 1581773131,
     blocktime: 1581773131,
@@ -88,27 +96,32 @@ const balance = {
   balance: {
     utxos: [
       {
-        txid: 'a24a6a4abf06fabd799ecea4f8fac6a9ff21e6a8dd6169a3c2ebc03665329db9',
+        txid:
+          'a24a6a4abf06fabd799ecea4f8fac6a9ff21e6a8dd6169a3c2ebc03665329db9',
         vout: 1,
         type: 'token',
         qty: '1800',
-        tokenId: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
+        tokenId:
+          'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
         address: 'bitcoincash:qrqy3kj7r822ps6628vwqq5k8hyjl6ey3y4eea2m4s'
       }
     ],
     txs: [
       {
-        txid: '078b2c48ed1db0d5d5996f2889b8d847a49200d0a781f6aa6752f740f312688f',
+        txid:
+          '078b2c48ed1db0d5d5996f2889b8d847a49200d0a781f6aa6752f740f312688f',
         height: 717796
       },
       {
-        txid: 'a24a6a4abf06fabd799ecea4f8fac6a9ff21e6a8dd6169a3c2ebc03665329db9',
+        txid:
+          'a24a6a4abf06fabd799ecea4f8fac6a9ff21e6a8dd6169a3c2ebc03665329db9',
         height: 717832
       }
     ],
     balances: [
       {
-        tokenId: 'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
+        tokenId:
+          'a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2',
         qty: '1800'
       }
     ]
@@ -122,9 +135,19 @@ const status = {
     chainBlockHeight: 722679
   }
 }
+
+const tokenData01 = {
+  tokenType: 1,
+  txType: 'MINT',
+  tokenId: 'dd21be4532d93661e8ffe16db6535af0fb8ee1344d1fef81a193e2b4cfa9fbc9',
+  mintBatonVout: 2,
+  qty: {}
+}
+
 module.exports = {
   tokenStats,
   txData,
   balance,
-  status
+  status,
+  tokenData01
 }

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

@@ -280,10 +280,100 @@ 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 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'
+      }
+    ]
+  }
+}
+
 module.exports = {
   mockUtxoData,
   mockHydratedUtxos,
   mockTwoHydratedAddrs,
   mockEveryUtxoType,
-  electrumxUtxos
+  electrumxUtxos,
+  fulcrumUtxos01,
+  psfSlpIndexerUtxos01
 }

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,48 @@ describe('#utxo', () => {
       assert.equal(result.satoshis, 800)
     })
   })
+
+  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)
+
+      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)
+    })
+  })
 })