@mybucks.online/core 1.0.0 → 1.0.2

package/README.md

@@ -1,10 +1,14 @@
 # @mybucks.online/core
 
-This is a core part of mybucks.online crypto wallet, involving hashing and private key generation.
+This is a core part of [mybucks.online](https://mybucks.online) crypto wallet, involving hashing and private key generation.
 
 ## mybucks.online
 
-Mybucks.online is a **password-only, self-custodial and browser-based cryptocurrency wallet** built with Javascript. It generates a private key from your password and passcode using an industry-standard, verified **one-way hash function**. Your private key forms your account, allowing you to transfer, receive, and hold your crypto assets permanently.
+[Mybucks.online](https://mybucks.online) is a **password-only, self-custodial and browser-based cryptocurrency wallet** built with Javascript. It generates a private key from your password and passcode using an industry-standard, verified **one-way hash function**. Your private key forms your account, allowing you to transfer, receive, and hold your crypto assets instantly.
+
+As a hash function, the **scrypt** Key Derivation Function (KDF) increases the computational effort required to crack passwords, effectively delaying **brute-force** attacks and making them impractical.
+
+It fully runs on your **browser side** without using any storage or invoking any 3rd-party APIs for key management. It instantly generates your private key from your password input, and whenever you close or refresh, there is no footprint. This absolutely protects your privacy.
 
 ## Quick start
 
@@ -29,6 +33,11 @@ const privateKey = getEvmPrivateKey(hash);
 console.log("Private key: ", privateKey);
 ```
 
+## Test
+```bash
+npm run test
+```
+
 ## Docs
 
 Find the docs [here](https://docs.mybucks.online).

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@mybucks.online/core",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Core module for mybucks.online crypto wallet",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node test/index.test.js"
   },
   "repository": {
     "type": "git",

package/test/index.test.js

@@ -0,0 +1,31 @@
+const assert = require("node:assert");
+const { describe, test } = require("node:test");
+const { generateHash, getEvmPrivateKey } = require("../index.js");
+
+const DEMO_PASSWORD = "DemoAccount5&";
+const DEMO_PASSCODE = "112324";
+const DEMO_HASH =
+  "af9a22d75f8f69d33fe8fc294e8f413219d9c75374dec07fda2e4a66868599609887a10e04981e17356d2c07432fc89c11089172fdf91c0015b9a4beef11e447";
+const DEMO_PRIVATE_KEY =
+  "0x71743de900c63ed741263a2a4513c1b1829e80bd9f18d5d3a593e651b914cb3b";
+
+describe("generateHash", () => {
+  test("should return empty string if password or passcode is blank", async () => {
+    const hash = await generateHash("", "");
+    assert.strictEqual(hash, "");
+  });
+
+  test("should return scrypt hash result", async () => {
+    const hash = await generateHash(DEMO_PASSWORD, DEMO_PASSCODE);
+    assert.strictEqual(hash, DEMO_HASH);
+  });
+});
+
+describe("getEvmPrivateKey", () => {
+  test("should return 256bit private key", async () => {
+    const hash = await generateHash(DEMO_PASSWORD, DEMO_PASSCODE);
+    const privateKey = getEvmPrivateKey(hash);
+
+    assert.strictEqual(privateKey, DEMO_PRIVATE_KEY);
+  });
+});