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

fix(getTokenData): Adding ability to retrieve tx history

package.json

@@ -12,7 +12,7 @@
     "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/v5/ && 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/v5/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/abc/",
+    "test:integration:abc": "export RESTURL=https://abc.fullstack.cash/v5/ && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/abc/",
     "test:integration:bchn": "export RESTURL=https://bchn.fullstack.cash/v5/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/bchn/",
     "test:integration:bchn:slpdb": "export TESTSLP=1 && export RESTURL=https://bchn.fullstack.cash/v5/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/bchn/",
     "test:integration:local:abc": "export RESTURL=http://localhost:3000/v5/ && mocha --timeout 30000 test/integration && mocha --timeout 30000 test/integration/chains/abc/",

src/address.js

@@ -133,7 +133,7 @@ class Address {
    * @api Address.toEcashAddress() toEcashAddress()
    * @apiName toEcashAddress
    * @apiGroup Address
-   * @apiDescription Convert legacy to cashAddress format
+   * @apiDescription Convert legacy to eCash (XEC) format
    *
    * @apiExample Example usage:
    * // mainnet
@@ -158,6 +158,35 @@ class Address {
     return ecashAddress.split(':')[1]
   }
 
+  /**
+   * @api Address.toEtokenAddress() toEtokenAddress()
+   * @apiName toEtokenAddress
+   * @apiGroup Address
+   * @apiDescription Convert legacy to eToken (XEC) format
+   *
+   * @apiExample Example usage:
+   * // mainnet
+   * bchjs.Address.toEtokenAddress('bitcoincash:qq50d800hgunr8u4trz3uuppspk3mds0dy9978plt2')
+   * // etoken:qq50d800hgunr8u4trz3uuppspk3mds0dyug2v69da
+   *
+   * // mainnet no prefix
+   * bchjs.Address.toEtokenAddress('bitcoincash:qq50d800hgunr8u4trz3uuppspk3mds0dy9978plt2', false)
+   * // qq50d800hgunr8u4trz3uuppspk3mds0dyug2v69da
+   *
+   */
+  toEtokenAddress (address, prefix = true) {
+    const decoded = this._decode(address)
+
+    const etokenAddress = cashaddr.encode(
+      'etoken',
+      decoded.type,
+      decoded.hash
+    )
+
+    if (prefix) return etokenAddress
+    return etokenAddress.split(':')[1]
+  }
+
   /**
    * @api Address.ecashtoCashAddress() ecashtoCashAddress()
    * @apiName ecashtoCashAddress

src/electrumx.js

@@ -7,6 +7,7 @@ const axios = require('axios')
 
 // Local libraries.
 const Blockchain = require('./blockchain')
+// const Address = require('./address')
 
 // let _this
 
@@ -32,7 +33,9 @@ class ElectrumX {
       }
     }
 
+    // Encapsulate dependencies
     this.blockchain = new Blockchain(config)
+    // this.address = new Address(config)
 
     // _this = this
   }
@@ -104,6 +107,8 @@ class ElectrumX {
    */
   async utxo (address) {
     try {
+      // console.log(`electrumx.js/utxo() restURL: ${this.restURL}`)
+
       // Handle single address.
       if (typeof address === 'string') {
         const response = await axios.get(

src/psf-slp-indexer.js

@@ -194,6 +194,7 @@ class PsfSlpIndexer {
    *   }
    * }
    *
+   *
    */
 
   async tokenStats (tokenId, withTxHistory = false) {
@@ -420,7 +421,7 @@ class PsfSlpIndexer {
    * }
    *
    */
-  async getTokenData (tokenId) {
+  async getTokenData (tokenId, withTxHistory = false) {
     try {
       const url = `${this.restURL}psf/slp/token/data`
       // console.log(`url: ${url}`)
@@ -430,7 +431,7 @@ class PsfSlpIndexer {
         const response = await axios.post(
           // 'https://bchn.fullstack.cash/v5/psf/slp/token/data/',
           url,
-          { tokenId },
+          { tokenId, withTxHistory },
           this.axiosOptions
         )
         return response.data

src/utxo.js

@@ -82,7 +82,10 @@ class UTXO {
       }
 
       // Ensure the address is a BCH address.
-      const addr = this.slp.Address.toCashAddress(address)
+      let addr = address
+      if (!addr.includes('ecash')) {
+        addr = this.slp.Address.toCashAddress(address)
+      }
 
       // Get the UTXOs associated with the address.
       const utxoData = await this.electrumx.utxo(addr)
@@ -209,7 +212,7 @@ class UTXO {
 
       return outObj
     } catch (err) {
-      console.error('Error in bchjs.Utxo.get()')
+      console.error('Error in bchjs.Utxo.get(): ', err)
 
       if (err.error) throw new Error(err.error)
       throw err

test/integration/chains/abc/psf-slp-indexer-integration.js

@@ -0,0 +1,38 @@
+/*
+  Integration tests for the psf-slp-indexer.js library, specific to the eCash
+  blockchain.
+*/
+
+// Global npm libraries
+const assert = require('chai').assert
+
+// Local libraries
+const BCHJS = require('../../../../src/bch-js')
+let bchjs
+
+describe('#psf-slp-indexer', () => {
+  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('#balance', () => {
+    it('should get token balance for an ecash address', async () => {
+      const addr = 'ecash:qr5c4hfy52zn87484cucvzle5pljz0gtr5vhtw9z09'
+
+      const result = await bchjs.PsfSlpIndexer.balance(addr)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.property(result.balance, 'utxos')
+      assert.property(result.balance, 'txs')
+      assert.property(result.balance, 'balances')
+    })
+  })
+})
+
+// Promise-based sleep function
+function sleep (ms) {
+  return new Promise(resolve => setTimeout(resolve, ms))
+}

test/integration/chains/abc/utxo-integration.js

@@ -2,10 +2,10 @@
   Integration tests for the utxo.js library.
 */
 
-// const assert = require('chai').assert
+const assert = require('chai').assert
 
-// const BCHJS = require('../../../../src/bch-js')
-// const bchjs = new BCHJS()
+const BCHJS = require('../../../../src/bch-js')
+const bchjs = new BCHJS()
 
 describe('#UTXO', () => {
   beforeEach(async () => {
@@ -14,25 +14,23 @@ describe('#UTXO', () => {
     if (process.env.IS_USING_FREE_TIER) await sleep(1500)
   })
 
-  /*
   describe('#get', () => {
     it('should get hydrated and filtered UTXOs for an address', async () => {
-      // const addr = 'bitcoincash:qqh793x9au6ehvh7r2zflzguanlme760wuzehgzjh9'
-      const addr = 'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9'
+      const addr = 'ecash:qr5c4hfy52zn87484cucvzle5pljz0gtr5vhtw9z09'
+      // 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)
+      // assert.isArray(result)
+      assert.property(result, 'address')
+      assert.property(result, 'bchUtxos')
+      assert.property(result, 'nullUtxos')
+      assert.property(result, 'slpUtxos')
+      assert.isArray(result.bchUtxos)
+      assert.isArray(result.nullUtxos)
     })
   })
-  */
 })
 
 function sleep (ms) {

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

@@ -1,9 +1,12 @@
 /*
-  Integration tests for the psf-slp-indexer.js library
+  Integration tests for the psf-slp-indexer.js library, specific to the BCH
+  blockchain.
 */
 
+// Global npm libraries
 const assert = require('chai').assert
 
+// Local libraries
 const BCHJS = require('../../../../src/bch-js')
 let bchjs
 
@@ -142,6 +145,15 @@ describe('#psf-slp-indexer', () => {
       assert.isString(result.immutableData)
       assert.isString(result.mutableData)
     })
+
+    it('should get token data with a transaction history', async () => {
+      const tokenId = '43eddfb11c9941edffb8c8815574bb0a43969a7b1de39ad14cd043eaa24fd38d'
+
+      const result = await bchjs.PsfSlpIndexer.getTokenData(tokenId, true)
+      // console.log('result: ', result)
+
+      assert.isArray(result.genesisData.txs)
+    })
   })
 })
 

test/unit/address.js

@@ -935,4 +935,44 @@ describe('#address.js', () => {
       })
     })
   })
+
+  describe('#toEcashAddress', () => {
+    it('should convert a BCH address to an eCash address', () => {
+      const cashAddr = 'bitcoincash:qr24z7q6s26d9wr078lr2pxsmxg22cyn9s7yw984vk'
+
+      const result = bchjs.Address.toEcashAddress(cashAddr)
+      // console.log('result: ', result)
+
+      assert.equal(result, 'ecash:qr24z7q6s26d9wr078lr2pxsmxg22cyn9s8f6wu02p')
+    })
+
+    it('should convert a BCH address to an eCash address without a prefix', () => {
+      const cashAddr = 'bitcoincash:qr24z7q6s26d9wr078lr2pxsmxg22cyn9s7yw984vk'
+
+      const result = bchjs.Address.toEcashAddress(cashAddr, false)
+      // console.log('result: ', result)
+
+      assert.equal(result, 'qr24z7q6s26d9wr078lr2pxsmxg22cyn9s8f6wu02p')
+    })
+  })
+
+  describe('#toEtokenAddress', () => {
+    it('should convert a BCH address to an eToken address', () => {
+      const cashAddr = 'bitcoincash:qr24z7q6s26d9wr078lr2pxsmxg22cyn9s7yw984vk'
+
+      const result = bchjs.Address.toEtokenAddress(cashAddr)
+      // console.log('result: ', result)
+
+      assert.equal(result, 'etoken:qr24z7q6s26d9wr078lr2pxsmxg22cyn9sfhnv2gwk')
+    })
+
+    it('should convert a BCH address to an eToken address without a prefix', () => {
+      const cashAddr = 'bitcoincash:qr24z7q6s26d9wr078lr2pxsmxg22cyn9s7yw984vk'
+
+      const result = bchjs.Address.toEtokenAddress(cashAddr, false)
+      // console.log('result: ', result)
+
+      assert.equal(result, 'qr24z7q6s26d9wr078lr2pxsmxg22cyn9sfhnv2gwk')
+    })
+  })
 })