Merge branch 'master' into nft-docs-fixes

Merge pull request #196 from Permissionless-Software-Foundation/temp-documentation
Temp documentation
2026-09-22 00:52:01 -07:00 · 2021-11-13 06:47:17 -08:00 · 2021-11-13 06:46:59 -08:00 · 2021-11-13 06:43:55 -08:00 · 2021-11-13 06:42:57 -08:00 · 2021-11-13 06:42:05 -08:00
5 changed files with 14 additions and 14 deletions
@@ -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
@@ -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
@@ -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)
   *   }
@@ -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)
   *  }
   *})()
   *
@@ -432,7 +432,7 @@ class Nft1 {
   * @apiExample Example usage:
   *
   * const groupId = '68cd33ecd909068fbea318ae5ff1d6207cf754e53b191327d6d73b6916424c0a'
-   * const children = await bchjs.SLP.Nft1.listNFTGroupChildren(groupId)
+   * const children = await bchjs.SLP.NFT1.listNFTGroupChildren(groupId)
   *
   * children = {
   *  "nftChildren": [
@@ -471,7 +471,7 @@ class Nft1 {
   * @apiExample Example usage:
   *
   * const tokenId = '45a30085691d6ea586e3ec2aa9122e9b0e0d6c3c1fd357decccc15d8efde48a9'
-   * const group = await bchjs.SLP.Nft1.parentNFTGroup(tokenId)
+   * const group = await bchjs.SLP.NFT1.parentNFTGroup(tokenId)
   *
   * group = {
   *   "nftGroup": {
Author	SHA1	Message	Date
Chris Troutner	c74b675bc9	Merge branch 'master' into nft-docs-fixes	2021-11-13 06:47:17 -08:00
Chris Troutner	d0129c01f3	Merge pull request #196 from Permissionless-Software-Foundation/temp-documentation Temp documentation	2021-11-13 06:46:59 -08:00
Chris Troutner	ad40607e5b	Merge pull request #186 from mr-zwets/documentation-fix small fixes documentation	2021-11-13 06:43:55 -08:00
Chris Troutner	a4f0ee6e42	Merge branch 'master' into documentation-fix	2021-11-13 06:42:57 -08:00
Chris Troutner	0b70ea108b	Merge pull request #195 from Permissionless-Software-Foundation/temp-documentation Temp documentation	2021-11-13 06:42:05 -08:00
Chris Troutner	cef9a3cf52	Merge pull request #194 from mr-zwets/documentation clarified some of the documentation	2021-11-13 06:38:04 -08:00
mathi	c216f6c075	clarified some of the documentation	2021-11-13 11:37:56 +01:00
Chris Troutner	c095af8a29	Merge branch 'master' into documentation-fix	2021-10-30 09:07:46 -07:00
mathi	89e4ea1635	small fixes documentation	2021-10-30 17:06:46 +02:00
Stoyan Zhekov	ee7ab54d26	Some NFT-related calls sample usage fixes	2021-07-21 11:26:35 +09:00