@psf/bch-js 4.20.26 → 4.20.27

package/LICENSE.md

@@ -1,7 +1,8 @@
-Copyright 2021 Chris Troutner
+Copyright 2021 Permissionless Software Foundation contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@psf/bch-js",
-  "version": "4.20.26",
+  "version": "4.20.27",
   "description": "The FullStack.cash JavaScript library for Bitcoin Cash and SLP Tokens",
   "author": "Chris Troutner <chris.troutner@gmail.com>",
   "contributors": [

package/src/address.js

@@ -223,7 +223,7 @@ class Address {
    * @api Address.hash160ToCash() hash160ToCash()
    * @apiName hash160ToCash
    * @apiGroup Address
-   * @apiDescription Convert hash160 to cash address.
+   * @apiDescription Convert hash160 to cash address. Accepts either hexadecimal or buffer.
    *
    * @apiExample Example usage:
    * bchjs.Address.hash160ToCash("573d93b475be4f1925f3b74ed951201b0147eac1")
@@ -794,13 +794,13 @@ class Address {
    * @apiDescription Detect an addess from an OutputScript..
    *
    * @apiExample Example usage:
-   *  const script = bchjs.Script.encode([
+   *  const scriptBuffer = bchjs.Script.encode([
    *    Buffer.from("BOX", "ascii"),
    *    bchjs.Script.opcodes.OP_CAT,
    *    Buffer.from("BITBOX", "ascii"),
    *    bchjs.Script.opcodes.OP_EQUAL
    *  ]);
-   *  const p2sh_hash160 = bchjs.Crypto.hash160(script);
+   *  const p2sh_hash160 = bchjs.Crypto.hash160(scriptBuffer);
    *  const scriptPubKey = bchjs.Script.scriptHash.output.encode(p2sh_hash160);
    *
    *  // mainnet address from output script

package/src/crypto.js

@@ -22,7 +22,7 @@ class Crypto {
    *  // buffer from hex
    *  let buffer = Buffer.from('03123464075c7a5fa6b8680afa2c962a02e7bf071c6b2395b0ac711d462cac9354', 'hex')
    *  bchjs.Crypto.sha256(buffer)
-   *  // <Buffer 26 b0 78 0a 68 3a 1e 09 8e 9c b8 cf a1 b0 92 42 28 25 00 97>
+   *  // <Buffer 97 8c 09 dd 46 09 1d 19 22 fa 01 e9 f4 a9 75 b9 1a 37 1f 26 ba 83 99 de 27 d5 38 01 15 21 21 de>
    *
    * */
   // Translate address from any address format into a specific format.
@@ -60,7 +60,7 @@ class Crypto {
    * @api Crypto.hash256() hash256()
    * @apiName hash256
    * @apiGroup Crypto
-   * @apiDescription Utility for creating double sha256 hash digests of data.
+   * @apiDescription Utility for creating double sha256 hash digests of buffer encoded data.
    *
    * @apiExample Example usage:
    *   // buffer from hex
@@ -86,7 +86,7 @@ class Crypto {
    * @api Crypto.hash160() hash160()
    * @apiName hash160
    * @apiGroup Crypto
-   * @apiDescription Utility for creating ripemd160(sha256()) hash digests of data.
+   * @apiDescription Utility for creating ripemd160(sha256()) hash digests of buffer encoded data.
    *
    * @apiExample Example usage:
    *  // buffer from hex

package/src/electrumx.js

@@ -142,7 +142,7 @@ class ElectrumX {
    * (async () => {
    *   try {
    *     let balance = await bchjs.Electrumx.balance('bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf');
-   *     console.log(utxo);
+   *     console.log(balance);
    *   } catch(error) {
    *    console.error(error)
    *   }
@@ -159,7 +159,7 @@ class ElectrumX {
    * (async () => {
    *   try {
    *     let balance = await bchjs.Electrumx.balance(['bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf', 'bitcoincash:qpdh9s677ya8tnx7zdhfrn8qfyvy22wj4qa7nwqa5v']);
-   *     console.log(utxo);
+   *     console.log(balance);
    *   } catch(error) {
    *    console.error(error)
    *   }

package/src/price.js

@@ -58,7 +58,7 @@ class Price {
    *    let current = await bchjs.Price.getUsd();
    *    console.log(current);
    *  } catch(err) {
-   *   console.err(err)
+   *   console.error(err)
    *  }
    *})()
    *
@@ -94,7 +94,7 @@ class Price {
    *    let current = await bchjs.Price.rates();
    *    console.log(current);
    *  } catch(err) {
-   *   console.err(err)
+   *   console.error(err)
    *  }
    *})()
    *
@@ -137,7 +137,7 @@ class Price {
    *    let current = await bchjs.Price.getBchaUsd();
    *    console.log(current);
    *  } catch(err) {
-   *   console.err(err)
+   *   console.error(err)
    *  }
    *})()
    *
@@ -175,7 +175,7 @@ class Price {
    *    let current = await bchjs.Price.getXecUsd();
    *    console.log(current);
    *  } catch(err) {
-   *   console.err(err)
+   *   console.error(err)
    *  }
    *})()
    *
@@ -210,7 +210,7 @@ class Price {
    *    let current = await bchjs.Price.getBchUsd();
    *    console.log(current);
    *  } catch(err) {
-   *   console.err(err)
+   *   console.error(err)
    *  }
    *})()
    *