@psf/bch-js 5.3.2 → 6.1.0

package/test/unit/slp-utils.js

@@ -45,216 +45,6 @@ describe('#SLP Utils', () => {
     sandbox.restore()
   })
 
-  describe('#list', () => {
-    it('should list single SLP token by id', async () => {
-      sandbox
-        .stub(uut.Utils.axios, 'get')
-        .resolves({ data: mockData.mockToken })
-
-      const tokenId =
-        '4276533bb702e7f8c9afd8aa61ebf016e95011dc3d54e55faa847ac1dd461e84'
-
-      const list = await uut.Utils.list(tokenId)
-      // console.log(`list: ${JSON.stringify(list, null, 2)}`)
-
-      assert.equal(list.id, tokenId)
-      assert.property(list, 'decimals')
-      assert.property(list, 'symbol')
-      assert.property(list, 'documentUri')
-      assert.property(list, 'name')
-    })
-
-    it('should list multiple SLP tokens by array of ids', async () => {
-      // Mock the call to the REST API
-      sandbox
-        .stub(uut.Utils.axios, 'post')
-        .resolves({ data: mockData.mockList })
-
-      const tokenIds = [
-        '4276533bb702e7f8c9afd8aa61ebf016e95011dc3d54e55faa847ac1dd461e84',
-        '8fc284dcbc922f7bb7e2a443dc3af792f52923bba403fcf67ca028c88e89da0e'
-      ]
-
-      const list = await uut.Utils.list(tokenIds)
-      // console.log(`list: ${JSON.stringify(list, null, 2)}`)
-
-      assert.isArray(list)
-      assert.property(list[0], 'symbol')
-      assert.property(list[1], 'symbol')
-    })
-  })
-
-  describe('#balancesForAddress', () => {
-    it('should throw an error if input is not a string or array of strings', async () => {
-      try {
-        const address = 1234
-
-        await uut.Utils.balancesForAddress(address)
-
-        assert.equal(true, false, 'Uh oh. Code path should not end here.')
-      } catch (err) {
-        // console.log(`Error: `, err)
-        assert.include(
-          err.message,
-          'Input address must be a string or array of strings'
-        )
-      }
-    })
-
-    it('should fetch all balances for address: simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9', async () => {
-      // Mock the call to the REST API
-      if (process.env.TEST === 'unit') {
-        sandbox
-          .stub(uut.Utils.axios, 'get')
-          .resolves({ data: mockData.balancesForAddress })
-      }
-      // sandbox
-      //  .stub(uut.Utils, "balancesForAddress")
-      //  .resolves(mockData.balancesForAddress)
-
-      const balances = await uut.Utils.balancesForAddress(
-        'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9'
-      )
-      // console.log(`balances: ${JSON.stringify(balances, null, 2)}`)
-
-      assert.isArray(balances)
-      assert.hasAllKeys(balances[0], [
-        'tokenId',
-        'balanceString',
-        'balance',
-        'decimalCount',
-        'slpAddress'
-      ])
-    })
-
-    it('should fetch balances for multiple addresses.', async () => {
-      const addresses = [
-        'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9',
-        'simpleledger:qqss4zp80hn6szsa4jg2s9fupe7g5tcg5ucdyl3r57'
-      ]
-
-      // Mock the call to the REST API
-      if (process.env.TEST === 'unit') {
-        sandbox
-          .stub(uut.Utils.axios, 'post')
-          .resolves({ data: mockData.balancesForAddresses })
-      }
-
-      const balances = await uut.Utils.balancesForAddress(addresses)
-      // console.log(`balances: ${JSON.stringify(balances, null, 2)}`)
-
-      assert.isArray(balances)
-      assert.isArray(balances[0])
-      assert.hasAllKeys(balances[0][0], [
-        'tokenId',
-        'balanceString',
-        'balance',
-        'decimalCount',
-        'slpAddress'
-      ])
-    })
-  })
-
-  describe('#validateTxid', () => {
-    it('should validate slp txid', async () => {
-      // Mock the call to the REST API
-      sandbox
-        .stub(uut.Utils.axios, 'post')
-        .resolves({ data: mockData.mockIsValidTxid })
-
-      const isValid = await uut.Utils.validateTxid(
-        'df808a41672a0a0ae6475b44f272a107bc9961b90f29dc918d71301f24fe92fb'
-      )
-      assert.deepEqual(isValid, [
-        {
-          txid:
-            'df808a41672a0a0ae6475b44f272a107bc9961b90f29dc918d71301f24fe92fb',
-          valid: true
-        }
-      ])
-    })
-  })
-
-  describe('#balancesForToken', () => {
-    it('should retrieve token balances for a given tokenId', async () => {
-      // Mock the call to the REST API
-      sandbox
-        .stub(uut.Utils.axios, 'get')
-        .resolves({ data: mockData.mockBalancesForToken })
-
-      const balances = await uut.Utils.balancesForToken(
-        'df808a41672a0a0ae6475b44f272a107bc9961b90f29dc918d71301f24fe92fb'
-      )
-
-      assert.hasAnyKeys(balances[0], ['tokenBalance', 'slpAddress'])
-    })
-  })
-
-  describe('#tokenStats', () => {
-    it('should retrieve stats for a given tokenId', async () => {
-      // Mock the call to the REST API
-      sandbox
-        .stub(uut.Utils.axios, 'get')
-        .resolves({ data: mockData.mockTokenStats })
-
-      const tokenStats = await uut.Utils.tokenStats(
-        'df808a41672a0a0ae6475b44f272a107bc9961b90f29dc918d71301f24fe92fb'
-      )
-
-      assert.hasAnyKeys(tokenStats, [
-        'circulatingSupply',
-        'decimals',
-        'documentUri',
-        'name',
-        'satoshisLockedUp',
-        'symbol',
-        'tokenId',
-        'totalBurned',
-        'totalMinted',
-        'txnsSinceGenesis',
-        'validAddresses',
-        'validUtxos'
-      ])
-    })
-  })
-
-  describe('#transactions', () => {
-    it('should retrieve transactions for a given tokenId and address', async () => {
-      // Mock the call to the REST API
-      sandbox
-        .stub(uut.Utils.axios, 'get')
-        .resolves({ data: mockData.mockTransactions })
-
-      const transactions = await uut.Utils.transactions(
-        '495322b37d6b2eae81f045eda612b95870a0c2b6069c58f70cf8ef4e6a9fd43a',
-        'simpleledger:qrhvcy5xlegs858fjqf8ssl6a4f7wpstaqnt0wauwu'
-      )
-
-      assert.hasAnyKeys(transactions[0], ['txid', 'tokenDetails'])
-    })
-  })
-
-  describe('#burnTotal', () => {
-    it('should retrieve input, output and burn totals', async () => {
-      // Mock the call to the REST API
-      sandbox
-        .stub(uut.Utils.axios, 'get')
-        .resolves({ data: mockData.mockBurnTotal })
-
-      const burnTotal = await uut.Utils.burnTotal(
-        'c7078a6c7400518a513a0bde1f4158cf740d08d3b5bfb19aa7b6657e2f4160de'
-      )
-      // console.log(`burnTotal: ${JSON.stringify(burnTotal, null, 2)}`)
-
-      assert.hasAnyKeys(burnTotal, [
-        'transactionId',
-        'inputTotal',
-        'outputTotal',
-        'burnTotal'
-      ])
-    })
-  })
-
   describe('#decodeOpReturn', () => {
     it('should throw an error for a non-string input', async () => {
       try {
@@ -1910,518 +1700,4 @@ describe('#SLP Utils', () => {
       assert.equal(data[0].isValid, false)
     })
   })
-
-  describe('#tokenUtxoDetailsWL', () => {
-    it('should return details for a simple SEND SLP token utxo', async () => {
-      // Mock the call to REST API
-      // Stub the calls to decodeOpReturn.
-      sandbox
-        .stub(uut.Utils, 'decodeOpReturn')
-        .onCall(0)
-        .resolves({
-          tokenType: 1,
-          txType: 'SEND',
-          tokenId:
-            '497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7',
-          amounts: ['200000000', '99887500000000']
-        })
-        .onCall(1)
-        .resolves({
-          tokenType: 1,
-          txType: 'GENESIS',
-          ticker: 'TOK-CH',
-          name: 'TokyoCash',
-          tokenId:
-            '497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7',
-          documentUri: '',
-          documentHash: '',
-          decimals: 8,
-          mintBatonVout: 0,
-          qty: '2100000000000000'
-        })
-
-      // Stub the call to validateTxid
-      sandbox.stub(uut.Utils, 'validateTxid3').resolves([
-        {
-          txid:
-            'fde117b1f176b231e2fa9a6cb022e0f7c31c288221df6bcb05f8b7d040ca87cb',
-          valid: true
-        }
-      ])
-
-      const utxos = [
-        {
-          txid:
-            'fde117b1f176b231e2fa9a6cb022e0f7c31c288221df6bcb05f8b7d040ca87cb',
-          vout: 1,
-          amount: 0.00000546,
-          satoshis: 546,
-          height: 596089,
-          confirmations: 748
-        }
-      ]
-
-      const data = await uut.Utils.tokenUtxoDetailsWL(utxos)
-      // console.log(`data: ${JSON.stringify(data, null, 2)}`)
-
-      assert.property(data[0], 'txid')
-      assert.property(data[0], 'vout')
-      assert.property(data[0], 'height')
-      assert.property(data[0], 'utxoType')
-      assert.property(data[0], 'tokenId')
-      assert.property(data[0], 'tokenTicker')
-      assert.property(data[0], 'tokenName')
-      assert.property(data[0], 'tokenDocumentUrl')
-      assert.property(data[0], 'tokenDocumentHash')
-      assert.property(data[0], 'decimals')
-      assert.property(data[0], 'tokenQty')
-      assert.property(data[0], 'isValid')
-      assert.equal(data[0].isValid, true)
-    })
-  })
-
-  describe('#txDetails', () => {
-    it('should throw an error if txid is not included', async () => {
-      try {
-        await uut.Utils.txDetails()
-      } catch (err) {
-        assert.include(
-          err.message,
-          'txid string must be included',
-          'Expected error message.'
-        )
-      }
-    })
-
-    it('should throw error for non-existent txid', async () => {
-      try {
-        // Mock the call to the REST API
-        if (process.env.TEST === 'unit') {
-          sandbox
-            .stub(uut.Utils.axios, 'get')
-            // .resolves({ data: mockData.nonSLPTxDetailsWithoutOpReturn })
-            .throws({ error: 'TXID not found' })
-        }
-
-        const txid =
-          'd284e71227ec89f714b964d8eda595be6392bebd2fac46082bc5a9ce6fb7b33e'
-
-        await uut.Utils.txDetails(txid)
-        // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-        assert.fail('Unexpected result')
-      } catch (err) {
-        // console.log(`err: `, err)
-        assert.include(err.error, 'TXID not found', 'Expected error message.')
-      }
-    })
-
-    it('should return details for an SLP txid', async () => {
-      // Mock the call to the REST API
-      if (process.env.TEST === 'unit') {
-        sandbox
-          .stub(uut.Utils.axios, 'get')
-          .resolves({ data: mockData.mockTxDetails })
-      }
-
-      const txid =
-        '9dbaaafc48c49a21beabada8de632009288a2cd52eecefd0c00edcffca9955d0'
-
-      const result = await uut.Utils.txDetails(txid)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.hasAnyKeys(result, [
-        'txid',
-        'version',
-        'locktime',
-        'vin',
-        'vout',
-        'blockhash',
-        'blockheight',
-        'confirmations',
-        'time',
-        'blocktime',
-        'valueOut',
-        'size',
-        'valueIn',
-        'fees',
-        'tokenInfo',
-        'tokenIsValid'
-      ])
-    })
-  })
-
-  describe('#hydrateUtxos', () => {
-    it('should throw an error if input is not an array', async () => {
-      try {
-        const utxos = 1234
-
-        await uut.Utils.hydrateUtxos(utxos)
-
-        assert.equal(true, false, 'Uh oh. Code path should not end here.')
-      } catch (err) {
-        // console.log(`Error: `, err)
-        assert.include(err.message, 'Input must be an array.')
-      }
-    })
-  })
-
-  describe('#hydrateUtxosWL', () => {
-    it('should throw an error if input is not an array', async () => {
-      try {
-        const utxos = 1234
-
-        await uut.Utils.hydrateUtxosWL(utxos)
-
-        assert.equal(true, false, 'Uh oh. Code path should not end here.')
-      } catch (err) {
-        // console.log(`Error: `, err)
-        assert.include(err.message, 'Input must be an array.')
-      }
-    })
-  })
-
-  describe('#validateTxid2', () => {
-    it('should throw an error if the input is an array', async () => {
-      try {
-        const txid = [
-          'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a'
-        ]
-
-        await uut.Utils.validateTxid2(txid)
-
-        assert.equal(true, false, 'Unexpected result')
-      } catch (err) {
-        // console.log("err: ", err)
-        assert.include(err.message, 'txid must be 64 character string')
-      }
-    })
-
-    it('should throw an error for a malformed txid', async () => {
-      try {
-        const txid =
-          'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783'
-
-        await uut.Utils.validateTxid2(txid)
-
-        assert.equal(true, false, 'Unexpected result')
-      } catch (err) {
-        // console.log("err: ", err)
-        assert.include(err.message, 'txid must be 64 character string')
-      }
-    })
-
-    it('should invalidate a known invalid TXID', async () => {
-      const txid =
-        'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a'
-
-      // Mock live network calls.
-      sandbox.stub(uut.Utils.axios, 'get').resolves({
-        data: {
-          txid: txid,
-          isValid: false,
-          msg: ''
-        }
-      })
-
-      const result = await uut.Utils.validateTxid2(txid)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.property(result, 'txid')
-      assert.equal(result.txid, txid)
-
-      assert.property(result, 'isValid')
-      assert.equal(result.isValid, false)
-    })
-
-    it('should validate a known valid TXID', async () => {
-      const txid =
-        '3a4b628cbcc183ab376d44ce5252325f042268307ffa4a53443e92b6d24fb488'
-
-      // Mock live network calls.
-      sandbox.stub(uut.Utils.axios, 'get').resolves({
-        data: {
-          txid: txid,
-          isValid: true,
-          msg: ''
-        }
-      })
-
-      const result = await uut.Utils.validateTxid2(txid)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.property(result, 'txid')
-      assert.equal(result.txid, txid)
-
-      assert.property(result, 'isValid')
-      assert.equal(result.isValid, true)
-    })
-
-    // slp-validate can take a long time. bch-api cuts it off if it fails to
-    // return is less than 10 seconds. This test case handle this situation.
-    it('should handle timeout errors', async () => {
-      try {
-        const txid =
-          'eacb1085dfa296fef6d4ae2c0f4529a1bef096dd2325bdcc6dcb5241b3bdb579'
-
-        // Mock live network calls.
-        sandbox.stub(uut.Utils.axios, 'get').rejects({
-          error:
-            'Network error: Could not communicate with full node or other external service.'
-        })
-
-        await uut.Utils.validateTxid2(txid)
-
-        assert.equal(true, false, 'Unexpected result')
-      } catch (err) {
-        // console.log("err: ", err)
-        assert.include(err.message, 'slp-validate timed out')
-      }
-    })
-  })
-
-  describe('#validateTxid', () => {
-    it('should invalidate a known invalid TXID', async () => {
-      const txid =
-        'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a'
-
-      // Mock live network calls.
-      sandbox.stub(uut.Utils.axios, 'post').resolves({
-        data: mockData.mockValidateTxid3Invalid
-      })
-
-      const result = await uut.Utils.validateTxid(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 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"
-      ]
-
-      const result = await uut.Utils.validateTxid(txids)
-      console.log(`result: ${JSON.stringify(result, null, 2)}`)
-    })
-*/
-  })
-
-  describe('#waterfallValidateTxid', () => {
-    // This test ensures that the whitelist SLPDB is called before the
-    // general purpose SLPDB.
-    it('should call validateTxid3() first', async () => {
-      const txid = 'fakeTxid'
-
-      const retVal = [{ txid, valid: true }]
-
-      // Use stubs to force the desired code path.
-      sandbox.stub(uut.Utils, 'validateTxid3').resolves(retVal)
-      sandbox
-        .stub(uut.Utils, 'validateTxid')
-        .rejects(new Error('Unexpected code path'))
-      sandbox
-        .stub(uut.Utils, 'validateTxid2')
-        .rejects(new Error('Unexpected code path'))
-
-      const result = await uut.Utils.waterfallValidateTxid(txid)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.equal(result, true)
-    })
-
-    // This test ensures that the general purpose SLPDB is called after the
-    // whitelist SLPDB, but before slp-api.
-    it('should call validateTxid() second', async () => {
-      const txid = 'fakeTxid'
-
-      const retVal1 = [{ txid, valid: null }]
-      const retVal2 = [{ txid, valid: true }]
-
-      // Use stubs to force the desired code path.
-      sandbox.stub(uut.Utils, 'validateTxid3').resolves(retVal1)
-      sandbox.stub(uut.Utils, 'validateTxid').resolves(retVal2)
-      sandbox
-        .stub(uut.Utils, 'validateTxid2')
-        .rejects(new Error('Unexpected code path'))
-
-      const result = await uut.Utils.waterfallValidateTxid(txid)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.equal(result, true)
-    })
-
-    // This test ensures that slp-api is called if both SLPDBs return null.
-    it('should call slp-api last', async () => {
-      const txid = 'fakeTxid'
-
-      const retVal1 = [{ txid, valid: null }]
-
-      // Use stubs to force the desired code path.
-      sandbox.stub(uut.Utils, 'validateTxid3').resolves(retVal1)
-      sandbox.stub(uut.Utils, 'validateTxid').resolves(retVal1)
-      sandbox.stub(uut.Utils, 'validateTxid2').resolves({ isValid: true })
-
-      const result = await uut.Utils.waterfallValidateTxid(txid)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.equal(result, true)
-    })
-
-    // CT 08-09-21 Changed behavior. validateTxid3() is now wrapped in a
-    // try/catch statement that exits quietly if there is an error.
-    // it('catches and throws an error', async () => {
-    //   try {
-    //     const txid = 'fakeTxid'
-    //
-    //     // Force an error
-    //     sandbox
-    //       .stub(uut.Utils, 'validateTxid3')
-    //       .rejects(new Error('fake error'))
-    //
-    //     await await uut.Utils.waterfallValidateTxid(txid)
-    //
-    //     assert.fail('Unexpected result')
-    //   } catch (err) {
-    //     // console.log(`err.message: ${err.message}`)
-    //     assert.include(err.message, 'fake error')
-    //   }
-    // })
-  })
-
-  describe('#getWhitelist', () => {
-    it('should return the list', async () => {
-      sandbox
-        .stub(uut.Utils.axios, 'get')
-        .resolves({ data: mockData.mockWhitelist })
-
-      const result = await uut.Utils.getWhitelist()
-
-      assert.isArray(result)
-      assert.property(result[0], 'name')
-      assert.property(result[1], 'tokenId')
-    })
-
-    it('catches and throws an error', async () => {
-      try {
-        sandbox.stub(uut.Utils.axios, 'get').rejects({
-          error:
-            'Network error: Could not communicate with full node or other external service.'
-        })
-
-        await uut.Utils.getWhitelist()
-
-        assert.fail('Unexpected result')
-      } catch (err) {
-        console.log('err: ', err)
-        assert.include(err.error, 'Network error')
-      }
-    })
-  })
-
-  describe('#validateTxid3', () => {
-    it('should invalidate a known invalid TXID', async () => {
-      const txid =
-        'f7e5199ef6669ad4d078093b3ad56e355b6ab84567e59ad0f08a5ad0244f783a'
-
-      // Mock live network calls.
-      sandbox.stub(uut.Utils.axios, 'post').resolves({
-        data: mockData.mockValidateTxid3Invalid
-      })
-
-      const result = await uut.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 handle an array with a single element', async () => {
-      sandbox
-        .stub(uut.Utils.axios, 'post')
-        .resolves({ data: mockData.mockValidateTxid3Valid })
-
-      const txid = [
-        'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd'
-      ]
-
-      const result = await uut.Utils.validateTxid3(txid)
-
-      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 an single string input', async () => {
-      sandbox
-        .stub(uut.Utils.axios, 'post')
-        .resolves({ data: mockData.mockValidateTxid3Valid })
-
-      const txid =
-        'daf4d8b8045e7a90b7af81bfe2370178f687da0e545511bce1c9ae539eba5ffd'
-
-      const result = await uut.Utils.validateTxid3(txid)
-
-      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('catches and throws an error', async () => {
-      try {
-        sandbox.stub(uut.Utils.axios, 'post').rejects({
-          error:
-            'Network error: Could not communicate with full node or other external service.'
-        })
-
-        await uut.Utils.validateTxid3()
-
-        assert.equal(true, false, 'Unexpected result')
-      } catch (err) {
-        // console.log("err: ", err)
-        assert.include(err.error, 'Network error')
-      }
-    })
-  })
-
-  describe('#getStatus', () => {
-    it('should return the current block height of the SLPDB indexer', async () => {
-      sandbox
-        .stub(uut.Utils.axios, 'get')
-        .resolves({ data: mockData.slpdbStatus })
-
-      const result = await uut.Utils.getStatus()
-
-      // console.log(`result: `, result)
-
-      assert.property(result, 'bchBlockHeight')
-      assert.property(result, 'slpProcessedBlockHeight')
-    })
-  })
 })