@neuraiproject/neurai-message 0.7.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Neurai
+
+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/README.md

@@ -0,0 +1,52 @@
+# neurai-message
+
+Sign and Verify messages in Neurai in JavaScript, primarly for Node.js
+
+## If you want to use it in the browser, use Browserify
+
+@neuraiproject/neurai-message is based on 'bitcoinjs-lib' which uses tons of Node stuff.
+
+To make that work in the browser you need to use Browserify
+
+## install
+
+```
+npm install @neuraiproject/neurai-message
+
+//If you need to sign messages,  install CoinKey
+npm install coinkey
+```
+
+## How to use
+
+```
+const { sign, verifyMessage } = require("@neuraiproject/neurai-message");
+
+//coinkey helps us convert from WIF to privatekey
+const CoinKey = require("coinkey");
+
+//Sign
+{
+  //Address RVDUQTULaceEudDsgqCQBT6bfcdqUSvJPV
+  //Public Key 031c5142f11f629bad27dd567c41e189ee23eccd9b57561fd0ff7c96b2cc9a0a0f
+  const privateKeyWIF = "L1JHsDosNU9FeUYB24Pixwkxs56pwCrj5rdtuKHXTcWBJTDLGNa7";
+
+  //Convert WIF to private key
+  const privateKey = CoinKey.fromWif(privateKeyWIF).privateKey;
+  const message = "Hello world";
+
+  const signature = sign(message, privateKey);
+  console.log("Signature", signature);
+}
+
+//Verify
+{
+  const address = "RS4EYELZhxMtDAuyrQimVrcSnaeaLCXeo6";
+  const message = "Hello world";
+  const signature =
+    "H2zo48+tI/KT9eJrHt7PLiEBMaRn1A1Eh49IFu0MbfhAFBxVc0FG2UE5E79PCbhd9KexijsQxYvNM6AsVn9EAEo=";
+
+  console.log("Verify", verifyMessage(message, address, signature));
+}
+
+```

package/index.ts

@@ -0,0 +1,23 @@
+import bitcoinMessage from "bitcoinjs-message";
+const MESSAGE_PREFIX = "\x16Neurai Signed Message:\n";
+
+/** returns a base64 encoded string representation of the signature */
+export function sign(message: string, privateKey: any, compressed = true) {
+  const signature = bitcoinMessage.sign(
+    message,
+    privateKey,
+    compressed,
+    MESSAGE_PREFIX
+  );
+
+  return signature.toString("base64");
+}
+export function verifyMessage(
+  message: string,
+  address: string,
+  signature: string
+) {
+  const m = Buffer.from(message).toString("ascii");
+  const result = bitcoinMessage.verify(m, address, signature, MESSAGE_PREFIX);
+  return result;
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@neuraiproject/neurai-message",
+  "version": "0.7.0",
+  "description": "Sign and Verify messages in Neurai",
+  "source": "index.ts",
+  "main": "dist/main.js",
+  "module": "dist/module.js",
+  "types": "dist/types.d.ts",
+  "scripts": {
+    "test": "jest",
+    "build": "npx parcel build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/neuraiproject/neurai-message.git"
+  },
+  "keywords": [
+    "Neurai",
+    "XNA"
+  ],
+  "author": "Dick Henrik Larsson / Neurai",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/neuraiproject/neurai-message/issues"
+  },
+  "homepage": "https://github.com/neuraiproject/neurai-message#readme",
+  "dependencies": {
+    "bitcoinjs-message": "^2.2.0"
+  },
+  "devDependencies": {
+    "@parcel/packager-ts": "^2.8.3",
+    "@parcel/transformer-typescript-types": "^2.8.3",
+    "@types/jest": "^28.1.4",
+    "@types/node": "^18.0.0",
+    "jest": "^29.4.0",
+    "parcel": "^2.8.3",
+    "typescript": "^4.9.4"
+  }
+}

package/test.js

@@ -0,0 +1,21 @@
+const { verifyMessage } = require("./dist/main");
+
+const address = "RS4EYELZhxMtDAuyrQimVrcSnaeaLCXeo6";
+const message = "Hello world";
+const signature =
+  "H2zo48+tI/KT9eJrHt7PLiEBMaRn1A1Eh49IFu0MbfhAFBxVc0FG2UE5E79PCbhd9KexijsQxYvNM6AsVn9EAEo=";
+
+test("Verify valid message signature", () => {
+  const result = verifyMessage(message, address, signature);
+
+  expect(result).toBe(true);
+});
+
+test("Verify unvalid message signature", () => {
+  const result = verifyMessage(
+    message + " change the message",
+    address,
+    signature
+  );
+  expect(result).toBe(false);
+});