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

fix(Transaction.get()): Adding support for MINT corner-case

package.json

@@ -54,7 +54,7 @@
     "bip66": "^1.1.5",
     "bitcoinjs-message": "^2.0.0",
     "bs58": "^4.0.1",
-    "cashaddrjs": "^0.3.3",
+    "ecashaddrjs": "^1.0.7",
     "ini": "^1.3.8",
     "randombytes": "^2.0.6",
     "safe-buffer": "^5.1.2",
@@ -76,9 +76,9 @@
     "eslint-plugin-standard": "^4.0.0",
     "husky": "^4.3.6",
     "lodash.clonedeep": "^4.5.0",
-    "mocha": "^6.1.4",
+    "mocha": "^9.1.3",
     "node-mocks-http": "^1.7.0",
-    "nyc": "^14.1.0",
+    "nyc": "^15.1.0",
     "prettier": "^1.18.2",
     "semantic-release": "^17.3.9",
     "sinon": "^7.3.2",

src/address.js

@@ -1,6 +1,6 @@
 // const axios = require("axios")
 const Bitcoin = require('@psf/bitcoincashjs-lib')
-const cashaddr = require('cashaddrjs')
+const cashaddr = require('ecashaddrjs')
 const coininfo = require('@psf/coininfo')
 
 class Address {
@@ -129,6 +129,63 @@ class Address {
     return cashAddress.split(':')[1]
   }
 
+  /**
+   * @api Address.toEcashAddress() toEcashAddress()
+   * @apiName toEcashAddress
+   * @apiGroup Address
+   * @apiDescription Convert legacy to cashAddress format
+   *
+   * @apiExample Example usage:
+   * // mainnet
+   * bchjs.Address.toEcashAddress('bitcoincash:qq50d800hgunr8u4trz3uuppspk3mds0dy9978plt2')
+   * // ecash:qq50d800hgunr8u4trz3uuppspk3mds0dyug2v69da
+   *
+   * // mainnet no prefix
+   * bchjs.Address.toEcashAddress('bitcoincash:qq50d800hgunr8u4trz3uuppspk3mds0dy9978plt2', false)
+   * // qq50d800hgunr8u4trz3uuppspk3mds0dyug2v69da
+   *
+   */
+  toEcashAddress (address, prefix = true) {
+    const decoded = this._decode(address)
+
+    const ecashAddress = cashaddr.encode(
+      'ecash',
+      decoded.type,
+      decoded.hash
+    )
+
+    if (prefix) return ecashAddress
+    return ecashAddress.split(':')[1]
+  }
+
+  /**
+   * @api Address.ecashtoCashAddress() ecashtoCashAddress()
+   * @apiName ecashtoCashAddress
+   * @apiGroup Address
+   * @apiDescription Convert legacy to cashAddress format
+   *
+   * @apiExample Example usage:
+   * // mainnet
+   * bchjs.Address.ecashtoCashAddress('ecash:qq50d800hgunr8u4trz3uuppspk3mds0dyug2v69da')
+   * // bitcoincash:qq50d800hgunr8u4trz3uuppspk3mds0dy9978plt2
+   *
+   * // mainnet no prefix
+   * bchjs.Address.ecashtoCashAddress('ecash:qq50d800hgunr8u4trz3uuppspk3mds0dyug2v69da', false)
+   * // qq50d800hgunr8u4trz3uuppspk3mds0dy9978plt2
+   */
+  ecashtoCashAddress (address, prefix = true) {
+    const decoded = this._decodeEcashAddress(address)
+
+    const cashAddress = cashaddr.encode(
+      'bitcoincash',
+      decoded.type,
+      decoded.hash
+    )
+
+    if (prefix) return cashAddress
+    return cashAddress.split(':')[1]
+  }
+
   // Converts any address format to hash160
   toHash160 (address) {
     const legacyAddress = this.toLegacyAddress(address)
@@ -271,6 +328,22 @@ class Address {
     throw new Error(`Invalid format : ${address}`)
   }
 
+  _decodeEcashAddress (address) {
+    if (address.indexOf(':') !== -1) {
+      const decoded = cashaddr.decode(address)
+      decoded.format = 'cashaddr'
+      return decoded
+    }
+
+    try {
+      const decoded = cashaddr.decode(`ecash:${address}`)
+      decoded.format = 'cashaddr'
+      return decoded
+    } catch (error) {}
+
+    throw new Error(`Invalid format : ${address}`)
+  }
+
   /**
    * @api Address.isLegacyAddress() isLegacyAddress()
    * @apiName isLegacyAddress

src/price.js

@@ -128,7 +128,7 @@ class Price {
    * @apiGroup Price
    * @apiDescription Return current price of BCHA in USD.
    * This endpoint gets the USD price of XEC from the Coinex API. The price
-   * denominated in BCHA comes from bch-api, so it has a better chance of 
+   * denominated in BCHA comes from bch-api, so it has a better chance of
    * working in Tor.
    *
    * @apiExample Example usage:
@@ -150,7 +150,7 @@ class Price {
         this.axiosOptions
       )
       // console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
-      
+
       const bchaPrice = response.data.usd * 1000000
       // Convert XEC denomination to BCHA denomination
 
@@ -161,7 +161,7 @@ class Price {
     }
   }
 
-    /**
+  /**
    * @api price.getXecUsd() getXecUsd()
    * @apiName Price getXecUsd()
    * @apiGroup Price
@@ -179,9 +179,9 @@ class Price {
    *  }
    *})()
    *
-   * // 0.00021234 
+   * // 0.00021234
    */
-   async getXecUsd () {
+  async getXecUsd () {
     try {
       const response = await this.axios.get(
         `${this.restURL}price/bchausd`,

src/slp/tokentype1.js

@@ -287,9 +287,15 @@ class TokenType1 {
     try {
       // TODO: Add input validation.
 
-      let baseQty = new BigNumber(configObj.initialQty).times(
-        10 ** configObj.decimals
-      )
+      let baseQty
+      if (configObj.decimals !== 0) {
+        baseQty = new BigNumber(configObj.initialQty).times(
+          10 ** configObj.decimals
+        )
+      } else {
+        baseQty = new BigNumber(configObj.initialQty)
+      }
+
       baseQty = baseQty.absoluteValue()
       baseQty = Math.floor(baseQty)
       baseQty = baseQty.toString()

src/transaction.js

@@ -127,11 +127,14 @@ class Transaction {
                 tokenQty = inTokenData.qty
                 // console.log(`tokenQty: ${JSON.stringify(tokenQty, null, 2)}`)
               }
+            } else if (inTokenData.txType === 'MINT') {
+              // vout=1 (second output) recieves the newly minted tokens.
+              tokenQty = inTokenData.qty
 
               //
             } else {
               console.log(
-                'Unexpected code path in Transaction.get(). Is this a MINT transaction?'
+                'Unexpected code path in Transaction.get(). What is the txType?'
               )
               console.log(inTokenData)
               throw new Error('Unexpected code path')

test/unit/fixtures/transaction-mock.js

@@ -266,14 +266,117 @@ const genesisTestInputTx = {
   blocktime: 1534271330
 }
 
-genesisTestOpReturnData01 = {
+const mintTestInputTx = {
+  txid: '4640a734063ea79fa587a3cac38a70a2f6f3db0011e23514024185982110d0fa',
+  hash: '4640a734063ea79fa587a3cac38a70a2f6f3db0011e23514024185982110d0fa',
+  version: 1,
+  size: 585,
+  locktime: 543613,
+  vin: [
+    {
+      txid: '938cc18e618967d787897bbc64b9a8d201b94ec7c69b1a9949eab0433ba5cdf8',
+      vout: 1,
+      scriptSig: {
+        asm: '3045022100e3d5f9a48f9aa1cf7e9ed1992e0281e7300b734ba0e4bd5bb9265b2be60bd71002200ccde53ce7ea9da9df3e834f234f3bea65c2e58c96f8436f93333fd8946a1db2[ALL|FORKID] 02056220984cc2cf5261a27d4f66d31c9ef601a688ca1a5ab81e55b6f0d311be74',
+        hex: '483045022100e3d5f9a48f9aa1cf7e9ed1992e0281e7300b734ba0e4bd5bb9265b2be60bd71002200ccde53ce7ea9da9df3e834f234f3bea65c2e58c96f8436f93333fd8946a1db2412102056220984cc2cf5261a27d4f66d31c9ef601a688ca1a5ab81e55b6f0d311be74'
+      },
+      sequence: 4294967294,
+      address: 'bitcoincash:qpaf9wltgmpjlg2vxwwu7zdw5y4z7m277ckxn8cufl',
+      value: 0.00000546,
+      tokenQtyStr: '43545.34534',
+      tokenQty: 43545.34534
+    },
+    {
+      txid: 'ee9d3cf5153599c134147e3fac9844c68e216843f4452a1ce15a29452af6db34',
+      vout: 1,
+      scriptSig: {
+        asm: '3045022100bb90d52be9b568f643fdb1a302e9f063be27a9f914e2a6b192cbabf2cbdeaf9302203c275fc8d1b82390bc1726390d361c5266056bddd54dec23efa207c79eacea4a[ALL|FORKID] 024146cfcd0c02e99d6451dc48ad0f97114aeda18fe55c52a10bfc0490f314e6a2',
+        hex: '483045022100bb90d52be9b568f643fdb1a302e9f063be27a9f914e2a6b192cbabf2cbdeaf9302203c275fc8d1b82390bc1726390d361c5266056bddd54dec23efa207c79eacea4a4121024146cfcd0c02e99d6451dc48ad0f97114aeda18fe55c52a10bfc0490f314e6a2'
+      },
+      sequence: 4294967294,
+      address: 'bitcoincash:qqf89zzwd0fqc3npkks997r5l7dpfjf9kgx2rqu500',
+      value: 0.00000546,
+      tokenQtyStr: '2.34123',
+      tokenQty: 2.34123
+    },
+    {
+      txid: 'ee9d3cf5153599c134147e3fac9844c68e216843f4452a1ce15a29452af6db34',
+      vout: 3,
+      scriptSig: {
+        asm: '3044022029ab770c249f467b40bb90410429f6d657f9be299baa19a6838d04d972436b450220143660297e8e836bc16d317649fad8c310bdadb4fb61d4e9f6ba11203abe5dae[ALL|FORKID] 02eed4ac9dda3405d9b1ccbbf09f8056f3e7c615924274bd5643238b543d0a1d56',
+        hex: '473044022029ab770c249f467b40bb90410429f6d657f9be299baa19a6838d04d972436b450220143660297e8e836bc16d317649fad8c310bdadb4fb61d4e9f6ba11203abe5dae412102eed4ac9dda3405d9b1ccbbf09f8056f3e7c615924274bd5643238b543d0a1d56'
+      },
+      sequence: 4294967294,
+      address: 'bitcoincash:qqt30r33k0jx3sxe34tmupaujpaljnglmvqgrrfp2x',
+      value: 0.00054848,
+      tokenQtyStr: '2.34123',
+      tokenQty: 2.34123
+    }
+  ],
+  vout: [
+    {
+      value: 0,
+      n: 0,
+      scriptPubKey: {
+        asm: 'OP_RETURN 5262419 1 1145980243 938cc18e618967d787897bbc64b9a8d201b94ec7c69b1a9949eab0433ba5cdf8 0000000103907f11',
+        hex: '6a04534c500001010453454e4420938cc18e618967d787897bbc64b9a8d201b94ec7c69b1a9949eab0433ba5cdf8080000000103907f11',
+        type: 'nulldata'
+      },
+      tokenQty: null
+    },
+    {
+      value: 0.00000546,
+      n: 1,
+      scriptPubKey: {
+        asm: 'OP_DUP OP_HASH160 059775ff94f65c04e8a6847e74eb9809d8cd779b OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a914059775ff94f65c04e8a6847e74eb9809d8cd779b88ac',
+        reqSigs: 1,
+        type: 'pubkeyhash',
+        addresses: [
+          'bitcoincash:qqzewa0ljnm9cp8g56z8ua8tnqya3nthnvhv5hpu8y'
+        ]
+      },
+      tokenQtyStr: '43547.68657',
+      tokenQty: 43547.68657
+    },
+    {
+      value: 0.00054808,
+      n: 2,
+      scriptPubKey: {
+        asm: 'OP_DUP OP_HASH160 0e330dc9009e1e07831f5a22d4ade8977ab674c8 OP_EQUALVERIFY OP_CHECKSIG',
+        hex: '76a9140e330dc9009e1e07831f5a22d4ade8977ab674c888ac',
+        reqSigs: 1,
+        type: 'pubkeyhash',
+        addresses: [
+          'bitcoincash:qq8rxrwfqz0pupurradz949dazth4dn5eqs3mhrucv'
+        ]
+      },
+      tokenQty: null
+    }
+  ],
+  hex: '0100000003f8cda53b43b0ea49991a9bc6c74eb901d2a8b964bc7b8987d76789618ec18c93010000006b483045022100e3d5f9a48f9aa1cf7e9ed1992e0281e7300b734ba0e4bd5bb9265b2be60bd71002200ccde53ce7ea9da9df3e834f234f3bea65c2e58c96f8436f93333fd8946a1db2412102056220984cc2cf5261a27d4f66d31c9ef601a688ca1a5ab81e55b6f0d311be74feffffff34dbf62a45295ae11c2a45f44368218ec64498ac3f7e1434c1993515f53c9dee010000006b483045022100bb90d52be9b568f643fdb1a302e9f063be27a9f914e2a6b192cbabf2cbdeaf9302203c275fc8d1b82390bc1726390d361c5266056bddd54dec23efa207c79eacea4a4121024146cfcd0c02e99d6451dc48ad0f97114aeda18fe55c52a10bfc0490f314e6a2feffffff34dbf62a45295ae11c2a45f44368218ec64498ac3f7e1434c1993515f53c9dee030000006a473044022029ab770c249f467b40bb90410429f6d657f9be299baa19a6838d04d972436b450220143660297e8e836bc16d317649fad8c310bdadb4fb61d4e9f6ba11203abe5dae412102eed4ac9dda3405d9b1ccbbf09f8056f3e7c615924274bd5643238b543d0a1d56feffffff030000000000000000376a04534c500001010453454e4420938cc18e618967d787897bbc64b9a8d201b94ec7c69b1a9949eab0433ba5cdf8080000000103907f1122020000000000001976a914059775ff94f65c04e8a6847e74eb9809d8cd779b88ac18d60000000000001976a9140e330dc9009e1e07831f5a22d4ade8977ab674c888ac7d4b0800',
+  blockhash: '00000000000000000140f0d813052da59c811a936494a8d8b2d60b215d19e3dc',
+  confirmations: 167007,
+  time: 1534391953,
+  blocktime: 1534391953,
+  isValidSLPTx: true,
+  tokenTxType: 'SEND',
+  tokenId: '938cc18e618967d787897bbc64b9a8d201b94ec7c69b1a9949eab0433ba5cdf8',
+  tokenTicker: 'Bubb2',
+  tokenName: 'the new bubbles!',
+  tokenDecimals: 5,
+  tokenUri: '',
+  tokenDocHash: ''
+}
+
+const genesisTestOpReturnData01 = {
   tokenType: 1,
   txType: 'SEND',
   tokenId: '323a1e35ae0b356316093d20f2d9fbc995d19314b5c0148b78dc8d9c0dab9d35',
   amounts: ['5000000', '5000000']
 }
 
-genesisTestOpReturnData02 = {
+const genesisTestOpReturnData02 = {
   tokenType: 1,
   txType: 'GENESIS',
   ticker: '',
@@ -286,6 +389,36 @@ genesisTestOpReturnData02 = {
   qty: '10000000'
 }
 
+const mintTestOpReturnData01 = {
+  tokenType: 1,
+  txType: 'SEND',
+  tokenId: '938cc18e618967d787897bbc64b9a8d201b94ec7c69b1a9949eab0433ba5cdf8',
+  amounts: [
+    '4354768657'
+  ]
+}
+
+const mintTestOpReturnData02 = {
+  tokenType: 1,
+  txType: 'GENESIS',
+  ticker: 'Bubb2',
+  name: 'the new bubbles!',
+  tokenId: '938cc18e618967d787897bbc64b9a8d201b94ec7c69b1a9949eab0433ba5cdf8',
+  documentUri: '',
+  documentHash: '',
+  decimals: 5,
+  mintBatonVout: 2,
+  qty: '4354534534'
+}
+
+const mintTestOpReturnData03 = {
+  tokenType: 1,
+  txType: 'MINT',
+  tokenId: '938cc18e618967d787897bbc64b9a8d201b94ec7c69b1a9949eab0433ba5cdf8',
+  mintBatonVout: 2,
+  qty: '234123'
+}
+
 module.exports = {
   nonSlpTxDetails,
   slpTxDetails,
@@ -293,6 +426,10 @@ module.exports = {
   mockOpReturnData02,
   mockOpReturnData03,
   genesisTestInputTx,
+  mintTestInputTx,
   genesisTestOpReturnData01,
-  genesisTestOpReturnData02
+  genesisTestOpReturnData02,
+  mintTestOpReturnData01,
+  mintTestOpReturnData02,
+  mintTestOpReturnData03
 }

test/unit/transaction-unit.js

@@ -164,5 +164,52 @@ describe('#TransactionLib', () => {
       assert.equal(result.vin[0].tokenQty, 10000000)
       assert.equal(result.vin[1].tokenQty, null)
     })
+
+    it('should get input details when input is a mint tx', async () => {
+      // Mock dependencies
+      sandbox
+        .stub(bchjs.Transaction.rawTransaction, 'getTxData')
+        .resolves(mockData.mintTestInputTx)
+      sandbox
+        .stub(bchjs.Transaction.slpUtils, 'decodeOpReturn')
+        .onCall(0)
+        .resolves(mockData.mintTestOpReturnData01)
+        .onCall(1)
+        .resolves(mockData.mintTestOpReturnData02)
+        .onCall(2)
+        .resolves(mockData.mintTestOpReturnData02)
+        .onCall(3)
+        .resolves(mockData.mintTestOpReturnData03)
+        .onCall(4)
+        .resolves(mockData.mintTestOpReturnData03)
+      sandbox
+        .stub(bchjs.Transaction.slpUtils, 'waterfallValidateTxid')
+        .resolves(true)
+
+      const txid =
+        '4640a734063ea79fa587a3cac38a70a2f6f3db0011e23514024185982110d0fa'
+
+      const result = await bchjs.Transaction.get(txid)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      // Assert that there are stanardized properties.
+      assert.property(result, 'txid')
+      assert.property(result, 'vin')
+      assert.property(result, 'vout')
+      assert.property(result.vout[0], 'value')
+      assert.property(result.vout[1].scriptPubKey, 'addresses')
+
+      // Assert that added properties exist.
+      assert.property(result.vout[0], 'tokenQty')
+      assert.equal(result.vout[0].tokenQty, null)
+      assert.property(result.vin[0], 'address')
+      assert.property(result.vin[0], 'value')
+      assert.property(result.vin[0], 'tokenQty')
+      assert.property(result, 'isValidSLPTx')
+      assert.equal(result.isValidSLPTx, true)
+
+      // Assert inputs values unique to a Mint input have the proper values.
+      assert.equal(result.vin[2].tokenQty, 2.34123)
+    })
   })
 })