feat: param updates

* Update params to make it easier to implement multiple chain messages
* Params include: versions object, network object
* Updated types and readme

v1.0.0

Author: michaelmcshinsky

README.md

@@ -17,6 +17,7 @@ npm install @hyperbitjs/message
 ```javascript
 import { sign } from '@hyperbitjs/message';
 
+// Wallet Import Format (WIF) format
 const privateKey = 'L4rK1yDtCWekvXuE6oXD9jCYfFNV2cWRpVuPLBcCU2z8TrisoyY1';
 const message = 'This is an example of a signed message.';
 
@@ -36,26 +37,34 @@ const signature = '<generated_signature_from_sign>';
 const isValid = verify({ address, message, signature });
 ```
 
-Message signing defaults to Bitcoin '\u0018Bitcoin Signed Message:\n'. See [@hyperbitjs/chains](https://github.com/hyperbit-dev/chains) for message prefix options provided by different blockchains.
-
+### Full Example
 ```javascript
+import { Mnemonic } from '@hyperbitjs/mnemonic';
 import { sign, verify } from '@hyperbitjs/message';
-import { btc } from '@hyperbitjs/chains';
+import { ltc } from '@hyperbitjs/chains';
+
+const mnemonic = new Mnemonic({ network: ltc.main });
+const addresses = mnemonic.generateAddresses();
 
-const { messagePrefix } = ltc.main;
+const { wif, address } = addresses[0].external;
+const network = ltc.main;
+const message = 'This is an example of a signed message.';
 
 const signature = sign({
-  privateKey: '...',
-  message: '...',
-  messagePrefix,
+  privateKey: wif,
+  message,
+  network,
 });
 
-const isVerified = verify({
-  address: '...',
-  message: '...',
-  signature: '...',
-  messagePrefix,
+const isValid = verify({
+  message,
+  address,
+  signature,
+  network,
 });
+
+console.log('isValid', isValid);
+// Expected Output: true
 ```
 
 ## Contributing

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.0",
+  "version": "1.0.0",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -57,6 +57,7 @@
     "typescript": "^4.8.4"
   },
   "dependencies": {
+    "@hyperbitjs/chains": "^0.3.1",
     "bitcoinjs-message": "^2.2.0",
     "coinkey": "^3.0.0"
   },

src/index.ts

@@ -1,47 +1,56 @@
+import { btc } from '@hyperbitjs/chains';
 import bitcoinMessage from 'bitcoinjs-message';
 import CoinKey from 'coinkey';
 import { Sign, Verify } from './types';
 
-/**
- * TODO:
- * Fix version usage. See chains versions.public/private and https://github.com/cryptocoinjs/coinkey/blob/master/lib/coinkey.js#L9
- * Update to pull in network of blockchain
- */
-
 /**
  * Sign for proof of ownership of wallet address.
  * @param param
  * @param {string} param.message Hash used for signing your message.
  * @param {string|Buffer} param.privateKey Wallet Import Format (WIF) string or private key Buffer.
  * @param {boolean=} param.compressed
  * @param {string=} [param.messagePrefix=\u0018Bitcoin Signed Message:\n] Message prefix used by the blockchain for signing.
- * @param {any=} sigOptions Pass in any option after the initial object to make use of additional https://github.com/bitcoinjs/bitcoinjs-message parameters.
+ * @param {object=} param.versions Versions object derived from Network object from @hyperbitjs/chains. Only private and public strings required
+ * @param {object=} param.network Network object from @hyperbitjs/chains
+ * @param {any=} params Pass in any signature option after the initial object to make use of additional https://github.com/bitcoinjs/bitcoinjs-message parameters.
  * @returns A base64 encoded string representation of the signature.
  */
 export function sign(
   {
     message,
     privateKey,
     compressed = true,
-    messagePrefix = '\u0018Bitcoin Signed Message:\n',
+    messagePrefix,
+    versions,
+    network = btc.main,
   }: Sign,
-  ...sigOptions: any
+  ...params: any
 ): string | null {
+  const _messagePrefix =
+    messagePrefix || network?.messagePrefix || btc.main.messagePrefix;
+  const _versions = versions || network?.versions || btc.main.versions;
+
   try {
-    const privateKeyWif =
-      typeof privateKey === 'string'
-        ? CoinKey.fromWif(privateKey).privateKey
-        : privateKey;
+    let _compressed = compressed;
+    let _privateKeyWif = privateKey;
+
+    if (typeof privateKey === 'string') {
+      _privateKeyWif = CoinKey.fromWif(privateKey, _versions).privateKey;
+      _compressed =
+        CoinKey.fromWif(privateKey, _versions).compressed === true
+          ? true
+          : _compressed;
+    }
+
     const signature = bitcoinMessage.sign(
       message,
-      privateKeyWif,
-      compressed,
-      messagePrefix,
-      ...sigOptions
+      _privateKeyWif,
+      _compressed,
+      _messagePrefix,
+      ...params
     );
     return signature.toString('base64');
   } catch (e) {
-    console.log('e', e);
     return null;
   }
 }
@@ -53,17 +62,22 @@ export function sign(
  * @param {string} param.address Address submitted for proof of ownership.
  * @param {string} param.signature Signature generated from address and message.
  * @param {string} [param.messagePrefix=\u0018Bitcoin Signed Message:\n] Message prefix used by the blockchain for verifying.
+ * @param {object=} param.network Network object from @hyperbitjs/chains
  * @returns
  */
 export function verify({
   message,
   address,
   signature,
-  messagePrefix = '\u0018Bitcoin Signed Message:\n',
+  messagePrefix,
+  network,
 }: Verify): boolean {
+  const _messagePrefix =
+    messagePrefix || network?.messagePrefix || btc.main.messagePrefix;
+
   try {
     const m = Buffer.from(message).toString('ascii');
-    const result = bitcoinMessage.verify(m, address, signature, messagePrefix);
+    const result = bitcoinMessage.verify(m, address, signature, _messagePrefix);
     return result;
   } catch {
     return false;

src/types.ts

@@ -1,13 +1,18 @@
+import { Network, TestNetwork, Versions } from '@hyperbitjs/chains';
+
 export type Sign = {
   message: string;
   privateKey: string | Buffer;
   compressed?: boolean;
   messagePrefix?: string;
+  versions?: Pick<Versions, 'private' | 'public'>;
+  network?: Network | TestNetwork;
 };
 
 export type Verify = {
   message: string;
   address: string;
   signature: string;
   messagePrefix?: string;
+  network?: Network | TestNetwork;
 };

yarn.lock

@@ -959,6 +959,11 @@
   resolved "https://registry.yarnpkg.com/@esbuild/linux-loong64/-/linux-loong64-0.15.13.tgz#64e8825bf0ce769dac94ee39d92ebe6272020dfc"
   integrity sha512-+BoyIm4I8uJmH/QDIH0fu7MG0AEx9OXEDXnqptXCwKOlOqZiS4iraH1Nr7/ObLMokW3sOCeBNyD68ATcV9b9Ag==
 
+"@hyperbitjs/chains@^0.3.1":
+  version "0.3.1"
+  resolved "https://registry.yarnpkg.com/@hyperbitjs/chains/-/chains-0.3.1.tgz#109ca35895e366e911f264a65de7c1dc79c4bc8f"
+  integrity sha512-WseW+KW5I0c5QilFRVLKPcigFebSGI9VEzh5yLcM1a+uk/isJHqZ67IWNaAAArAZxguGvv1k0yYLUaUlunEoKw==
+
 "@istanbuljs/load-nyc-config@^1.0.0":
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz#fd3db1d59ecf7cf121e80650bb86712f9b55eced"