@psf/bch-js 5.3.1 → 5.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@psf/bch-js",
-  "version": "5.3.1",
+  "version": "5.4.1",
   "description": "The FullStack.cash JavaScript library for Bitcoin Cash and SLP Tokens",
   "author": "Chris Troutner <chris.troutner@gmail.com>",
   "contributors": [
@@ -37,13 +37,11 @@
     "url": "git+https://github.com/Permissionless-Software-Foundation/bch-js.git"
   },
   "dependencies": {
-    "@psf/bip21": "2.0.1",
     "@chris.troutner/bip32-utils": "1.0.5",
+    "@psf/bip21": "2.0.1",
     "@psf/bitcoincash-ops": "2.0.0",
     "@psf/bitcoincashjs-lib": "4.0.2",
     "@psf/coininfo": "4.0.0",
-    "@uppy/core": "1.10.4",
-    "@uppy/tus": "1.5.12",
     "axios": "^0.21.4",
     "bc-bip68": "1.0.5",
     "bchaddrjs-slp": "0.2.5",
@@ -65,7 +63,7 @@
     "wif": "2.0.6"
   },
   "devDependencies": {
-    "apidoc": "0.17.7",
+    "apidoc": "^0.50.5",
     "assert": "2.0.0",
     "chai": "4.1.2",
     "coveralls": "3.0.2",
@@ -77,10 +75,10 @@
     "eslint-plugin-standard": "4.0.0",
     "husky": "^4.3.8",
     "lodash.clonedeep": "4.5.0",
-    "mocha": "9.1.3",
+    "mocha": "^9.2.1",
     "node-mocks-http": "1.7.0",
     "nyc": "15.1.0",
-    "semantic-release": "18.0.0",
+    "semantic-release": "^19.0.2",
     "sinon": "9.2.2",
     "standard": "^16.0.4"
   },

package/src/bch-js.js

@@ -28,7 +28,6 @@ const Script = require('./script')
 const Price = require('./price')
 const Schnorr = require('./schnorr')
 const SLP = require('./slp/slp')
-const IPFS = require('./ipfs')
 const Encryption = require('./encryption')
 const Utxo = require('./utxo')
 const Transaction = require('./transaction')
@@ -111,7 +110,6 @@ class BCHJS {
     this.SLP = new SLP(libConfig)
     this.SLP.HDNode = this.HDNode
 
-    this.IPFS = new IPFS()
     this.Utxo = new Utxo(libConfig)
     this.Transaction = new Transaction(libConfig)
 

package/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
   }
 
   /**
@@ -53,8 +53,8 @@ class PsfSlpIndexer {
    * @apiExample Example usage:
    * (async () => {
    *   try {
-   *     let status = await bchjs.PsfSlpIndexer.status();
-   *     console.log(status);
+   *     let status = await bchjs.PsfSlpIndexer.status()
+   *     console.log(status)
    *   } catch(error) {
    *    console.error(error)
    *   }
@@ -91,8 +91,8 @@ class PsfSlpIndexer {
    * @apiExample Example usage:
    * (async () => {
    *   try {
-   *     let balance = await bchjs.PsfSlpIndexer.balance('bitcoincash:qzmd5vxgh9m22m6fgvm57yd6kjnjl9qnwywsf3583n');
-   *     console.log(balance);
+   *     let balance = await bchjs.PsfSlpIndexer.balance('bitcoincash:qzmd5vxgh9m22m6fgvm57yd6kjnjl9qnwywsf3583n')
+   *     console.log(balance)
    *   } catch(error) {
    *    console.error(error)
    *   }
@@ -155,12 +155,14 @@ class PsfSlpIndexer {
    * @apiName Token Stats
    * @apiGroup PSF SLP
    * @apiDescription Return list stats for a single slp token.
+   * The second input is a Boolean, which determins the the transaction history
+   * of the token is included in the returned data. The default is false.
    *
    * @apiExample Example usage:
    * (async () => {
    *   try {
-   *     let tokenStats = await bchjs.PsfSlpIndexer.tokenStats('a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2');
-   *     console.log(tokenStats);
+   *     let tokenStats = await bchjs.PsfSlpIndexer.tokenStats('a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2', true)
+   *     console.log(tokenStats)
    *   } catch(error) {
    *    console.error(error)
    *   }
@@ -194,13 +196,13 @@ class PsfSlpIndexer {
    *
    */
 
-  async tokenStats (tokenId) {
+  async tokenStats (tokenId, withTxHistory = false) {
     try {
       // Handle single address.
       if (typeof tokenId === 'string') {
         const response = await axios.post(
           `${this.restURL}psf/slp/token`,
-          { tokenId },
+          { tokenId, withTxHistory },
           this.axiosOptions
         )
         return response.data
@@ -221,8 +223,8 @@ class PsfSlpIndexer {
    * @apiExample Example usage:
    * (async () => {
    *   try {
-   *     let txData = await bchjs.PsfSlpIndexer.tx('a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2');
-   *     console.log(txData);
+   *     let txData = await bchjs.PsfSlpIndexer.tx('a4fb5c2da1aa064e25018a43f9165040071d9e984ba190c222a7f59053af84b2')
+   *     console.log(txData)
    *   } catch(error) {
    *    console.error(error)
    *   }

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

@@ -40,13 +40,24 @@ describe('#psf-slp-indexer', () => {
   })
 
   describe('#tokenStats', () => {
-    it('should get stats on a token', async () => {
+    it('should get stats on a token, without tx history', async () => {
       const tokenId =
         '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0'
 
       const result = await bchjs.PsfSlpIndexer.tokenStats(tokenId)
       // console.log('result: ', result)
 
+      assert.property(result.tokenData, 'documentUri')
+      assert.property(result.tokenData, 'totalBurned')
+    })
+
+    it('should get stats on a token, with tx history', async () => {
+      const tokenId =
+        '38e97c5d7d3585a2cbf3f9580c82ca33985f9cb0845d4dcce220cb709f9538b0'
+
+      const result = await bchjs.PsfSlpIndexer.tokenStats(tokenId, true)
+      // console.log('result: ', result)
+
       assert.property(result.tokenData, 'documentUri')
       assert.property(result.tokenData, 'txs')
       assert.property(result.tokenData, 'totalBurned')

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

@@ -5,8 +5,8 @@
 const assert = require('chai').assert
 
 const BCHJS = require('../../../../src/bch-js')
-// const bchjs = new BCHJS()
-const bchjs = new BCHJS({ restURL: 'http://192.168.2.129:3000/v5/' })
+const bchjs = new BCHJS()
+// const bchjs = new BCHJS({ restURL: 'http://192.168.2.129:3000/v5/' })
 
 describe('#UTXO', () => {
   beforeEach(async () => {
@@ -15,154 +15,39 @@ describe('#UTXO', () => {
     if (process.env.IS_USING_FREE_TIER) await sleep(3000)
   })
 
-  if (process.env.TESTSLP) {
-    describe('#getOld', () => {
-      it('should get hydrated and filtered UTXOs for an address', async () => {
-        // const addr = 'bitcoincash:qqh793x9au6ehvh7r2zflzguanlme760wuzehgzjh9'
-        const addr = 'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9'
-
-        const result = await bchjs.Utxo.getOld(addr)
-        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-        assert.isArray(result)
-        assert.property(result[0], 'address')
-        assert.property(result[0], 'bchUtxos')
-        assert.property(result[0], 'nullUtxos')
-        assert.property(result[0], 'slpUtxos')
-        assert.isArray(result[0].bchUtxos)
-        assert.isArray(result[0].nullUtxos)
-      })
-
-      it('should handle an array of addresses', async () => {
-        const addr = [
-          'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9',
-          'bitcoincash:qqh793x9au6ehvh7r2zflzguanlme760wuzehgzjh9'
-        ]
-
-        const result = await bchjs.Utxo.getOld(addr)
-        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-        assert.isArray(result)
-        assert.property(result[0], 'address')
-        assert.property(result[0], 'bchUtxos')
-        assert.property(result[0], 'nullUtxos')
-        assert.property(result[0], 'slpUtxos')
-        assert.isArray(result[0].bchUtxos)
-        assert.isArray(result[0].nullUtxos)
-      })
-
-      it('should handle NFTs and minting batons', async () => {
-        const addr = 'simpleledger:qrm0c67wwqh0w7wjxua2gdt2xggnm90xwsr5k22euj'
-
-        const result = await bchjs.Utxo.getOld(addr)
-        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-        assert.isArray(result)
-        assert.property(result[0], 'address')
-        assert.property(result[0], 'bchUtxos')
-        assert.property(result[0], 'nullUtxos')
-        assert.property(result[0], 'slpUtxos')
-        assert.isArray(result[0].bchUtxos)
-        assert.isArray(result[0].nullUtxos)
-
-        assert.isArray(result[0].slpUtxos.type1.mintBatons)
-        assert.isArray(result[0].slpUtxos.type1.tokens)
-        assert.isArray(result[0].slpUtxos.nft.groupMintBatons)
-        assert.isArray(result[0].slpUtxos.nft.groupTokens)
-        assert.isArray(result[0].slpUtxos.nft.tokens)
-      })
-
-      it('should use the whitelist when flag is set', async () => {
-        const addr = 'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9'
-        const useWhitelist = true
-
-        const result = await bchjs.Utxo.getOld(addr, useWhitelist)
-        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-        assert.isArray(result)
-        assert.property(result[0], 'address')
-        assert.property(result[0], 'bchUtxos')
-        assert.property(result[0], 'nullUtxos')
-        assert.property(result[0], 'slpUtxos')
-        assert.isArray(result[0].bchUtxos)
-        assert.isArray(result[0].nullUtxos)
-
-        // Most token UTXOs should end up in the nullUtxos array.
-        assert.isAbove(result[0].bchUtxos.length, 0)
-        assert.isAbove(result[0].nullUtxos.length, 1)
-      })
-    })
-
-    describe('#findBiggestUtxo', () => {
-      it('should sort UTXOs from Electrumx', async () => {
-        const addr = 'bitcoincash:qq54fgjn3hz0357n8a6guy4demw9xfkjk5jcj0xr0z'
-
-        const electrumxUtxos = await bchjs.Electrumx.utxo(addr)
-        // console.log(`Electrumx utxos: ${JSON.stringify(electrumxUtxos, null, 2)}`)
-
-        const result = bchjs.Utxo.findBiggestUtxo(electrumxUtxos.utxos)
-        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-        assert.property(result, 'satoshis')
-        assert.equal(result.satoshis, 800)
-      })
-
-      it('should sort UTXOs from Utxos.get()', async () => {
-        const addr = 'bitcoincash:qq54fgjn3hz0357n8a6guy4demw9xfkjk5jcj0xr0z'
-
-        const utxos = await bchjs.Utxo.getOld(addr)
-        // console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
-
-        const result = bchjs.Utxo.findBiggestUtxo(utxos[0].bchUtxos)
-        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-        assert.property(result, 'satoshis')
-        assert.equal(result.satoshis, 800)
-      })
-    })
-  }
-
   describe('#hydrateTokenData', () => {
     it('should hydrate token UTXOs', async () => {
       const utxos = [
         {
-          txid:
-            '384e1b8197e8de7d38f98317af2cf5f6bcb50007c46943b3498a6fab6e8aeb7c',
+          txid: '384e1b8197e8de7d38f98317af2cf5f6bcb50007c46943b3498a6fab6e8aeb7c',
           vout: 1,
           type: 'token',
           qty: '10000000',
-          tokenId:
-            'a436c8e1b6bee3d701c6044d190f76f774be83c36de8d34a988af4489e86dd37',
+          tokenId: 'a436c8e1b6bee3d701c6044d190f76f774be83c36de8d34a988af4489e86dd37',
           address: 'bitcoincash:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvg8nfhq4m'
         },
         {
-          txid:
-            '4fc789405d58ec612c69eba29aa56cf0c7f228349801114138424eb68df4479d',
+          txid: '4fc789405d58ec612c69eba29aa56cf0c7f228349801114138424eb68df4479d',
           vout: 1,
           type: 'token',
           qty: '100000000',
-          tokenId:
-            'df808a41672a0a0ae6475b44f272a107bc9961b90f29dc918d71301f24fe92fb',
+          tokenId: 'df808a41672a0a0ae6475b44f272a107bc9961b90f29dc918d71301f24fe92fb',
           address: 'bitcoincash:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvg8nfhq4m'
         },
         {
-          txid:
-            '42054bba4d69bfe7801ece0cffc754194b04239034fdfe9dbe321ef76c9a2d93',
+          txid: '42054bba4d69bfe7801ece0cffc754194b04239034fdfe9dbe321ef76c9a2d93',
           vout: 5,
           type: 'token',
           qty: '4764',
-          tokenId:
-            'f05faf13a29c7f5e54ab921750aafb6afaa953db863bd2cf432e918661d4132f',
+          tokenId: 'f05faf13a29c7f5e54ab921750aafb6afaa953db863bd2cf432e918661d4132f',
           address: 'bitcoincash:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvg8nfhq4m'
         },
         {
-          txid:
-            '06938d0a0d15aa76524ffe61fe111d6d2b2ea9dd8dcd4c7c7744614ced370861',
+          txid: '06938d0a0d15aa76524ffe61fe111d6d2b2ea9dd8dcd4c7c7744614ced370861',
           vout: 5,
           type: 'token',
           qty: '238',
-          tokenId:
-            'f05faf13a29c7f5e54ab921750aafb6afaa953db863bd2cf432e918661d4132f',
+          tokenId: 'f05faf13a29c7f5e54ab921750aafb6afaa953db863bd2cf432e918661d4132f',
           address: 'bitcoincash:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvg8nfhq4m'
         }
       ]
@@ -226,7 +111,7 @@ describe('#UTXO', () => {
       const result = await bchjs.Utxo.get(addr)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
-      assert.isAbove(result.nullUtxos.length, 0)
+      assert.equal(result.nullUtxos.length, 0)
     })
   })
 })