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

Updating README

.gitignore

@@ -4,6 +4,7 @@ wallet-info.txt
 wallet.json
 integration-test-sweet.sh
 integration-test-ss.sh
+integration-test-bitfinex.sh
 
 docs/
 coverage/

README.md

@@ -3,9 +3,9 @@
 [![Version](https://img.shields.io/npm/v/@psf/bch-js)](https://www.npmjs.com/package/@psf/bch-js)
 [![Downloads/week](https://img.shields.io/npm/dw/@psf/bch-js)](https://npmjs.org/package/@psf/bch-js)
 [![License](https://img.shields.io/npm/l/@psf/bch-js)](https://github.com/Permissionless-Software-Foundation/bch-js/blob/master/LICENSE.md)
-[![js-standard-style](https://img.shields.io/badge/javascript-standard%20code%20style-green.svg?style=flat-square)](https://github.com/feross/standard)
+[![js-standard-style](https://img.shields.io/badge/javascript-standard%20code%20style-green.svg?style=flat-square)](https://github.com/feross/standard) [![Join the chat at https://gitter.im/Permissionless-Software-Foundation/bch-js](https://badges.gitter.im/Permissionless-Software-Foundation/bch-js.svg)](https://gitter.im/Permissionless-Software-Foundation/bch-js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-[bch-js](https://www.npmjs.com/package/@psf/bch-js) is a JavaScript npm library for creating web and mobile apps that can interact with the Bitcoin Cash (BCH) blockchains. It can be used for free, but requires an account on [FullStack.cash](https://fullstack.cash) for increased rate limits. Learn more from [this article](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer) about Full Stack Bitcoin Cash development.
+[bch-js](https://www.npmjs.com/package/@psf/bch-js) is a JavaScript npm library for creating web and mobile apps that can interact with the Bitcoin Cash (BCH) and eCash (XEC) blockchains. bch-js contains a toolbox of handy tools, and an easy API for talking with [bch-api REST API](https://github.com/Permissionless-Software-Foundation/bch-api). [FullStack.cash](https://fullstack.cash) offers paid cloud access to bch-api. You can run your own infrastructure by following documentation on [CashStack.info](https://cashstack.info).
 
 ### Quick Start Videos:
 
@@ -23,6 +23,7 @@ Here are two YouTube walk-through videos to help you get started:
 - [FullStack.cash](https://fullstack.cash) - cloud-based infrastructure for application developers.
 - [FullStack.cash Account](https://fullstack.cash/login) - Get your API key to unlock increased rate limits.
 - [Permissionless Software Foundation](https://psfoundation.cash) - The organization that maintains this library.
+- [CashStack.info](https://cashstack.info) - bch-js is part of the Cash Stack, a JavaScript framework for writing web 2 and web 3 business applications.
 
 ### Quick Notes
 
@@ -42,10 +43,10 @@ the [bch-api](https://github.com/Permissionless-Software-Foundation/bch-api) RES
 - ABC Mainnet REST API server: https://abc.fullstack.cash/v5/
 - Check server status: https://metrics.fullstack.cash
 
-### API Key
+### API Key (JWT Token)
 
 The [bch-api](https://github.com/Permissionless-Software-Foundation/bch-api) REST API hosted by [FullStack.cash](https://fullstack.cash) uses JWT tokens to pay for increased
-rate limits when interacting with the back end server. See [this article](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer) if you want to understand the system-as-a-whole. The JWT token can be fed to bch-js _implicitly_ or _explicitly_.
+rate limits when interacting with the back end server. See [this article](https://cashstack.info) if you want to understand the system-as-a-whole. The JWT token can be fed to bch-js _implicitly_ or _explicitly_.
 
 - Implicitly: bch-js will detect your JWT token if you set the `BCHJSTOKEN` environment variable.
 - Explicitly: You can directly feed in the JWT token with the `apiToken` property when instantiating the library. Here is an example:
@@ -58,38 +59,25 @@ let bchjs = new BCHJS({
 })
 ```
 
-### Gatsby
+### Gatsby & Web Apps
 
-bch-js is included in this [gatsby-ipfs-template](https://github.com/Permissionless-Software-Foundation/gatsby-ipfs-template) for building uncensorable web apps that can interact with the blockchain. When building a Gatsby (or other front-end app that uses Webpack), you'll need to add these lines to your `gatsby-node.js` file, as per [this issue](https://github.com/gatsbyjs/gatsby/issues/564):
+[minimal-slp-wallet](https://www.npmjs.com/package/minimal-slp-wallet) is a minimal wallet 'engine' that incorporates bch-js. It's compiled with Browserify for front end apps.
 
-```
-exports.onCreateWebpackConfig = ({ actions }) => {
-  actions.setWebpackConfig({
-    node: {
-      fs: 'empty'
-    }
-  })
-}
-```
+[gatsby-theme-bch-wallet](https://github.com/Permissionless-Software-Foundation/gatsby-theme-bch-wallet) is a Gatsby Theme and [bch-wallet-starter](https://github.com/Permissionless-Software-Foundation/bch-wallet-starter) is a Gatsby Starter for building web wallets using minimal-slp-wallet.
 
-This is because the new IPFS class in bch-js uses the fs library for uploading files, which is not supported by Gatsby.
-
-We also provide [minimal-slp-wallet-web](https://www.npmjs.com/package/minimal-slp-wallet-web) as a basic Bitcoin Cash wallet with SLP support, for front end projects. bch-js is encapsulated inside the instantiation of the library Class.
+[This gist](https://gist.github.com/christroutner/6cb9d1b615f3f9363af79723157bc434) shows how to include minimal-slp-wallet into a basic web page without using a framework.
 
 ## Features
 
 - [ECMAScript 2017 standard JavaScript](https://en.wikipedia.org/wiki/ECMAScript#8th_Edition_-_ECMAScript_2017) used instead of TypeScript. Works
   natively with node.js v10 or higher.
 
-- Full SLP tokens support: bch-js has full support for all SLP token functionality, including send, mint, and genesis transactions. It also fully support all aspects of [non-fugible tokans (NFTs)](https://www.youtube.com/watch?v=vvlpYUx6HRs).
+- Full SLP tokens support: bch-js has full support for all SLP token functionality, including send, mint, and genesis transactions. It also fully supports all aspects of [non-fugible tokans (NFTs)](https://www.youtube.com/watch?v=vvlpYUx6HRs).
 
 - [Semantic Release](https://github.com/semantic-release/semantic-release) for
   continuous delivery using semantic versioning.
 
-- [Greenkeeper](https://greenkeeper.io/) automatic dependency management for
-  automatically maintaining the latest, most secure dependencies.
-
-- [IPFS uploads](https://ipfs.io) of all files and dependencies, to backup
+- [IPFS](https://ipfs.io) and [Radicle](https://radicle.xyz) uploads of all files and dependencies, to backup
   dependencies in case they are ever inaccessible from GitHub or npm.
 
 ## Documentation:
@@ -109,6 +97,16 @@ live in the same repository. To generate the documentation:
 Have questions? Need help? Join our community support
 [Telegram channel](https://t.me/bch_js_toolkit)
 
+## Donate
+
+This open source software is developed and maintained by the [Permissionless Software Foundation](https://psfoundation.cash). If this library provides value to you, please consider making a donation to support the PSF developers:
+
+<div align="center">
+<img src="./img/donation-qr.png" />
+<p>bitcoincash:qqsrke9lh257tqen99dkyy2emh4uty0vky9y0z0lsr</p>
+</div>
+
+
 ## IPFS Releases
 
 Copies of this repository are also published on [IPFS](https://ipfs.io).
@@ -118,5 +116,3 @@ Copies of this repository are also published on [IPFS](https://ipfs.io).
 ## License
 
 [MIT](LICENSE.md)
-
-test

package-lock.json

@@ -7545,9 +7545,10 @@
       }
     },
     "node_modules/minimist": {
-      "version": "1.2.5",
-      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
-      "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw=="
+      "version": "1.2.6",
+      "resolved": "http://94.130.170.209:4873/minimist/-/minimist-1.2.6.tgz",
+      "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==",
+      "license": "MIT"
     },
     "node_modules/minimist-options": {
       "version": "4.1.0",
@@ -20342,9 +20343,9 @@
       }
     },
     "minimist": {
-      "version": "1.2.5",
-      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
-      "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw=="
+      "version": "1.2.6",
+      "resolved": "http://94.130.170.209:4873/minimist/-/minimist-1.2.6.tgz",
+      "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q=="
     },
     "minimist-options": {
       "version": "4.1.0",

src/electrumx.js

@@ -44,7 +44,7 @@ class ElectrumX {
    * @apiDescription Return a list of uxtos for an address.
    *
    * @apiExample Example usage:
-   *    (async () => {
+   * (async () => {
    *   try {
    *     let utxo = await bchjs.Electrumx.utxo('bitcoincash:qqh793x9au6ehvh7r2zflzguanlme760wuzehgzjh9');
    *     console.log(utxo);

src/psf-slp-indexer.js

@@ -288,6 +288,8 @@ class PsfSlpIndexer {
    */
   async tx (txid) {
     try {
+      // console.log('txid: ', txid)
+
       // Handle single address.
       if (typeof txid === 'string') {
         const response = await axios.post(
@@ -295,8 +297,11 @@ class PsfSlpIndexer {
           { txid },
           this.axiosOptions
         )
+        // console.log('response: ', response)
+
         return response.data
       }
+
       throw new Error('Input txid must be a string.')
     } catch (error) {
       // console.log('error: ', error)
@@ -316,6 +321,7 @@ class PsfSlpIndexer {
 
         // Check if this txid belongs to a blacklisted token.
         const isInBlacklist = await this.checkBlacklist(txid)
+        // console.log('isInBlacklist: ', isInBlacklist)
 
         // Get the TX Details from the full node.
         const txDetails = await this.rawTransaction.getTxData(txid)

src/raw-transactions.js

@@ -381,6 +381,8 @@ class RawTransactions {
   // Appends the BCH address to the inputs of the transaction.
   async getTxData (txid) {
     try {
+      // console.log('getTxData() txid: ', txid)
+
       if (typeof txid !== 'string') {
         throw new Error(
           'Input to raw-transaction.js/getTxData() must be a string containg a TXID.'
@@ -391,17 +393,24 @@ class RawTransactions {
       const txDetails = await this.getRawTransaction(txid, true)
       // console.log(`txDetails: ${JSON.stringify(txDetails, null, 2)}`)
 
-      const inAddrs = await this._getInputAddrs(txDetails)
-      // console.log(`inAddrs: ${JSON.stringify(inAddrs, null, 2)}`)
+      try {
+        const inAddrs = await this._getInputAddrs(txDetails)
+        // console.log(`inAddrs: ${JSON.stringify(inAddrs, null, 2)}`)
 
-      // Add the input address to the transaction data.
-      for (let i = 0; i < inAddrs.length; i++) {
-        txDetails.vin[i].address = inAddrs[i].address
-        txDetails.vin[i].value = inAddrs[i].value
+        // Add the input address to the transaction data.
+        for (let i = 0; i < inAddrs.length; i++) {
+          txDetails.vin[i].address = inAddrs[i].address
+          txDetails.vin[i].value = inAddrs[i].value
+        }
+      } catch (err) {
+        // Coinbase transactions will throw an error. Just ignore them and
+        // pass back the raw transaction data.
+        /* exit quietly */
       }
 
       return txDetails
     } catch (error) {
+      // console.log('error: ', error)
       if (error.error) throw new Error(error.error)
 
       // This case handles rate limit errors.

src/slp/tokentype1.js

@@ -375,11 +375,14 @@ class TokenType1 {
       if (!Array.isArray(tokenUtxos)) {
         throw new Error('tokenUtxos must be an array.')
       }
+      if (!mintQty) {
+        throw new Error('mintQty must be a positive number.')
+      }
 
       // Loop through the tokenUtxos array and find the minting baton.
       let mintBatonUtxo
       for (let i = 0; i < tokenUtxos.length; i++) {
-        if (tokenUtxos[i].utxoType === 'minting-baton') {
+        if (tokenUtxos[i].utxoType === 'minting-baton' || tokenUtxos[i].type === 'baton') {
           mintBatonUtxo = tokenUtxos[i]
         }
       }
@@ -395,7 +398,7 @@ class TokenType1 {
       if (!tokenId) {
         throw new Error('tokenId property not found in mint-baton UTXO.')
       }
-      if (!decimals) {
+      if (!decimals && decimals !== 0) {
         throw new Error('decimals property not found in mint-baton UTXO.')
       }
 
@@ -404,6 +407,8 @@ class TokenType1 {
       baseQty = Math.floor(baseQty)
       baseQty = baseQty.toString()
 
+      if (isNaN(baseQty)) throw new Error('baseQty is non a number!')
+
       // Signal that the baton should be passed or detroyed.
       let batonVout = 2
       if (destroyBaton) batonVout = null

src/transaction.js

@@ -20,11 +20,51 @@ class Transaction {
     this.psfSlpIndexer = new PsfSlpIndexer(config)
   }
 
-  // Proxy the call to the psf-slp-indexer.
+  /**
+   * @api Transaction.get() get()
+   * @apiName get
+   * @apiGroup Transaction
+   * @apiDescription
+   * Returns an object of transaction data, including addresses for input UTXOs.
+   * If it is a SLP token transaction, the token information for inputs and
+   * outputs will also be included.
+   *
+   *
+   * @apiExample Example usage:
+   * (async () => {
+   * try {
+   *  let txData = await bchjs.Transaction.get("0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098");
+   *  console.log(txData);
+   * } catch(error) {
+   * console.error(error)
+   * }
+   * })()
+   */
   async get (txid) {
+    // console.log('transaction.get() txid: ', txid)
     return await this.psfSlpIndexer.tx(txid)
   }
 
+  /**
+   * @api Transaction.getTokenInfo() getTokenInfo()
+   * @apiName getTokenInfo
+   * @apiGroup Transaction
+   * @apiDescription
+   * Given the TXID of a token transaction, it will return data about that
+   * token by retrieving the data from the Genesis transaction and docoding
+   * the OP_RETURN.
+   *
+   *
+   * @apiExample Example usage:
+   * (async () => {
+   * try {
+   *  let txData = await bchjs.Transaction.getTokenInfo("0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098");
+   *  console.log(txData);
+   * } catch(error) {
+   * console.error(error)
+   * }
+   * })()
+   */
   // A wrapper for decodeOpReturn(). Returns false if txid is not an SLP tx.
   // Returns the token data if the txid is an SLP tx.
   async getTokenInfo (txid) {

src/util.js

@@ -281,16 +281,17 @@ class Util {
 
         // Array of blocks.
       } else if (Array.isArray(address)) {
-        const options = {
+        const options1 = {
           method: 'POST',
           url: `${this.restURL}util/validateAddress`,
           data: {
             addresses: address
-          },
-          headers: {
-            authorization: `Token ${this.apiToken}`
           }
+          // headers: {
+          //   authorization: `Token ${this.apiToken}`
+          // }
         }
+        const options = Object.assign({}, options1, this.axiosOptions)
         const response = await axios(options)
 
         return response.data

src/utxo.js

@@ -157,10 +157,14 @@ class UTXO {
       // Hydrate the UTXOs with additional token data.
       type1TokenUtxos = await this.hydrateTokenData(type1TokenUtxos)
 
+      // Collect and hydrate any baton UTXOs
       const bchUtxos = utxos.filter(x => x.isSlp === false)
-      const type1BatonUtxos = utxos.filter(
+      let type1BatonUtxos = utxos.filter(
         x => x.isSlp === true && x.type === 'baton'
       )
+      type1BatonUtxos = await this.hydrateTokenData(type1BatonUtxos)
+
+      // Isolate any UTXOs that are marked null by the SLP indexer.
       const nullUtxos = utxos.filter(x => x.isSlp === null)
 
       const outObj = {
@@ -230,6 +234,9 @@ class UTXO {
           10 ** parseInt(thisUtxo.decimals)
         )
         thisUtxo.qtyStr = qty.toString()
+
+        // tokenQty is property expected by SLP.tokentype1.js library
+        thisUtxo.tokenQty = thisUtxo.qtyStr
       }
 
       return utxoAry

test/integration/chains/bchn/transaction-integration.js

@@ -24,5 +24,14 @@ describe('#Transaction', () => {
       assert.property(result.txData, 'vout')
       assert.equal(result.txData.isValidSlp, false)
     })
+
+    it('should handle a coinbase transaction', async () => {
+      const txid = 'cca1d2dd3a533d2f501448dec03face2cb2814afd59a533a611e9a2909f2302b'
+
+      const details = await bchjs.Transaction.get(txid)
+      // console.log(`details: ${JSON.stringify(details, null, 2)}`)
+
+      assert.property(details.txData, 'txid')
+    })
   })
 })