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

fix(npm): Ran npm audit fix. 0 vulns

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

@@ -20,11 +20,50 @@ 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) {
     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/utxo.js

@@ -230,6 +230,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