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

Updating Utxo.get()

README.md

@@ -5,7 +5,7 @@
 [![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) [![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,14 +97,26 @@ 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)
 
-## IPFS Releases
+## 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 & Radicle Releases
 
 Copies of this repository are also published on [IPFS](https://ipfs.io).
 
-- v4.5.4: QmWv3pxJy3MH8vU5nLUVyzqFxfNKXLQQEnz1rgStNuQijd
+- v6.2.10: `bafybeifsioj3ba77u2763nsyuzq53gtbdxsnqpoipvdl4immj6ytznjaoy`
+- (with dependencies, node v14.18.2 and npm v8.8.0): `bafybeihfendd4oj6uxvvecm7sluobwwhpb5wdcxhvhmx56e667nxdncd4a`
+
+They are also posted to the Radicle:
+- v6.2.10: `rad:git:hnrkkroqnbfwj6uxpfjuhspoxnfm4i8e6oqwy`
 
 ## License
 
 [MIT](LICENSE.md)
-
-test

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/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/utxo.js

@@ -92,7 +92,7 @@ class UTXO {
       // Get SLP UTXOs from the psf-slp-indexer
       try {
         const slpUtxoData = await this.psfSlpIndexer.balance(addr)
-        // console.log(`slpUtxoData: ${JSON.stringify(slpUtxoData, null, 2)}`)
+        console.log(`slpUtxoData: ${JSON.stringify(slpUtxoData, null, 2)}`)
 
         slpUtxos = slpUtxoData.balance.utxos
       } catch (err) {
@@ -125,6 +125,7 @@ class UTXO {
             thisUtxo.qty = thisSlpUtxo.qty
             thisUtxo.tokenId = thisSlpUtxo.tokenId
             thisUtxo.address = thisSlpUtxo.address
+            thisUtxo.tokenType = thisSlpUtxo.tokenType
 
             break
           }
@@ -151,16 +152,38 @@ class UTXO {
 
       // Get token UTXOs
       let type1TokenUtxos = utxos.filter(
-        x => x.isSlp === true && x.type === 'token'
+        x => x.isSlp === true && x.type === 'token' && x.tokenType === 1
       )
 
       // Hydrate the UTXOs with additional token data.
       type1TokenUtxos = await this.hydrateTokenData(type1TokenUtxos)
 
+      // Collect and hydrate any type1 baton UTXOs
       const bchUtxos = utxos.filter(x => x.isSlp === false)
-      const type1BatonUtxos = utxos.filter(
-        x => x.isSlp === true && x.type === 'baton'
+      let type1BatonUtxos = utxos.filter(
+        x => x.isSlp === true && x.type === 'baton' && x.tokenType === 1
       )
+      type1BatonUtxos = await this.hydrateTokenData(type1BatonUtxos)
+
+      // Collect and hydrate NFT Group tokens
+      let nftGroupTokenUtxos = utxos.filter(
+        x => x.isSlp === true && x.type === 'token' && x.tokenType === 129
+      )
+      nftGroupTokenUtxos = await this.hydrateTokenData(nftGroupTokenUtxos)
+
+      // Collect and hydrate any Group baton UTXOs
+      let groupBatonUtxos = utxos.filter(
+        x => x.isSlp === true && x.type === 'baton' && x.tokenType === 129
+      )
+      groupBatonUtxos = await this.hydrateTokenData(groupBatonUtxos)
+
+      // Collect and hydrate NFT child tokens
+      let nftChildTokenUtxos = utxos.filter(
+        x => x.isSlp === true && x.type === 'token' && x.tokenType === 65
+      )
+      nftChildTokenUtxos = await this.hydrateTokenData(nftChildTokenUtxos)
+
+      // Isolate any UTXOs that are marked null by the SLP indexer.
       const nullUtxos = utxos.filter(x => x.isSlp === null)
 
       const outObj = {
@@ -171,7 +194,13 @@ class UTXO {
             tokens: type1TokenUtxos,
             mintBatons: type1BatonUtxos
           },
-          nft: {} // Allocated for future support of NFT spec.
+          group: {
+            tokens: nftGroupTokenUtxos,
+            mintBatons: groupBatonUtxos
+          },
+          nft: {
+            tokens: nftChildTokenUtxos
+          }
         },
         nullUtxos
       }
@@ -225,14 +254,16 @@ class UTXO {
         thisUtxo.documentHash = genData[0].tokenData.documentHash
         thisUtxo.decimals = genData[0].tokenData.decimals
 
-        // Calculate the real token quantity
-        const qty = new BigNumber(thisUtxo.qty).dividedBy(
-          10 ** parseInt(thisUtxo.decimals)
-        )
-        thisUtxo.qtyStr = qty.toString()
+        if (thisUtxo.type !== 'baton') {
+          // Calculate the real token quantity
+          const qty = new BigNumber(thisUtxo.qty).dividedBy(
+            10 ** parseInt(thisUtxo.decimals)
+          )
+          thisUtxo.qtyStr = qty.toString()
 
-        // tokenQty is property expected by SLP.tokentype1.js library
-        thisUtxo.tokenQty = thisUtxo.qtyStr
+          // tokenQty is property expected by SLP.tokentype1.js library
+          thisUtxo.tokenQty = thisUtxo.qtyStr
+        }
       }
 
       return utxoAry

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

@@ -83,13 +83,11 @@ describe('#UTXO', () => {
       assert.equal(result.slpUtxos.type1.mintBatons.length, 0)
     })
 
-    // TODO: NFTs are currently not identified as different than normal BCH UTXOs.
-    // The psf-slp-indexer needs to be updated to fix this issue.
-    it('should handle minting batons', async () => {
-      const addr = 'simpleledger:qrm0c67wwqh0w7wjxua2gdt2xggnm90xwsr5k22euj'
+    it('should handle Type1 minting batons', async () => {
+      const addr = 'simpleledger:qz5l5yzz9r09hw9aadcz53elp2knx6gyg5qk3s8md7'
 
       const result = await bchjs.Utxo.get(addr)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+      console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
       // Assert that minting batons are correctly identified.
       assert.isAbove(result.slpUtxos.type1.mintBatons.length, 0)
@@ -105,14 +103,25 @@ describe('#UTXO', () => {
       assert.equal(result.slpUtxos.type1.tokens.length, 0)
     })
 
-    it('should handle Group NFTs', async () => {
-      const addr = 'bitcoincash:qrnghwrfgccf3s5e9wnglzxegcnhje9rkcwv2eka33'
+    it('should filter Group tokens and mint batons', async () => {
+      const addr = 'bitcoincash:qzeqcrpe5fcnslv8rfqjq4gh4gzdwytmdc4qmh0ztv'
 
       const result = await bchjs.Utxo.get(addr)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
-      assert.equal(result.nullUtxos.length, 0)
+      assert.isAbove(result.slpUtxos.group.tokens.length, 0)
+      assert.isAbove(result.slpUtxos.group.mintBatons.length, 0)
     })
+
+    // it('should filter NFTs', async () => {
+    //   const addr = 'bitcoincash:qq7vp2kvejsql898a2760kuq6xz00h0a5vs4h72ysz'
+    //
+    //   const result = await bchjs.Utxo.get(addr)
+    //   console.log(`result: ${JSON.stringify(result, null, 2)}`)
+    //
+    //   // assert.isAbove(result.slpUtxos.group.tokens.length, 0)
+    //   // assert.isAbove(result.slpUtxos.group.mintBatons.length, 0)
+    // })
   })
 })