@shakesco/silent 1.0.5 → 1.0.7

package/README.md

@@ -19,10 +19,10 @@ const {
   SilentPaymentDestination,
   SilentPaymentBuilder,
   ECPrivateInfo,
-  Network,
+  Network: SilentNetwork,
   BitcoinScriptOutput,
   bip32,
-  bip39
+  bip39,
 } = shakesco;
 ```
 
@@ -35,19 +35,19 @@ You can generate a silent payment address in three ways:
 
 If you are not a wallet provider, use this method. More specifically, you can make the user sign a message and then derive `b_scan` and `b_spend` from the resulting [signature](https://cryptobook.nakov.com/digital-signatures/ecdsa-sign-verify-messages#ecdsa-sign) (Use `r` as `b_scan` and `s` as `b_spend` or vice versa).
 
->⚠️ If you are not using this method, ensure that a cryptographically secure random number generator is being used.
+> ⚠️ If you are not using this method, ensure that a cryptographically secure random number generator is being used.
 
 ```js {filename="index.js"}
 function main() {
-    const b_scan = "";
-    const b_spend = "";
-    const keys = KeyGeneration.fromPrivateKeys({
+  const b_scan = "";
+  const b_spend = "";
+  const keys = KeyGeneration.fromPrivateKeys({
     b_scan: b_scan,
     b_spend: b_spend,
-    network: "testnet",
-    });
-    const silentPaymentAddress = keys.toAddress();
-    console.log(silentPaymentAddress); // Silent payment address
+    network: SilentNetwork.Testnet,
+  });
+  const silentPaymentAddress = keys.toAddress();
+  console.log(silentPaymentAddress); // Silent payment address
 }
 ```
 
@@ -62,11 +62,11 @@ function main() {
   const silentPaymentAddress = keys.toAddress();
   console.log(silentPaymentAddress);
 
-// const seed = bip39.mnemonicToSeedSync(mnemonic);
-// const node = bip32.fromSeed(seed);
-// const keys = KeyGeneration.fromHd(node);
-// const silentPaymentAddress = keys.toAddress();
-// console.log(silentPaymentAddress);
+  // const seed = bip39.mnemonicToSeedSync(mnemonic);
+  // const node = bip32.fromSeed(seed);
+  // const keys = KeyGeneration.fromHd(node);
+  // const silentPaymentAddress = keys.toAddress();
+  // console.log(silentPaymentAddress);
 }
 ```
 
@@ -76,15 +76,15 @@ Create a change silent payment address that won't break privacy. Consider a scen
 
 ```js {filename="index.js"}
 function main() {
-    const b_scan = "";
-    const b_spend = "";
-    const keys = KeyGeneration.fromPrivateKeys({
+  const b_scan = "";
+  const b_spend = "";
+  const keys = KeyGeneration.fromPrivateKeys({
     b_scan: b_scan,
     b_spend: b_spend,
-    network: "testnet",
-    });
-    const changeSilentPaymentAddress = keys.toLabeledSilentPaymentAddress(0); //should always be zero!(https://github.com/bitcoin/bips/blob/master/bip-0352.mediawiki#labels_for_change)
-    console.log(changeSilentPaymentAddress.toAddress()); // change silent payment address
+    network: SilentNetwork.Testnet,
+  });
+  const changeSilentPaymentAddress = keys.toLabeledSilentPaymentAddress(0); //should always be zero!(https://github.com/bitcoin/bips/blob/master/bip-0352.mediawiki#labels_for_change)
+  console.log(changeSilentPaymentAddress.toAddress()); // change silent payment address
 }
 ```
 
@@ -100,39 +100,39 @@ You will need:
 
 ```js {filename="index.js"}
 function main() {
-    const addressPubKeys = KeyGeneration.fromAddress(silentPaymentAddress);
-    const vinOutpoints = [
+  const addressPubKeys = KeyGeneration.fromAddress(silentPaymentAddress);
+  const vinOutpoints = [
     {
-        txid: "367e24cac43a7d77621ceb1cbc1cf4a7719fc81b05b07b38f99b043f4e8b95dc",
-        index: 1,
+      txid: "367e24cac43a7d77621ceb1cbc1cf4a7719fc81b05b07b38f99b043f4e8b95dc",
+      index: 1,
     },
-    ];
+  ];
 
-    const pubkeys = [
+  const pubkeys = [
     "025c471f0e7d30d6f9095058bbaedaf13e1de67dbfcbe8328e6378d2a3bfb5cfd0",
-    ];
-    const UTXOPrivatekey = "";
-    const builder = new SilentPaymentBuilder({
+  ];
+  const UTXOPrivatekey = "";
+  const builder = new SilentPaymentBuilder({
     vinOutpoints: vinOutpoints,
     pubkeys: pubkeys,
-    }).createOutputs(
+  }).createOutputs(
     [
-        new ECPrivateInfo(
+      new ECPrivateInfo(
         UTXOPrivatekey,
         false // If the output is from a taproot address
-        ),
+      ),
     ],
     [
-        new SilentPaymentDestination({
+      new SilentPaymentDestination({
         amount: 1000,
-        network: Network.Testnet,
+        network: SilentNetwork.Testnet,
         version: 0,
         scanPubkey: addressPubKeys.B_scan,
         spendPubkey: addressPubKeys.B_spend,
-        }),
+      }),
     ]
-    );
-    console.log(builder[silentPaymentAddress][0]); // Access the taproot address and send 1000 satoshis
+  );
+  console.log(builder[silentPaymentAddress][0]); // Access the taproot address and send 1000 satoshis
 }
 ```
 
@@ -148,30 +148,30 @@ For more info, go [here](https://github.com/bitcoin/bips/blob/master/bip-0352.me
 
 ```js {filename="index.js"}
 function main() {
-    const vinOutpoints = [
+  const vinOutpoints = [
     {
-        txid: "367e24cac43a7d77621ceb1cbc1cf4a7719fc81b05b07b38f99b043f4e8b95dc",
-        index: 1,
+      txid: "367e24cac43a7d77621ceb1cbc1cf4a7719fc81b05b07b38f99b043f4e8b95dc",
+      index: 1,
     },
-    ];
+  ];
 
-    const pubkeys = [
+  const pubkeys = [
     "025c471f0e7d30d6f9095058bbaedaf13e1de67dbfcbe8328e6378d2a3bfb5cfd0",
-    ];
-    const search = new SilentPaymentBuilder({
+  ];
+  const search = new SilentPaymentBuilder({
     vinOutpoints: vinOutpoints,
     pubkeys: pubkeys,
-    network: Network.Testnet,
-    }).scanOutputs(keys.b_scan, keys.B_spend, [
+    network: SilentNetwork.Testnet,
+  }).scanOutputs(keys.b_scan, keys.B_spend, [
     new BitcoinScriptOutput(
-        "5120fdcb28bcea339a5d36d0c00a3e110b837bf1151be9e7ac9a8544e18b2f63307d",
-        BigInt(1000)
+      "5120fdcb28bcea339a5d36d0c00a3e110b837bf1151be9e7ac9a8544e18b2f63307d",
+      BigInt(1000)
     ),
-    ]);
+  ]);
 
-    console.log(
+  console.log(
     search[builder[keys.toAddress()][0].address.pubkey.toString("hex")].output
-    );
+  );
 }
 ```
 
@@ -189,22 +189,22 @@ First, you will need:
 
 ```js {filename="index.js"}
 function main() {
-     const vinOutpoints = [
-        {
-            txid: "367e24cac43a7d77621ceb1cbc1cf4a7719fc81b05b07b38f99b043f4e8b95dc",
-            index: 1,
-        },
-    ];
-
-    const pubkeys = [
+  const vinOutpoints = [
+    {
+      txid: "367e24cac43a7d77621ceb1cbc1cf4a7719fc81b05b07b38f99b043f4e8b95dc",
+      index: 1,
+    },
+  ];
+
+  const pubkeys = [
     "025c471f0e7d30d6f9095058bbaedaf13e1de67dbfcbe8328e6378d2a3bfb5cfd0",
-    ];
-    const private_key = new SilentPaymentBuilder({
+  ];
+  const private_key = new SilentPaymentBuilder({
     vinOutpoints: vinOutpoints,
     pubkeys: pubkeys,
-    }).spendOutputs(keys.b_scan, keys.b_spend);
+  }).spendOutputs(keys.b_scan, keys.b_spend);
 
-    console.log(private_key); // use this to build a taproot transaction with bitcoinjs: https://github.com/bitcoinjs/bitcoinjs-lib
+  console.log(private_key); // use this to build a taproot transaction with bitcoinjs: https://github.com/bitcoinjs/bitcoinjs-lib
 }
 ```
 
@@ -214,7 +214,4 @@ Thats it! 🎊🎊🎊
 
 ### Contribute
 
-If you love what we do to progress privacy, [contribute](https://me-qr.com/text/vPod5qN0 "btc_addr") to further development
-
-<img src="./images/bitcoin.png" alt="btc_addr" style="display: inline-block; margin-right: 100px; margin-left: 70px;" width="200">
-<img src="./images/silent.png" alt="silent_addr" width="200" style="display: inline-block; margin-right: 10px;">
+If you love what we do to progress privacy, [contribute](https://donate.shakesco.com/@shakesco.sns "shakesco_donate") to further development

package/classes/KeyGeneration.js

@@ -13,9 +13,11 @@ const Network = require("../utils/network");
 const { generateLabel, tweakAdd } = require("../utils/label");
 const bip32 = BIP32Factory(tinysecp);
 
-const SCAN_PATH = "m/352'/1'/0'/1'/0";
+const MAINNET_SCAN_PATH = "m/352'/0'/0'/1'/0";
+const MAINNET_SPEND_PATH = "m/352'/0'/0'/0'/0";
 
-const SPEND_PATH = "m/352'/1'/0'/0'/0";
+const TESTNET_SCAN_PATH = "m/352'/1'/0'/1'/0";
+const TESTNET_SPEND_PATH = "m/352'/1'/0'/0'/0";
 
 class SilentPaymentAddress {
   static get regex() {
@@ -163,6 +165,10 @@ class KeyGeneration extends SilentPaymentAddress {
    */
 
   static fromHd(bip32, { hrp = "sp", version = 0 } = {}) {
+    const SCAN_PATH = hrp == "sp" ? MAINNET_SCAN_PATH : TESTNET_SCAN_PATH;
+
+    const SPEND_PATH = hrp == "sp" ? MAINNET_SPEND_PATH : TESTNET_SPEND_PATH;
+
     const scanDerivation = bip32.derivePath(SCAN_PATH);
     const spendDerivation = bip32.derivePath(SPEND_PATH);
     return new KeyGeneration({
@@ -170,7 +176,7 @@ class KeyGeneration extends SilentPaymentAddress {
       b_spend: ec.keyFromPrivate(spendDerivation.privateKey).getPrivate(),
       B_scan: ec.keyFromPrivate(scanDerivation.privateKey).getPublic(),
       B_spend: ec.keyFromPrivate(spendDerivation.privateKey).getPublic(),
-      network: hrp == "tsp" ? Network.Testnet : Network.Mainnet,
+      network: hrp == "sp" ? Network.Mainnet : Network.Testnet,
       version: version,
     });
   }
@@ -182,9 +188,12 @@ class KeyGeneration extends SilentPaymentAddress {
    * @returns
    */
 
-  static fromMnemonic(mnemonic, { hrp = "sp", version = 0 } = {}) {
+  static fromMnemonic(
+    mnemonic,
+    { password = "", hrp = "sp", version = 0 } = {}
+  ) {
     return KeyGeneration.fromHd(
-      bip32.fromSeed(bip39.mnemonicToSeedSync(mnemonic)),
+      bip32.fromSeed(bip39.mnemonicToSeedSync(mnemonic, password)),
       {
         hrp: hrp,
         version: version,

package/package.json

@@ -1,23 +1,23 @@
-{
-  "name": "@shakesco/silent",
-  "version": "1.0.5",
-  "description": "Bitcoin Silent Payments",
-  "main": "index.js",
-  "author": "Shawn Kimtai",
-  "license": "MIT",
-  "keywords": [
-    "shakesco",
-    "shakespay",
-    "private",
-    "bitcoin",
-    "silent payments",
-    "ECDH"
-  ],
-  "dependencies": {
-    "bip32": "^5.0.0-rc.0",
-    "bip39": "^3.1.0",
-    "bn.js": "^5.2.1",
-    "elliptic": "6.6.0",
-    "tiny-secp256k1": "^2.2.3"
-  }
-}
+{
+  "name": "@shakesco/silent",
+  "version": "1.0.7",
+  "description": "Bitcoin Silent Payments",
+  "main": "index.js",
+  "author": "Shawn Kimtai",
+  "license": "MIT",
+  "keywords": [
+    "shakesco",
+    "shakespay",
+    "private",
+    "bitcoin",
+    "silent payments",
+    "ECDH"
+  ],
+  "dependencies": {
+    "bip32": "^5.0.0-rc.0",
+    "bip39": "^3.1.0",
+    "bn.js": "^5.2.1",
+    "elliptic": "6.6.1",
+    "tiny-secp256k1": "^2.2.3"
+  }
+}