@psf/bch-js 5.3.2 → 6.1.0

package/src/utxo.js

@@ -20,276 +20,6 @@ class UTXO {
     this.BigNumber = BigNumber
   }
 
-  /**
-   * @api Utxo.getOld() getOld()
-   * @apiName getOld
-   * @apiGroup UTXO
-   * @apiDescription Get UTXOs for an address (from SLPDB)
-   *
-   * Given an address, this function will return an object with thre following
-   * properties:
-   * - address: "" - the address these UTXOs are associated with
-   * - bchUtxos: [] - UTXOs confirmed to be spendable as normal BCH
-   * - nullUtxo: [] - UTXOs that did not pass SLP validation. Should be ignored and
-   *   not spent, to be safe.
-   * - slpUtxos: {} - UTXOs confirmed to be colored as valid SLP tokens
-   *   - type1: {}
-   *     - tokens: [] - SLP token Type 1 tokens.
-   *     - mintBatons: [] - SLP token Type 1 mint batons.
-   *   - nft: {}
-   *     - tokens: [] - NFT tokens
-   *     - groupTokens: [] - NFT Group tokens, used to create NFT tokens.
-   *     - groupMintBatons: [] - Minting baton to create more NFT Group tokens.
-   *
-   * Note: You can pass in an optional second Boolean argument. The default
-   * `false` will use the normal waterfall validation method. Set to `true`,
-   * SLP UTXOs will be validated with the whitelist filtered SLPDB. This will
-   * result is many more UTXOs in the `nullUtxos` array.
-   *
-   * @apiExample Example usage:
-   * (async () => {
-   *   try {
-   *     let utxos = await bchjs.Utxo.getOld('simpleledger:qrm0c67wwqh0w7wjxua2gdt2xggnm90xwsr5k22euj');
-   *     console.log(utxos);
-   *   } catch(error) {
-   *    console.error(error)
-   *   }
-   * })()
-   *
-   * // returns
-   * [
-   *  {
-   *   "address": "bitcoincash:qrm0c67wwqh0w7wjxua2gdt2xggnm90xws00a3lezv",
-   *   "bchUtxos": [
-   *    {
-   *      "height": 674513,
-   *      "tx_hash": "705bcc442e5a2770e560b528f52a47b1dcc9ce9ab6a8de9dfdefa55177f00d04",
-   *      "tx_pos": 3,
-   *      "value": 38134,
-   *      "txid": "705bcc442e5a2770e560b528f52a47b1dcc9ce9ab6a8de9dfdefa55177f00d04",
-   *      "vout": 3,
-   *      "isValid": false
-   *    }
-   *   ],
-   *   "nullUtxos": [],
-   *   "slpUtxos": {
-   *    "type1": {
-   *      "mintBatons": [
-   *        {
-   *          "height": 674512,
-   *          "tx_hash": "acbb0d3ceef55aa3e5fafc19335ae4bf2f8edba3c0567547dfd402391db32230",
-   *          "tx_pos": 2,
-   *          "value": 546,
-   *          "txid": "acbb0d3ceef55aa3e5fafc19335ae4bf2f8edba3c0567547dfd402391db32230",
-   *          "vout": 2,
-   *          "utxoType": "minting-baton",
-   *          "tokenId": "acbb0d3ceef55aa3e5fafc19335ae4bf2f8edba3c0567547dfd402391db32230",
-   *          "tokenTicker": "SLPTEST",
-   *          "tokenName": "SLP Test Token",
-   *          "tokenDocumentUrl": "https://FullStack.cash",
-   *          "tokenDocumentHash": "",
-   *          "decimals": 8,
-   *          "tokenType": 1,
-   *          "isValid": true
-   *        }
-   *      ],
-   *      "tokens": [
-   *        {
-   *          "height": 674512,
-   *          "tx_hash": "acbb0d3ceef55aa3e5fafc19335ae4bf2f8edba3c0567547dfd402391db32230",
-   *          "tx_pos": 1,
-   *          "value": 546,
-   *          "txid": "acbb0d3ceef55aa3e5fafc19335ae4bf2f8edba3c0567547dfd402391db32230",
-   *          "vout": 1,
-   *          "utxoType": "token",
-   *          "tokenQty": "100",
-   *          "tokenId": "acbb0d3ceef55aa3e5fafc19335ae4bf2f8edba3c0567547dfd402391db32230",
-   *          "tokenTicker": "SLPTEST",
-   *          "tokenName": "SLP Test Token",
-   *          "tokenDocumentUrl": "https://FullStack.cash",
-   *          "tokenDocumentHash": "",
-   *          "decimals": 8,
-   *          "tokenType": 1,
-   *          "isValid": true
-   *        }
-   *      ]
-   *   },
-   *   "nft": {
-   *      "groupMintBatons": [
-   *        {
-   *          "height": 674513,
-   *          "tx_hash": "705bcc442e5a2770e560b528f52a47b1dcc9ce9ab6a8de9dfdefa55177f00d04",
-   *          "tx_pos": 2,
-   *          "value": 546,
-   *          "txid": "705bcc442e5a2770e560b528f52a47b1dcc9ce9ab6a8de9dfdefa55177f00d04",
-   *          "vout": 2,
-   *          "utxoType": "minting-baton",
-   *          "transactionType": "mint",
-   *          "tokenId": "a9a2458a0f9f0761d5b8725c256f2e7fa35b9de4dec6f47b46e9f20d92d0e395",
-   *          "tokenType": 129,
-   *          "tokenTicker": "NFTGT",
-   *          "tokenName": "NFT Test Group Token",
-   *          "tokenDocumentUrl": "https://FullStack.cash",
-   *          "tokenDocumentHash": "",
-   *          "decimals": 0,
-   *          "mintBatonVout": 2,
-   *          "isValid": true
-   *        }
-   *      ],
-   *      "groupTokens": [
-   *        {
-   *          "height": 674513,
-   *          "tx_hash": "705bcc442e5a2770e560b528f52a47b1dcc9ce9ab6a8de9dfdefa55177f00d04",
-   *          "tx_pos": 1,
-   *          "value": 546,
-   *          "txid": "705bcc442e5a2770e560b528f52a47b1dcc9ce9ab6a8de9dfdefa55177f00d04",
-   *          "vout": 1,
-   *          "utxoType": "token",
-   *          "tokenQty": "10",
-   *          "transactionType": "mint",
-   *          "tokenId": "a9a2458a0f9f0761d5b8725c256f2e7fa35b9de4dec6f47b46e9f20d92d0e395",
-   *          "tokenType": 129,
-   *          "tokenTicker": "NFTGT",
-   *          "tokenName": "NFT Test Group Token",
-   *          "tokenDocumentUrl": "https://FullStack.cash",
-   *          "tokenDocumentHash": "",
-   *          "decimals": 0,
-   *          "mintBatonVout": 2,
-   *          "isValid": true
-   *        }
-   *      ],
-   *      "tokens": [
-   *        {
-   *          "height": 674512,
-   *          "tx_hash": "eeddccc4d716f04157ea132ac93a48040fea34a6b57f3d8f0cccb7d1a731ab2b",
-   *          "tx_pos": 1,
-   *          "value": 546,
-   *          "txid": "eeddccc4d716f04157ea132ac93a48040fea34a6b57f3d8f0cccb7d1a731ab2b",
-   *          "vout": 1,
-   *          "utxoType": "token",
-   *          "tokenQty": "1",
-   *          "tokenId": "eeddccc4d716f04157ea132ac93a48040fea34a6b57f3d8f0cccb7d1a731ab2b",
-   *          "tokenTicker": "NFT004",
-   *          "tokenName": "NFT Child",
-   *          "tokenDocumentUrl": "https://FullStack.cash",
-   *          "tokenDocumentHash": "",
-   *          "decimals": 0,
-   *          "tokenType": 65,
-   *          "isValid": true
-   *        }
-   *      ]
-   *    }
-   *   }
-   *  }
-   * ]
-   *
-   *
-   */
-  async getOld (address, useWhitelist = false) {
-    try {
-      if (!address) {
-        throw new Error('Address must be an array or a string')
-      }
-
-      // Convert address to an array if it is a string.
-      if (typeof address === 'string') address = [address]
-
-      // Throw an error if there are more than 20 addresses passed in at a time.
-      if (address.length > 20) throw new Error('Too many elements, 20 max.')
-
-      // Covert each address to a BCH address.
-      const addr = address.map(elem => this.slp.Address.toCashAddress(elem))
-
-      // Get the UTXOs associated with the address.
-      const utxoData = await this.electrumx.utxo(addr)
-      // console.log(`utxoData: ${JSON.stringify(utxoData, null, 2)}`)
-
-      // Hydate the utxos with token information.
-      let hydratedUtxos
-      if (useWhitelist) {
-        hydratedUtxos = await this.slp.Utils.hydrateUtxosWL(utxoData.utxos)
-      } else {
-        hydratedUtxos = await this.slp.Utils.hydrateUtxos(utxoData.utxos)
-      }
-      // console.log(`hydratedUtxos: ${JSON.stringify(hydratedUtxos, null, 2)}`)
-
-      const retAry = [] // Return array
-
-      // Loop through each address.
-      for (let i = 0; i < hydratedUtxos.slpUtxos.length; i++) {
-        const thisAddr = hydratedUtxos.slpUtxos[i]
-
-        const addrObj = {
-          address: thisAddr.address
-        }
-
-        // Filter out the different types of UTXOs.
-        addrObj.bchUtxos = thisAddr.utxos.filter(elem => elem.isValid === false)
-        addrObj.nullUtxos = thisAddr.utxos.filter(elem => elem.isValid === null)
-
-        // Break down the SLP UTXOs.
-        addrObj.slpUtxos = {
-          type1: {},
-          nft: {}
-        }
-
-        // Token Type 1 Minting Batons.
-        addrObj.slpUtxos.type1.mintBatons = thisAddr.utxos.filter(elem => {
-          const isValid = elem.isValid === true
-          const tokenTypeIs1 = elem.tokenType === 1
-          const isMintingBaton = elem.utxoType === 'minting-baton'
-
-          return isValid && tokenTypeIs1 && isMintingBaton
-        })
-
-        // Token Type 1 tokens.
-        addrObj.slpUtxos.type1.tokens = thisAddr.utxos.filter(elem => {
-          const isValid = elem.isValid === true
-          const tokenTypeIs1 = elem.tokenType === 1
-          const isToken = elem.utxoType === 'token'
-
-          return isValid && tokenTypeIs1 && isToken
-        })
-
-        // NFT Group Minting Batons
-        addrObj.slpUtxos.nft.groupMintBatons = thisAddr.utxos.filter(elem => {
-          const isValid = elem.isValid === true
-          const tokenTypeIs129 = elem.tokenType === 129
-          const isMintingBaton = elem.utxoType === 'minting-baton'
-
-          return isValid && tokenTypeIs129 && isMintingBaton
-        })
-
-        // NFT Group tokens
-        addrObj.slpUtxos.nft.groupTokens = thisAddr.utxos.filter(elem => {
-          const isValid = elem.isValid === true
-          const tokenTypeIs129 = elem.tokenType === 129
-          const isToken = elem.utxoType === 'token'
-
-          return isValid && tokenTypeIs129 && isToken
-        })
-
-        // NFT (Child) tokens
-        addrObj.slpUtxos.nft.tokens = thisAddr.utxos.filter(elem => {
-          const isValid = elem.isValid === true
-          const tokenTypeIs65 = elem.tokenType === 65
-          const isToken = elem.utxoType === 'token'
-
-          return isValid && tokenTypeIs65 && isToken
-        })
-
-        retAry.push(addrObj)
-      }
-
-      return retAry
-    } catch (err) {
-      console.error('Error in bchjs.utxo.get()')
-
-      if (err.error) throw new Error(err.error)
-      throw err
-    }
-  }
-
   /**
    * @api Utxo.get() get()
    * @apiName get

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

@@ -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)
     })
   })
 })