Merge pull request #146 from Permissionless-Software-Foundation/ct-unstable

fix(dependencies): Updating dependencies. 0 npm vulns

examples/README.md

@@ -1,3 +1,3 @@
-Examples have been moved to this repository:
+Examples have been moved to this repository
 
 https://github.com/Permissionless-Software-Foundation/bch-js-examples

package.json

@@ -4,12 +4,14 @@
   "description": "The FullStack.cash JavaScript library for Bitcoin Cash and SLP Tokens",
   "author": "Chris Troutner <chris.troutner@gmail.com>",
   "contributors": [
-    "Gabriel Cardona <gabriel@bitcoin.com>"
+    "Gabriel Cardona <gabriel@bitcoin.com>",
+    "Stoyan Zhekov <zh@zhware.net>"
   ],
   "main": "src/bch-js",
   "scripts": {
     "test": "nyc mocha --trace-warnings --unhandled-rejections=strict --timeout 30000 test/unit/",
     "test:integration": "npm run test:integration:bchn",
+    "test:integration:nft": "export RESTURL=https://bchn.fullstack.cash/v4/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 -g '#nft1' test/integration/chains/bchn/slp.js",
     "test:integration:abc": "export RESTURL=https://abc.fullstack.cash/v4/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/abc/",
     "test:integration:bchn": "export RESTURL=https://bchn.fullstack.cash/v4/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/bchn/",
     "test:integration:testnet": "IS_USING_FREE_TIER=true mocha --timeout 30000 test/integration/chains/testnet/",

src/blockchain.js

@@ -68,8 +68,8 @@ class Blockchain {
    * @apiName getBlock
    * @apiGroup Blockchain
    * @apiDescription
-   * If verbose is false, returns a string that is serialized, hex-encoded data for block 'hash'. If verbose is true, returns an Object with information about block hash.
-   *
+   * If verbose is 0, returns a string that is serialized, hex-encoded data for block 'hash'. If verbose is 1, returns an Object with information about block hash.
+   * If verbose is 2, returns an Object with information about block hash and information about tx.
    * @apiExample Example usage:
    * (async () => {
    * try {
@@ -80,28 +80,38 @@ class Blockchain {
    * }
    * })()
    *
-   * // { hash: '00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09',
-   * // confirmations: 528236,
-   * // size: 216,
-   * // height: 1000,
-   * // version: 1,
-   * // versionHex: '00000001',
-   * // merkleroot: 'fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33',
-   * // tx:
-   * //  [ 'fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33' ],
-   * // time: 1232346882,
-   * // mediantime: 1232344831,
-   * // nonce: 2595206198,
-   * // bits: '1d00ffff',
-   * // difficulty: 1,
-   * // chainwork: '000000000000000000000000000000000000000000000000000003e903e903e9',
-   * // previousblockhash: '0000000008e647742775a230787d66fdf92c46a48c896bfbc85cdc8acc67e87d',
-   * // nextblockhash: '00000000a2887344f8db859e372e7e4bc26b23b9de340f725afbf2edb265b4c6' }
+   * // {
+   * //  hash: '00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09',
+   * //  confirmations: 528236,
+   * //  size: 216,
+   * //  height: 1000,
+   * //  version: 1,
+   * //  versionHex: '00000001',
+   * //  merkleroot: 'fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33',
+   * //  tx:
+   * //   [ 'fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33' ],
+   * //  time: 1232346882,
+   * //  mediantime: 1232344831,
+   * //  nonce: 2595206198,
+   * //  bits: '1d00ffff',
+   * //  difficulty: 1,
+   * //  chainwork: '000000000000000000000000000000000000000000000000000003e903e903e9',
+   * //  previousblockhash: '0000000008e647742775a230787d66fdf92c46a48c896bfbc85cdc8acc67e87d',
+   * //  nextblockhash: '00000000a2887344f8db859e372e7e4bc26b23b9de340f725afbf2edb265b4c6'
+   * // }
    */
-  async getBlock (blockhash, verbose = true) {
+  async getBlock (blockhash, verbosity = 1) {
     try {
-      const response = await axios.get(
-        `${this.restURL}blockchain/getBlock/${blockhash}?verbose=${verbose}`,
+      // Input validation
+      if (!blockhash || typeof blockhash !== 'string') {
+        throw new Error('blockhash must be a string')
+      }
+      const response = await axios.post(
+        `${this.restURL}blockchain/getblock`,
+        {
+          blockhash,
+          verbosity
+        },
         _this.axiosOptions
       )
       return response.data

src/slp/nft1.js

@@ -8,16 +8,21 @@
   (Parent) token.
 */
 
+// Public npm libraries
+const axios = require('axios')
+
+// Local libraries.
 const Address = require('./address')
 
 // const BigNumber = require('bignumber.js')
 const slpMdm = require('slp-mdm')
 
+let _this
 // const addy = new Address()
 let addy
 const TransactionBuilder = require('../transaction-builder')
 
-class TokenType1 {
+class Nft1 {
   constructor (config) {
     this.restURL = config.restURL
 
@@ -25,6 +30,8 @@ class TokenType1 {
 
     // Instantiate the transaction builder.
     TransactionBuilder.setAddress(addy)
+
+    _this = this
   }
 
   /**
@@ -412,6 +419,97 @@ class TokenType1 {
       throw err
     }
   }
+
+  /**
+   * @api SLP.Nft1.listNFTGroupChildren() listNFTGroupChildren()
+   * @apiName listNFTGroupChildren
+   * @apiGroup SLP Nft1
+   * @apiDescription Return list of NFT children tokens in a NFT Group.
+   * It's assumed provided groupId parameter is for an NFT Group token (type=129)
+   *
+   * Returns an Array with GENESIS transaction IDs of the children tokens.
+   *
+   * @apiExample Example usage:
+   *
+   * const groupId = '68cd33ecd909068fbea318ae5ff1d6207cf754e53b191327d6d73b6916424c0a'
+   * const children = await bchjs.SLP.Nft1.listNFTGroupChildren(groupId)
+   *
+   * children = {
+   *  "nftChildren": [
+   *    "45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a9",
+   *    "928ce61fe1006b1325a0ba0dce700bf83986a6f0691ba26e121c9ac035d12a55"
+   *  ]
+   * }
+   */
+  async listNFTGroupChildren (groupId) {
+    try {
+      if (typeof groupId === 'string') {
+        const response = await axios.get(
+          `${this.restURL}slp/nftChildren/${groupId}`,
+          _this.axiosOptions
+        )
+        return response.data
+      }
+
+      throw new Error('groupId must be a string.')
+    } catch (error) {
+      // console.log('Error in listNFTGroupChildren()')
+      if (error.response && error.response.data) throw error.response.data
+      else throw error
+    }
+  }
+
+  /**
+   * @api SLP.Nft1.parentNFTGroup() parentNFTGroup()
+   * @apiName parentNFTGroup
+   * @apiGroup SLP Nft1
+   * @apiDescription Return parent NFT Group information for a given NFT child token.
+   * It's assumed provided groupId parameter is for an NFT Child token (type=65)
+   *
+   * Returns a JSON with NFT group information.
+   *
+   * @apiExample Example usage:
+   *
+   * const tokenId = '45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a9'
+   * const group = await bchjs.SLP.Nft1.parentNFTGroup(tokenId)
+   *
+   * group = {
+   *   "nftGroup": {
+   *     "decimals": 0,
+   *     "timestamp": "2021-05-03 10:36:01",
+   *     "timestamp_unix": 1620038161,
+   *     "versionType": 129,
+   *     "documentUri": "psfoundation.cash",
+   *     "symbol": "PSF.TEST.GROUP",
+   *     "name": "PSF Test NFT Group",
+   *     "containsBaton": true,
+   *     "id": "68cd33ecd909068fbea318ae5ff1d6207cf754e53b191327d6d73b6916424c0a",
+   *     "documentHash": null,
+   *     "initialTokenQty": 1000000,
+   *     "blockCreated": 686117,
+   *     "totalMinted": null,
+   *     "totalBurned": null,
+   *     "circulatingSupply": null
+   *   }
+   * }
+   */
+  async parentNFTGroup (tokenId) {
+    try {
+      if (typeof tokenId === 'string') {
+        const response = await axios.get(
+          `${this.restURL}slp/nftGroup/${tokenId}`,
+          _this.axiosOptions
+        )
+        return response.data
+      }
+
+      throw new Error('tokenId must be a string.')
+    } catch (error) {
+      // console.log('Error in parentNFTGroup()')
+      if (error.response && error.response.data) throw error.response.data
+      else throw error
+    }
+  }
 }
 
-module.exports = TokenType1
+module.exports = Nft1

src/slp/slp.js

@@ -41,7 +41,7 @@ class SLP {
     this.Address = new Address(config)
     this.ECPair = ECPair
     this.TokenType1 = new TokenType1(config)
-    this.NFT1 = new NFT1(this.restURL)
+    this.NFT1 = new NFT1(config)
     this.Utils = new Utils(config)
   }
 }

test/integration/blockchain.js

@@ -276,6 +276,43 @@ describe('#blockchain', () => {
       assert.equal(result, null)
     })
   })
+  describe('#getBlock', () => {
+    it('should get block information with default verbosity', async () => {
+      const blockhash =
+        '0000000000000000008e8d83cba6d45a9314bc2ef4538d4e0577c6bed8593536'
+      const result = await bchjs.Blockchain.getBlock(blockhash)
+
+      assert.hasAllKeys(result, [
+        'hash',
+        'confirmations',
+        'size',
+        'height',
+        'version',
+        'versionHex',
+        'merkleroot',
+        'tx',
+        'time',
+        'mediantime',
+        'nonce',
+        'bits',
+        'difficulty',
+        'chainwork',
+        'nTx',
+        'previousblockhash',
+        'nextblockhash'
+      ])
+      assert.isArray(result.tx)
+    })
+
+    it('should get block information with verbosity 0', async () => {
+      const blockhash =
+        '0000000000000000008e8d83cba6d45a9314bc2ef4538d4e0577c6bed8593536'
+      const verbosity = 0
+      const result = await bchjs.Blockchain.getBlock(blockhash, verbosity)
+
+      assert.isString(result)
+    })
+  })
 })
 
 function sleep (ms) {

test/integration/chains/bchn-no-wl-slpdb/rawtransaction.js

@@ -0,0 +1,71 @@
+/*
+  Integration tests for the bchjs. Only covers calls made to
+  rest.bitcoin.com.
+
+  TODO
+*/
+
+const chai = require('chai')
+const assert = chai.assert
+const BCHJS = require('../../../../src/bch-js')
+const bchjs = new BCHJS()
+
+// Inspect utility used for debugging.
+const util = require('util')
+util.inspect.defaultOptions = {
+  showHidden: true,
+  colors: true,
+  depth: 3
+}
+
+describe('#rawtransaction', () => {
+  beforeEach(async () => {
+    if (process.env.IS_USING_FREE_TIER) await sleep(3000)
+  })
+
+  /*
+    Testing sentRawTransaction isn't really possible with an integration test,
+    as the endpoint really needs an e2e test to be properly tested. The tests
+    below expect error messages returned from the server, but at least test
+    that the server is responding on those endpoints, and responds consistently.
+  */
+  describe('sendRawTransaction', () => {
+    it('should send a single transaction hex', async () => {
+      try {
+        const hex =
+          '01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000'
+
+        await bchjs.RawTransactions.sendRawTransaction(hex)
+        // console.log(`result ${JSON.stringify(result, null, 2)}`)
+
+        assert.equal(true, false, 'Unexpected result!')
+      } catch (err) {
+        // console.log(`err: ${util.inspect(err)}`)
+
+        assert.hasAllKeys(err, ['error'])
+        assert.include(err.error, 'Missing inputs')
+      }
+    })
+
+    it('should send an array of tx hexes', async () => {
+      try {
+        const hexes = [
+          '01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000',
+          '01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000'
+        ]
+
+        const result = await bchjs.RawTransactions.sendRawTransaction(hexes)
+        console.log(`result ${JSON.stringify(result, null, 2)}`)
+      } catch (err) {
+        // console.log(`err: ${util.inspect(err)}`)
+
+        assert.hasAllKeys(err, ['error'])
+        assert.include(err.error, 'Missing inputs')
+      }
+    })
+  })
+})
+
+function sleep (ms) {
+  return new Promise(resolve => setTimeout(resolve, ms))
+}

test/integration/chains/bchn-no-wl-slpdb/slp.js

@@ -0,0 +1,273 @@
+/*
+  Integration tests for the bchjs covering SLP tokens.
+  These tests are specific to the ABC chain.
+*/
+
+const chai = require('chai')
+const assert = chai.assert
+
+const BCHJS = require('../../../../src/bch-js')
+let bchjs
+
+// Inspect utility used for debugging.
+const util = require('util')
+util.inspect.defaultOptions = {
+  showHidden: true,
+  colors: true,
+  depth: 1
+}
+
+describe('#SLP', () => {
+  // before(() => {
+  //   console.log(`bchjs.SLP.restURL: ${bchjs.SLP.restURL}`)
+  //   console.log(`bchjs.SLP.apiToken: ${bchjs.SLP.apiToken}`)
+  // })
+
+  beforeEach(async () => {
+    // Introduce a delay so that the BVT doesn't trip the rate limits.
+    if (process.env.IS_USING_FREE_TIER) await sleep(3000)
+
+    bchjs = new BCHJS()
+  })
+
+  describe('#util', () => {
+    describe('#decodeOpReturn', () => {
+      it('should decode a NFT Child transaction', async () => {
+        const txid =
+          'eeddccc4d716f04157ea132ac93a48040fea34a6b57f3d8f0cccb7d1a731ab2b'
+
+        const data = await bchjs.SLP.Utils.decodeOpReturn(txid)
+        // console.log(`data: ${JSON.stringify(data, null, 2)}`)
+
+        assert.property(data, 'tokenType')
+        assert.property(data, 'txType')
+        assert.property(data, 'ticker')
+        assert.property(data, 'name')
+        assert.property(data, 'tokenId')
+        assert.property(data, 'documentUri')
+        assert.property(data, 'documentHash')
+        assert.property(data, 'decimals')
+        assert.property(data, 'mintBatonVout')
+        assert.property(data, 'qty')
+
+        assert.equal(data.tokenType, 65)
+        assert.equal(data.mintBatonVout, 0)
+        assert.equal(data.qty, '1')
+      })
+    })
+
+    describe('#tokenUtxoDetails', () => {
+      it('should handle a range of UTXO types', async () => {
+        const utxos = [
+          // Malformed SLP tx
+          {
+            note: 'Malformed SLP tx',
+            tx_hash:
+              'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a',
+            tx_pos: 1,
+            value: 546
+          },
+          // Normal TX (non-SLP)
+          {
+            note: 'Normal TX (non-SLP)',
+            tx_hash:
+              '01cdaec2f8b311fc2d6ecc930247bd45fa696dc204ab684596e281fe1b06c1f0',
+            tx_pos: 0,
+            value: 400000
+          },
+          // Valid PSF SLP tx
+          {
+            note: 'Valid PSF SLP tx',
+            tx_hash:
+              'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd',
+            tx_pos: 1,
+            value: 546
+          },
+          // Valid SLP token not in whitelist
+          {
+            note: 'Valid SLP token not in whitelist',
+            tx_hash:
+              '3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488',
+            tx_pos: 1,
+            value: 546
+          },
+          // Token send on BCHN network.
+          {
+            note: 'Token send on BCHN network',
+            tx_hash:
+              '402c663379d9699b6e2dd38737061e5888c5a49fca77c97ab98e79e08959e019',
+            tx_pos: 1,
+            value: 546
+          },
+          // Token send on ABC network.
+          {
+            note: 'Token send on ABC network',
+            tx_hash:
+              '336bfe2168aac4c3303508a9e8548a0d33797a83b85b76a12d845c8d6674f79d',
+            tx_pos: 1,
+            value: 546
+          },
+          // Known invalid SLP token send of PSF tokens.
+          {
+            note: 'Known invalid SLP token send of PSF tokens',
+            tx_hash:
+              '2bf691ad3679d928fef880b8a45b93b233f8fa0d0a92cf792313dbe77b1deb74',
+            tx_pos: 1,
+            value: 546
+          }
+        ]
+
+        const data = await bchjs.SLP.Utils.tokenUtxoDetails(utxos)
+        // console.log(`data: ${JSON.stringify(data, null, 2)}`)
+
+        // Malformed SLP tx
+        assert.equal(data[0].tx_hash, utxos[0].tx_hash)
+        assert.equal(data[0].isValid, false)
+
+        // Normal TX (non-SLP)
+        assert.equal(data[1].tx_hash, utxos[1].tx_hash)
+        assert.equal(data[1].isValid, false)
+
+        // Valid PSF SLP tx
+        assert.equal(data[2].tx_hash, utxos[2].tx_hash)
+        assert.equal(data[2].isValid, true)
+
+        // Valid SLP token not in whitelist
+        assert.equal(data[3].tx_hash, utxos[3].tx_hash)
+        assert.equal(data[3].isValid, true)
+
+        // Token send on BCHN network
+        assert.equal(data[4].tx_hash, utxos[4].tx_hash)
+        assert.equal(data[4].isValid, true)
+
+        // Token send on ABC network
+        assert.equal(data[5].tx_hash, utxos[5].tx_hash)
+        assert.equal(data[5].isValid, null)
+
+        // Known invalid SLP token send of PSF tokens
+        assert.equal(data[6].tx_hash, utxos[6].tx_hash)
+        assert.equal(data[6].isValid, false)
+      })
+    })
+
+    describe('#validateTxid3', () => {
+      it('should invalidate a known invalid TXID', async () => {
+        const txid =
+          'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a'
+
+        const result = await bchjs.SLP.Utils.validateTxid3(txid)
+        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+        assert.isArray(result)
+
+        assert.property(result[0], 'txid')
+        assert.equal(result[0].txid, txid)
+
+        assert.property(result[0], 'valid')
+        assert.equal(result[0].valid, null)
+      })
+
+      it('should validate a known valid TXID', async () => {
+        const txid =
+          'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd'
+
+        const result = await bchjs.SLP.Utils.validateTxid3(txid)
+        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+        assert.isArray(result)
+
+        assert.property(result[0], 'txid')
+        assert.equal(result[0].txid, txid)
+
+        assert.property(result[0], 'valid')
+        assert.equal(result[0].valid, true)
+      })
+
+      it('should handle a mix of valid, invalid, and non-SLP txs', async () => {
+        const txids = [
+          // Malformed SLP tx
+          'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a',
+          // Normal TX (non-SLP)
+          '01cdaec2f8b311fc2d6ecc930247bd45fa696dc204ab684596e281fe1b06c1f0',
+          // Valid PSF SLP tx
+          'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd',
+          // Valid SLP token not in whitelist
+          '3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488',
+          // Unprocessed SLP TX
+          '402c663379d9699b6e2dd38737061e5888c5a49fca77c97ab98e79e08959e019'
+        ]
+
+        const result = await bchjs.SLP.Utils.validateTxid3(txids)
+        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+        assert.isArray(result)
+
+        assert.equal(result[0].txid, txids[0])
+        assert.equal(result[0].valid, null)
+
+        assert.equal(result[1].txid, txids[1])
+        assert.equal(result[1].valid, null)
+
+        assert.equal(result[2].txid, txids[2])
+        assert.equal(result[2].valid, true)
+
+        // True in validateTxid() (no whitelist SLPDB) but null in validateTxid3()
+        assert.equal(result[3].txid, txids[3])
+        assert.equal(result[3].valid, true)
+
+        // Note: This should change from null to true once SLPDB finishes indexing.
+        assert.equal(result[4].txid, txids[4])
+        // True when no whitelist SLPDB is used.
+        assert.equal(result[4].valid, true)
+      })
+    })
+
+    describe('#validateTxid', () => {
+      it('should handle a mix of valid, invalid, and non-SLP txs', async () => {
+        const txids = [
+          // Malformed SLP tx
+          'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a',
+          // Normal TX (non-SLP)
+          '01cdaec2f8b311fc2d6ecc930247bd45fa696dc204ab684596e281fe1b06c1f0',
+          // Valid PSF SLP tx
+          'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd',
+          // Valid SLP token not in whitelist
+          '3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488',
+          // Token send on BCHN network.
+          '402c663379d9699b6e2dd38737061e5888c5a49fca77c97ab98e79e08959e019',
+          // Token send on ABC network.
+          '336bfe2168aac4c3303508a9e8548a0d33797a83b85b76a12d845c8d6674f79d'
+        ]
+
+        const result = await bchjs.SLP.Utils.validateTxid(txids)
+        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+        assert.isArray(result)
+
+        assert.equal(result[0].txid, txids[0])
+        assert.equal(result[0].valid, null)
+
+        assert.equal(result[1].txid, txids[1])
+        assert.equal(result[1].valid, null)
+
+        assert.equal(result[2].txid, txids[2])
+        assert.equal(result[2].valid, true)
+
+        // True in validateTxid() but null in validateTxid3()
+        assert.equal(result[3].txid, txids[3])
+        assert.equal(result[3].valid, true)
+
+        assert.equal(result[4].txid, txids[4])
+        assert.equal(result[4].valid, true)
+
+        assert.equal(result[5].txid, txids[5])
+        assert.equal(result[5].valid, null)
+      })
+    })
+  })
+})
+
+// Promise-based sleep function
+function sleep (ms) {
+  return new Promise(resolve => setTimeout(resolve, ms))
+}

test/integration/chains/bchn-no-wl-slpdb/utxo-integration.js

@@ -0,0 +1,105 @@
+/*
+  Integration tests for the utxo.js library.
+*/
+
+const assert = require('chai').assert
+
+const BCHJS = require('../../../../src/bch-js')
+const bchjs = new BCHJS()
+
+describe('#UTXO', () => {
+  beforeEach(async () => {
+    // sandbox = sinon.createSandbox()
+
+    if (process.env.IS_USING_FREE_TIER) await sleep(3000)
+  })
+
+  describe('#get', () => {
+    it('should get hydrated and filtered UTXOs for an address', async () => {
+      // const addr = 'bitcoincash:qqh793x9au6ehvh7r2zflzguanlme760wuzehgzjh9'
+      const addr = 'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9'
+
+      const result = await bchjs.Utxo.get(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.get(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.get(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)
+    })
+  })
+
+  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.get(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)
+    })
+  })
+})
+
+function sleep (ms) {
+  return new Promise(resolve => setTimeout(resolve, ms))
+}

test/integration/chains/bchn/slp.js

@@ -264,6 +264,31 @@ describe('#SLP', () => {
       })
     })
   })
+  describe('#nft1', () => {
+    describe('#listNFTGroupChildren', () => {
+      it('should return array of children GENESIS transactions IDs', async () => {
+        const groupId = '68cd33ecd909068fbea318ae5ff1d6207cf754e53b191327d6d73b6916424c0a'
+        const result = await bchjs.SLP.NFT1.listNFTGroupChildren(groupId)
+        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+        assert.property(result, 'nftChildren')
+        assert.isArray(result.nftChildren)
+      })
+    })
+    describe('#parentNFTGroup', () => {
+      it('should return parent NFT group information', async () => {
+        const tokenId = '45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a9'
+        const result = await bchjs.SLP.NFT1.parentNFTGroup(tokenId)
+        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+        assert.property(result, 'nftGroup')
+        assert.property(result.nftGroup, 'id')
+        assert.property(result.nftGroup, 'name')
+        assert.property(result.nftGroup, 'symbol')
+        assert.property(result.nftGroup, 'documentUri')
+        assert.property(result.nftGroup, 'versionType')
+        assert.property(result.nftGroup, 'initialTokenQty')
+      })
+    })
+  })
 })
 
 // Promise-based sleep function

test/unit/blockchain.js

@@ -61,16 +61,40 @@ describe('#Blockchain', () => {
 
     it('should get block by hash', done => {
       const resolved = new Promise(resolve => resolve({ data: data }))
-      sandbox.stub(axios, 'get').returns(resolved)
+      sandbox.stub(axios, 'post').returns(resolved)
 
-      bchjs.Blockchain.getBlock(
+      const blockhash =
         '00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09'
-      )
+      bchjs.Blockchain.getBlock(blockhash)
         .then(result => {
           assert.deepStrictEqual(data, result)
         })
         .then(done, done)
     })
+    it('should throw error if blockhash is not provided', async () => {
+      try {
+        await bchjs.Blockchain.getBlock()
+        assert2.fail('Unexpected result')
+      } catch (err) {
+        assert2.include(err.message, 'blockhash must be a string')
+      }
+    })
+    it('should handle response error', async () => {
+      try {
+        const error = new Error()
+        error.response = {
+          data: 'Test Error'
+        }
+        sandbox.stub(axios, 'post').throws(error)
+
+        const blockhash =
+          '00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09'
+        await bchjs.Blockchain.getBlock(blockhash)
+        assert2.fail('Unexpected result')
+      } catch (err) {
+        assert2.include(err, 'Test Error')
+      }
+    })
   })
 
   describe('#getBlockchainInfo', () => {
@@ -355,10 +379,7 @@ describe('#Blockchain', () => {
       try {
         await bchjs.Blockchain.getTxOut('badtxid')
       } catch (err) {
-        assert2.include(
-          err.message,
-          'txid needs to be a proper transaction ID'
-        )
+        assert2.include(err.message, 'txid needs to be a proper transaction ID')
       }
     })
 

test/unit/fixtures/slp/mock-utils.js

@@ -119,6 +119,33 @@ const mockTokens = [
   }
 ]
 
+const mockNftChildrenList = {
+  nftChildren: [
+    '45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a9',
+    '928ce61fe1006b1325a0ba0dce700bf83986a6f0691ba26e121c9ac035d12a55'
+  ]
+}
+
+const mockNftGroup = {
+  nftGroup: {
+    decimals: 0,
+    timestamp: '2021-05-03 10:36:01',
+    timestamp_unix: 1620038161,
+    versionType: 129,
+    documentUri: 'psfoundation.cash',
+    symbol: 'PSF.TEST.GROUP',
+    name: 'PSF Test NFT Group',
+    containsBaton: true,
+    id: '68cd33ecd909068fbea318ae5ff1d6207cf754e53b191327d6d73b6916424c0a',
+    documentHash: null,
+    initialTokenQty: 1000000,
+    blockCreated: 686117,
+    totalMinted: null,
+    totalBurned: null,
+    circulatingSupply: null
+  }
+}
+
 const balancesForAddress = [
   {
     tokenId: 'df808a41672a0a0ae6475b44f272a107bc9961b90f29dc918d71301f24fe92fb',
@@ -1388,6 +1415,8 @@ module.exports = {
   mockList,
   mockToken,
   mockTokens,
+  mockNftChildrenList,
+  mockNftGroup,
   balancesForAddress,
   balancesForAddresses,
   mockRawTx,

test/unit/slp-nft1.js

@@ -4,7 +4,7 @@
 
 const assert = require('chai').assert
 const sinon = require('sinon')
-// const axios = require("axios")
+const axios = require('axios')
 
 // Default to unit tests unless some other value for TEST is passed.
 if (!process.env.TEST) process.env.TEST = 'unit'
@@ -14,7 +14,7 @@ const BCHJS = require('../../src/bch-js')
 const bchjs = new BCHJS()
 
 // Mock data used for unit tests
-// const mockData = require("./fixtures/slp/mock-utils")
+const mockData = require('./fixtures/slp/mock-utils')
 
 // Default to unit tests unless some other value for TEST is passed.
 if (!process.env.TEST) process.env.TEST = 'unit'
@@ -253,4 +253,95 @@ describe('#SLP NFT1', () => {
       assert.isNumber(result.outputs)
     })
   })
+  describe('#listNFTGroupChildren', () => {
+    it('should throw an error for improper input', async () => {
+      try {
+        const groupId = 12345
+
+        await bchjs.SLP.NFT1.listNFTGroupChildren(groupId)
+        assert.equal(true, false, 'Unexpected result!')
+      } catch (err) {
+        // console.log(`err: `, err)
+        assert.include(
+          err.message,
+          'groupId must be a string'
+        )
+      }
+    })
+    it('should handle API response error', async () => {
+      try {
+        const error = new Error()
+        error.response = {
+          error: 'NFT group does not exists'
+        }
+        sandbox.stub(axios, 'get').throws(error)
+
+        const groupId = 'non-exists'
+        await bchjs.SLP.NFT1.listNFTGroupChildren(groupId)
+      } catch (err) {
+        assert.include(
+          err.response,
+          { error: 'NFT group does not exists' }
+        )
+      }
+    })
+    it('should return array of children GENESIS transactions IDs', async () => {
+      sandbox.stub(axios, 'get').resolves({ data: mockData.mockNftChildrenList })
+
+      const groupId = '68cd33ecd909068fbea318ae5ff1d6207cf754e53b191327d6d73b6916424c0a'
+      const result = await bchjs.SLP.NFT1.listNFTGroupChildren(groupId)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.property(result, 'nftChildren')
+      assert.isArray(result.nftChildren)
+    })
+  })
+  describe('#parentNFTGroup', () => {
+    it('should throw an error for improper input', async () => {
+      try {
+        const tokenId = 12345
+
+        await bchjs.SLP.NFT1.parentNFTGroup(tokenId)
+        assert.equal(true, false, 'Unexpected result!')
+      } catch (err) {
+        // console.log(`err: `, err)
+        assert.include(
+          err.message,
+          'tokenId must be a string'
+        )
+      }
+    })
+    it('should handle API response error', async () => {
+      try {
+        const error = new Error()
+        error.response = {
+          error: 'NFT child does not exists'
+        }
+        sandbox.stub(axios, 'get').throws(error)
+
+        const tokenId = 'non-exists'
+        await bchjs.SLP.NFT1.parentNFTGroup(tokenId)
+      } catch (err) {
+        assert.include(
+          err.response,
+          { error: 'NFT child does not exists' }
+        )
+      }
+    })
+    it('should return parent NFT group information', async () => {
+      sandbox.stub(axios, 'get').resolves({ data: mockData.mockNftGroup })
+
+      const tokenId = '45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a9'
+      const result = await bchjs.SLP.NFT1.parentNFTGroup(tokenId)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.property(result, 'nftGroup')
+      assert.property(result.nftGroup, 'id')
+      assert.property(result.nftGroup, 'name')
+      assert.property(result.nftGroup, 'symbol')
+      assert.property(result.nftGroup, 'documentUri')
+      assert.property(result.nftGroup, 'versionType')
+      assert.property(result.nftGroup, 'initialTokenQty')
+    })
+  })
 })