@psf/bch-js 4.20.28 → 4.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@psf/bch-js",
-  "version": "4.20.28",
+  "version": "4.21.0",
   "description": "The FullStack.cash JavaScript library for Bitcoin Cash and SLP Tokens",
   "author": "Chris Troutner <chris.troutner@gmail.com>",
   "contributors": [
@@ -18,8 +18,8 @@
     "test:integration:local:abc": "export RESTURL=http://localhost:3000/v5/ && mocha --timeout 30000 test/integration && mocha --timeout 30000 test/integration/chains/abc/",
     "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.0.36:3000/v5/ && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/bchn/",
-    "test:integration:decatur:abc": "export RESTURL=http://192.168.0.38:3000/v5/ && mocha --timeout 30000 test/integration && mocha --timeout 30000 test/integration/chains/abc/",
+    "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: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/",

package/src/address.js

@@ -186,6 +186,21 @@ class Address {
     return cashAddress.split(':')[1]
   }
 
+  /**
+   * @api Address.toHash160() toHash160()
+   * @apiName toHash160
+   * @apiGroup Address
+   * @apiDescription Converts any address format to hash160
+   *
+   * @apiExample Example usage:
+   * // cash address mainnet p2pkh
+   * bchjs.Address.toHash160("bitcoincash:qptnmya5wkly7xf97wm5ak23yqdsz3l2cyj7k9vyyh")
+   * // 573d93b475be4f1925f3b74ed951201b0147eac1
+   *
+   * // cash address mainnet p2sh
+   * bchjs.Address.toHash160("bitcoincash:pp7ushdxf5we8mcpaa3wqgsuqt639cu59ur5xu5fug")
+   * // 7dc85da64d1d93ef01ef62e0221c02f512e3942f
+   */
   // Converts any address format to hash160
   toHash160 (address) {
     const legacyAddress = this.toLegacyAddress(address)

package/src/bch-js.js

@@ -33,6 +33,7 @@ const Encryption = require('./encryption')
 const Utxo = require('./utxo')
 const Transaction = require('./transaction')
 const DSProof = require('./dsproof')
+const Ecash = require('./ecash')
 
 // Indexers
 const Ninsight = require('./ninsight')
@@ -118,6 +119,7 @@ class BCHJS {
     this.Transaction = new Transaction(libConfig)
 
     this.DSProof = new DSProof(libConfig)
+    this.eCash = new Ecash()
   }
 }
 

package/src/ecash.js

@@ -0,0 +1,47 @@
+/*
+  Utility library for converting units with eCash.
+*/
+
+class eCash {
+  /**
+   * @api eCash.toSatoshi() toSatoshi()
+   * @apiName toSatoshi
+   * @apiGroup eCash
+   * @apiDescription
+   * Convert XEC units into satoshi units
+   *
+   * @apiExample Example usage:
+   * // convert 10,704.35 XEC to satoshis:
+   * bchjs.eCash.toSatoshi(10704.35)
+   * // 1070435
+   */
+  toSatoshi (xec) {
+    if (typeof xec !== 'number') {
+      throw new Error('input must be a floating number representing XEC')
+    }
+
+    return Math.floor(xec * 100)
+  }
+
+  /**
+   * @api eCash.toXec() toXec()
+   * @apiName toXec
+   * @apiGroup eCash
+   * @apiDescription
+   * Convert satoshi units to XEC units
+   *
+   * @apiExample Example usage:
+   * // convert 1,070,435 satoshis to XEC:
+   * bchjs.eCash.toSatoshi(1070435)
+   * // 10704.35
+   */
+  toXec (sats) {
+    if (typeof sats !== 'number') {
+      throw new Error('input must be a floating number representing satoshis')
+    }
+
+    return sats / 100
+  }
+}
+
+module.exports = eCash

package/src/slp/address.js

@@ -36,7 +36,7 @@ class Address extends BCHJSAddress {
    *  bchjs.SLP.Address.toSLPAddress('qzm47qz5ue99y9yl4aca7jnz7dwgdenl85jkfx3znl')
    *  // simpleledger:qzm47qz5ue99y9yl4aca7jnz7dwgdenl857dzayzdp
    *
-   *  // tesnet legacy
+   *  // testnet legacy
    *  bchjs.SLP.Address.toSLPAddress('msDbtTj7kWXPpYaR7PQmMK84i66fJqQMLx')
    *  // slptest:qzq9je6pntpva3wf6scr7mlnycr54sjgeqauyclpwv
    *

package/test/integration/blockchain.js

@@ -313,6 +313,14 @@ describe('#blockchain', () => {
       assert.isString(result)
     })
   })
+
+  describe('#getBlockchainInfo', () => {
+    it('should get info about the blockchain', async () => {
+      const result = await bchjs.Blockchain.getBlockchainInfo()
+
+      console.log(`blockchain info: ${JSON.stringify(result, null, 2)}`)
+    })
+  })
 })
 
 function sleep (ms) {

package/test/unit/ecash.js

@@ -0,0 +1,56 @@
+/*
+  Unit tests for eCash library.
+*/
+
+// Global npm libraries
+const assert = require('chai').assert
+const Ecash = require('../../src/ecash')
+const uut = new Ecash()
+
+describe('#eCash', () => {
+  describe('#toSatoshi', () => {
+    it('should convert XEC to satoshis', () => {
+      const xec = 10704.35
+
+      const result = uut.toSatoshi(xec)
+
+      assert.equal(result, 1070435)
+    })
+
+    it('should throw an error if input is not a number', () => {
+      try {
+        uut.toSatoshi('test')
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.equal(
+          err.message,
+          'input must be a floating number representing XEC'
+        )
+      }
+    })
+  })
+
+  describe('#toXec', () => {
+    it('should convert satoshis to XEC', () => {
+      const sats = 1070435
+
+      const result = uut.toXec(sats)
+
+      assert.equal(result, 10704.35)
+    })
+
+    it('should throw an error if input is not a number', () => {
+      try {
+        uut.toXec('test')
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.equal(
+          err.message,
+          'input must be a floating number representing satoshis'
+        )
+      }
+    })
+  })
+})