@psf/bch-js 4.22.0 → 5.2.1

package/test/unit/transaction-unit.js

@@ -22,10 +22,10 @@ describe('#TransactionLib', () => {
   })
   afterEach(() => sandbox.restore())
 
-  describe('#get', () => {
+  describe('#getOld', () => {
     it('should throw an error if txid is not specified', async () => {
       try {
-        await bchjs.Transaction.get()
+        await bchjs.Transaction.getOld()
 
         assert.fail('Unexpected code path!')
       } catch (err) {
@@ -45,7 +45,7 @@ describe('#TransactionLib', () => {
         .stub(bchjs.Transaction.rawTransaction, 'getTxData')
         .resolves(mockData.nonSlpTxDetails)
 
-      const result = await bchjs.Transaction.get(txid)
+      const result = await bchjs.Transaction.getOld(txid)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
       // Assert that there are stanardized properties.
@@ -84,7 +84,7 @@ describe('#TransactionLib', () => {
       const txid =
         '266844d53e46bbd7dd37134688dffea6e54d944edff27a0add63dd0908839bc1'
 
-      const result = await bchjs.Transaction.get(txid)
+      const result = await bchjs.Transaction.getOld(txid)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
       // Assert that there are stanardized properties.
@@ -114,7 +114,7 @@ describe('#TransactionLib', () => {
           .stub(bchjs.Transaction.rawTransaction, 'getTxData')
           .rejects(new Error('test error'))
 
-        await bchjs.Transaction.get(txid)
+        await bchjs.Transaction.getOld(txid)
 
         assert.fail('Unexpected code path')
       } catch (err) {
@@ -147,7 +147,7 @@ describe('#TransactionLib', () => {
       const txid =
         '874306bda204d3a5dd15e03ea5732cccdca4c33a52df35162cdd64e30ea7f04e'
 
-      const result = await bchjs.Transaction.get(txid)
+      const result = await bchjs.Transaction.getOld(txid)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
       // Assert that there are stanardized properties.
@@ -195,7 +195,7 @@ describe('#TransactionLib', () => {
       const txid =
         '4640a734063ea79fa587a3cac38a70a2f6f3db0011e23514024185982110d0fa'
 
-      const result = await bchjs.Transaction.get(txid)
+      const result = await bchjs.Transaction.getOld(txid)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
       // Assert that there are stanardized properties.
@@ -246,7 +246,7 @@ describe('#TransactionLib', () => {
       const txid =
         '6bc111fbf5b118021d68355ca19a0e77fa358dd931f284b2550f79a51ab4792a'
 
-      const result = await bchjs.Transaction.get(txid)
+      const result = await bchjs.Transaction.getOld(txid)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
       // Assert that there are stanardized properties.
@@ -705,4 +705,15 @@ describe('#TransactionLib', () => {
       assert.equal(result.isSlpTx, true)
     })
   })
+
+  describe('#get', () => {
+    it('should proxy psf-slp-indexer', async () => {
+      // console.log('bchjs.Transaction: ', bchjs.Transaction)
+      sandbox.stub(bchjs.Transaction.psfSlpIndexer, 'tx').resolves('test data')
+
+      const result = await bchjs.Transaction.get()
+
+      assert.equal(result, 'test data')
+    })
+  })
 })

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,89 @@ 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)
+    })
+  })
 })

package/src/ninsight.js

@@ -1,319 +0,0 @@
-/*
-  This library interacts with the ninsight REST API endpoints operated by
-  Bitcoin.com
-*/
-
-const axios = require('axios')
-
-// let _this
-
-class Ninsight {
-  constructor (config) {
-    // this.restURL = config.restURL
-    // this.apiToken = config.apiToken
-
-    // this.ninsightURL = `https://bch-explorer.api.bitcoin.com/v1/`
-    if (config) {
-      this.ninsightURL = config.ninsightURL
-        ? config.ninsightURL
-        : 'https://rest.bitcoin.com/v2'
-    }
-
-    // Add JWT token to the authorization header.
-    this.axiosOptions = {
-      headers: {
-        authorization: `Token ${this.apiToken}`,
-        timeout: 15000
-      }
-    }
-
-    // _this = this
-  }
-
-  /**
-   * @api Ninsight.utxo()  utxo()
-   * @apiName Ninsight Utxo
-   * @apiGroup Ninsight
-   * @apiDescription Return list of uxto for address.
-   *
-   * @apiExample Example usage:
-   *    (async () => {
-   *   try {
-   *     let utxo = await bchjs.Ninsight.utxo('bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c');
-   *     console.log(utxo);
-   *   } catch(error) {
-   *    console.error(error)
-   *   }
-   * })()
-   *
-   *  // [
-   *  //   {
-   *  //     "txid": "d31dc2cf66fe4d3d3ae18e1065def58a64920746b1702b52f060e5edeea9883b",
-   *  //     "vout": 1,
-   *  //     "amount": 0.03608203,
-   *  //     "satoshis": 3608203,
-   *  //     "height": 585570,
-   *  //     "confirmations": 10392
-   *  //   },
-   *  //   {
-   *  //     "txid": "41e9a118765ecf7a1ba4487c0863e23dba343cc5880381a72f0365ac2546c5fa",
-   *  //     "vout": 0,
-   *  //     "amount": 0.03608203,
-   *  //     "satoshis": 3608203,
-   *  //     "height": 577125,
-   *  //     "confirmations": 18837
-   *  //   }
-   *  // ]
-   *
-   */
-  async utxo (address) {
-    try {
-      // Handle single address.
-      if (typeof address === 'string') {
-        const response = await axios.post(
-          `${this.ninsightURL}/address/utxo`,
-          {
-            addresses: [address]
-          },
-          this.axiosOptions
-        )
-        return response.data
-
-        // Handle array of addresses.
-      } else if (Array.isArray(address)) {
-        const response = await axios.post(
-          `${this.ninsightURL}/address/utxo`,
-          {
-            addresses: address
-          },
-          this.axiosOptions
-        )
-
-        return response.data
-      }
-
-      throw new Error('Input address must be a string or array of strings.')
-    } catch (error) {
-      if (error.response && error.response.data) throw error.response.data
-      else throw error
-    }
-  }
-
-  /**
-   * @api Ninsight.unconfirmed()  unconfirmed()
-   * @apiName Ninsight Unconfirmed Utxo
-   * @apiGroup Ninsight
-   * @apiDescription Returns a list of unconfirmed UTXOs for an address.
-   *
-   * @apiExample Example usage:
-   *    (async () => {
-   *   try {
-   *     let utxo = await bchjs.Ninsight.unconfirmed('bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c');
-   *     console.log(utxo);
-   *   } catch(error) {
-   *    console.error(error)
-   *   }
-   * })()
-   *
-   *  // [
-   *  //   {
-   *  //     "txid": "d31dc2cf66fe4d3d3ae18e1065def58a64920746b1702b52f060e5edeea9883b",
-   *  //     "vout": 1,
-   *  //     "amount": 0.03608203,
-   *  //     "satoshis": 3608203,
-   *  //     "confirmations": 0
-   *  //     "ts": 1559670801
-   *  //   },
-   *  //   {
-   *  //     "txid": "41e9a118765ecf7a1ba4487c0863e23dba343cc5880381a72f0365ac2546c5fa",
-   *  //     "vout": 0,
-   *  //     "amount": 0.03608203,
-   *  //     "satoshis": 3608203,
-   *  //     "confirmations": 0
-   *  //     "ts": 1559670902
-   *  //   }
-   *  // ]
-   *
-   */
-  async unconfirmed (address) {
-    try {
-      if (typeof address === 'string') {
-        const response = await axios.post(
-          `${this.ninsightURL}/address/unconfirmed`,
-          {
-            addresses: [address]
-          },
-          this.axiosOptions
-        )
-
-        return response.data
-      } else if (Array.isArray(address)) {
-        const response = await axios.post(
-          `${this.ninsightURL}/address/unconfirmed`,
-          {
-            addresses: address
-          },
-          this.axiosOptions
-        )
-
-        return response.data
-      }
-
-      throw new Error('Input address must be a string or array of strings.')
-    } catch (error) {
-      if (error.response && error.response.data) throw error.response.data
-      else throw error
-    }
-  }
-
-  /**
-   * @api Ninsight.transactions()  transactions()
-   * @apiName Ninsight TX History
-   * @apiGroup Ninsight
-   * @apiDescription Return transactions history for address.
-   *
-   * @apiExample Example usage:
-   *    (async () => {
-   *   try {
-   *     let txs = await bchjs.Ninsight.transactions('bitcoincash:qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c');
-   *     console.log(txs);
-   *   } catch(error) {
-   *    console.error(error)
-   *   }
-   * })()
-   *
-   *  // [
-   *  //   {
-   *  //     "pagesTotal": 1,
-   *  //     "txs": [
-   *  //       {
-   *  //         "txid": "ec7bc8349386e3e1939bbdc4f8092fdbdd6a380734e68486b558cd594c451d5b",
-   *  //         "version": 2,
-   *  //         "locktime": 0,
-   *  //         "vin": [
-   *  //           {
-   *  //             "txid": "4f1fc57c33659628938db740449bf92fb75799e1d5750a4aeef80eb52d6df1e0",
-   *  //             "vout": 0,
-   *  //             "sequence": 4294967295,
-   *  //             "n": 0,
-   *  //             ...
-   *  //           }
-   *  //           ...
-   *  //         ]
-   *  //         ...
-   *  //       }
-   *  //     ],
-   *  //     "legacyAddress": "1LpbYkEM5cryfhs58tH8c93p4SGzit7UrP",
-   *  //     "cashAddress": "bitcoincash:qrvk436u4r0ew2wj0rd9pnxhx4w90p2yfc29ta0d2n",
-   *  //     "currentPage": 0
-   *  //   }
-   *  // ]
-   *  //
-   *
-   */
-  async transactions (address) {
-    try {
-      if (typeof address === 'string') {
-        const response = await axios.post(
-          `${this.ninsightURL}/address/transactions`,
-          {
-            addresses: [address]
-          },
-          this.axiosOptions
-        )
-
-        return response.data
-      } else if (Array.isArray(address)) {
-        const response = await axios.post(
-          `${this.ninsightURL}/address/transactions`,
-          {
-            addresses: address
-          },
-          this.axiosOptions
-        )
-
-        return response.data
-      }
-
-      throw new Error('Input address must be a string or array of strings.')
-    } catch (error) {
-      if (error.response && error.response.data) throw error.response.data
-      else throw error
-    }
-  }
-
-  /**
-   * @api Ninsight.txDetails()  txDetails()
-   * @apiName Ninsight TX Details
-   * @apiGroup Ninsight
-   * @apiDescription Return transactions details for address(es).
-   *
-   * @apiExample Example usage:
-   *    (async () => {
-   *   try {
-   *     let result = await bchjs.Ninsight.txDetails('fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33');
-   *     console.log(result);
-   *   } catch(error) {
-   *    console.error(error)
-   *   }
-   * })()
-   *
-   *  // [
-   *  //   {
-   *  //     "txid": "fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33",
-   *  //     "version": 1,
-   *  //     "locktime": 0,
-   *  //     "vin": [
-   *  //       {
-   *  //         "sequence": 4294967295,
-   *  //         "n": 0
-   *  //       }
-   *  //     ],
-   *  //     "vout": [
-   *  //       ...
-   *  //     ],
-   *  //     "blockhash": "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09",
-   *  //     "blockheight": 1000,
-   *  //     "confirmations": 659909,
-   *  //     "time": 1232346882,
-   *  //     "blocktime": 1232346882,
-   *  //     "firstSeenTime": null,
-   *  //     "valueOut": 50,
-   *  //     "size": 135
-   *  //   }
-   *  // ]
-   *
-   */
-  async txDetails (txid) {
-    try {
-      if (typeof txid === 'string') {
-        const response = await axios.post(
-          `${this.ninsightURL}/transaction/details`,
-          {
-            txids: [txid]
-          },
-          this.axiosOptions
-        )
-
-        return response.data
-      } else if (Array.isArray(txid)) {
-        const response = await axios.post(
-          `${this.ninsightURL}/transaction/details`,
-          {
-            txids: txid
-          },
-          this.axiosOptions
-        )
-
-        return response.data
-      }
-
-      throw new Error('Transaction ID must be a string or array of strings.')
-    } catch (error) {
-      if (error.response && error.response.data) throw error.response.data
-      else throw error
-    }
-  }
-}
-
-module.exports = Ninsight