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

fix(encryption): Adding documentation for the encryption library

package.json

@@ -19,7 +19,7 @@
     "test:integration:local:bchn": "export RESTURL=http://localhost:3000/v5/ && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/bchn/",
     "test:integration:local:testnet": "RESTURL=http://localhost:4000/v5/ mocha --timeout 30000 test/integration/chains/testnet",
     "test:integration:decatur:bchn": "export RESTURL=http://192.168.2.129:3000/v5/ && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/bchn/",
-    "test:integration:decatur:abc": "export RESTURL=http://192.168.2.141:3000/v5/ && mocha --timeout 30000 test/integration && mocha --timeout 30000 test/integration/chains/abc/",
+    "test:integration:decatur:abc": "export RESTURL=http://192.168.2.142:3000/v5/ && mocha --timeout 30000 test/integration && mocha --timeout 30000 test/integration/chains/abc/",
     "test:integration:temp:bchn": "export RESTURL=http://157.90.174.219:3000/v5/ && mocha --timeout 30000 test/integration/",
     "test:temp": "export RESTURL=http://localhost:3000/v5/ && mocha --timeout 30000 -g '#Encryption' test/integration/",
     "test:temp2": "mocha --timeout=30000 -g '#TransactionLib' test/unit/",

src/encryption.js

@@ -32,6 +32,28 @@ class Encryption {
     _this = this
   }
 
+  /**
+   * @api encryption.getPubKey() getPubKey()
+   * @apiName Encryption getPubKey()
+   * @apiGroup Encryption
+   * @apiDescription Get the public key for an address
+   * Given an address, the command will search the blockchain for a public
+   * key associated with that address. The address needs to have made at least
+   * one spend transaction, in order for its public key to be retrievable.
+   *
+   * @apiExample Example usage:
+   *(async () => {
+   *  try {
+   *    const addr = 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'
+   *    const pubkey = await bchjs.encryption.getPubKey(addr);
+   *    console.log(pubkey);
+   *  } catch(err) {
+   *   console.error(err)
+   *  }
+   *})()
+   *
+   */
+
   // Search the blockchain for a public key associated with a BCH address.
   async getPubKey (addr) {
     try {

src/psf-slp-indexer.js

@@ -449,6 +449,18 @@ class PsfSlpIndexer {
    * @apiGroup PSF SLP
    * @apiDescription Get token icon and other media associated with a token.
    *
+   * Get the icon for a token, given it's token ID.
+   * This function expects a string input of a token ID property.
+   * This function returns an object with a tokenIcon property that contains
+   * the URL to the icon.
+   *
+   * The output object always have these properties:
+   * - tokenIcon: A url to the token icon, if it exists.
+   * - tokenStats: Data about the token from psf-slp-indexer.
+   * - optimizedTokenIcon: An alternative, potentially more optimal, url to the token icon, if it exists.
+   * - iconRepoCompatible: true if the token icon is available via token.bch.sx
+   * - ps002Compatible: true if the token icon is compatible with PS007 specification.
+   *
    * @apiExample Example usage:
    * (async () => {
    *   try {
@@ -520,7 +532,7 @@ class PsfSlpIndexer {
 
       throw new Error('Input tokenId must be a string.')
     } catch (error) {
-      console.log('error: ', error)
+      // console.log('error: ', error)
       if (error.response && error.response.data) throw error.response.data
       else throw error
     }

src/utxo.js

@@ -109,6 +109,11 @@ class UTXO {
         }
       }
 
+      // Get the sync status of the SLP indexer
+      const syncStatus = await this.psfSlpIndexer.status()
+      const slpIndexerHeight = syncStatus.status.syncedBlockHeight
+      const chainBlockHeight = syncStatus.status.chainBlockHeight
+
       // Loop through the Fulcrum UTXOs.
       for (let i = 0; i < utxos.length; i++) {
         const thisUtxo = utxos[i]
@@ -152,6 +157,15 @@ class UTXO {
             thisUtxo.isSlp = false
           }
           // console.log(`thisUtxo.isSlp: ${thisUtxo.isSlp}`)
+
+          // If the SLP indexer more than 1 block behind the full node, then
+          // move any BCH UTXOs of 600 sats or less into the null array. This
+          // protects token UTXOs from being burned accidentally.
+          if (slpIndexerHeight < chainBlockHeight - 1) {
+            if (thisUtxo.value < 601) {
+              thisUtxo.isSlp = null
+            }
+          }
         }
       }
 

test/e2e/utxo/unsynced-indexer.js

@@ -0,0 +1,27 @@
+/*
+  This test is used to interrogate the behavior of bch-js when a psf-slp-indexer
+  panicks and starts indexing from SLP genesis. In this corner-case, bch-js
+  should detect the indexer is out of sync, and protect any token UTXOs by
+  moving any UTXO under 600 sats into the null array.
+
+  TO RUN THIS TEST:
+  - Reset a local instance of psf-slp-indexer to sync from genesis.
+  - Start a local copy of bch-api
+*/
+
+const BCHJS = require('../../../src/bch-js.js')
+const bchjs = new BCHJS({
+  restURL: 'http://localhost:3000/v5/'
+})
+
+async function startTest () {
+  try {
+    const addr = 'bitcoincash:qzkvas58zag9tjry693mflkjze2m20ps7vx7uw7z9d'
+
+    const result = await bchjs.Utxo.get(addr)
+    console.log(`result: ${JSON.stringify(result, null, 2)}`)
+  } catch (err) {
+    console.error('Error in startTest(): ', err)
+  }
+}
+startTest()

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

@@ -156,26 +156,28 @@ describe('#psf-slp-indexer', () => {
     })
   })
 
-  describe('#getTokenData2', () => {
-    it('should get token data', async () => {
-      const tokenId =
-        'd9aafa7acb514c597caf440ae268b5e4e955f2687e05f044cdf8fd9550d9a27b'
-
-      // bchjs.PsfSlpIndexer.restURL = 'http://localhost:3000/v5/'
-      const result = await bchjs.PsfSlpIndexer.getTokenData2(tokenId)
-      console.log('result: ', result)
-
-      assert.property(result, 'tokenStats')
-      assert.property(result, 'mutableData')
-      assert.property(result, 'immutableData')
-      assert.property(result, 'tokenIcon')
-      assert.property(result, 'fullSizedUrl')
-      assert.property(result, 'optimizedTokenIcon')
-      assert.property(result, 'optimizedFullSizedUrl')
-      assert.property(result, 'iconRepoCompatible')
-      assert.property(result, 'ps002Compatible')
-    })
-  })
+  // This test is commented out because it can not succeed in the BVT without
+  // tripping rate limits.
+  // describe('#getTokenData2', () => {
+  //   it('should get token data', async () => {
+  //     const tokenId =
+  //       'd9aafa7acb514c597caf440ae268b5e4e955f2687e05f044cdf8fd9550d9a27b'
+  //
+  //     // bchjs.PsfSlpIndexer.restURL = 'http://localhost:3000/v5/'
+  //     const result = await bchjs.PsfSlpIndexer.getTokenData2(tokenId)
+  //     // console.log('result: ', result)
+  //
+  //     assert.property(result, 'tokenStats')
+  //     assert.property(result, 'mutableData')
+  //     assert.property(result, 'immutableData')
+  //     assert.property(result, 'tokenIcon')
+  //     assert.property(result, 'fullSizedUrl')
+  //     assert.property(result, 'optimizedTokenIcon')
+  //     assert.property(result, 'optimizedFullSizedUrl')
+  //     assert.property(result, 'iconRepoCompatible')
+  //     assert.property(result, 'ps002Compatible')
+  //   })
+  // })
 })
 
 // Promise-based sleep function

test/unit/utxo-unit.js

@@ -121,6 +121,8 @@ describe('#utxo', () => {
       sandbox
         .stub(bchjs.Utxo.psfSlpIndexer, 'tx')
         .resolves({ txData: { isValidSlp: false } })
+      sandbox.stub(bchjs.Utxo.psfSlpIndexer, 'status')
+        .resolves({ status: { syncedBlockHeight: 600000, chainBlockHeight: 600000 } })
 
       // Mock function to return the same input. Good enough for this test.
       sandbox.stub(bchjs.Utxo, 'hydrateTokenData').resolves(x => x)
@@ -154,6 +156,8 @@ describe('#utxo', () => {
       sandbox
         .stub(bchjs.Utxo.psfSlpIndexer, 'tx')
         .resolves({ txData: { isValidSlp: false } })
+      sandbox.stub(bchjs.Utxo.psfSlpIndexer, 'status')
+        .resolves({ status: { syncedBlockHeight: 600000, chainBlockHeight: 600000 } })
 
       // Force psf-slp-indexer to return no UTXOs
       sandbox