@mybucks.online/core 1.0.1 → 1.0.3

package/README.md

@@ -1,10 +1,14 @@
 # @mybucks.online/core
 
-This is a core part of [mybucks.online](https://mybucks.online) crypto wallet, involving hashing and private key generation.
+This is a core part of [mybucks.online](https://mybucks.online) crypto wallet, involving hash and private key generation, generate and parse transfer-link token.
 
 ## mybucks.online
 
-[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 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,21 @@ const privateKey = getEvmPrivateKey(hash);
 console.log("Private key: ", privateKey);
 ```
 
+### 3. Generate and parse (transfer-link's)token
+```javascript
+import { generateToken } from "@mybucks.online/core";
+const token = generateToken(password, passcode, network);
+
+console.log("https://app.mybucks.online?wallet=" + token);
+```
+
+```javascript
+import { parseToken } from "@mybucks.online/core";
+const [password, passcode, network] = parseToken(token);
+console.log("Account credentials are: ", password, passcode);
+console.log("Network: ", network);
+```
+
 ## Test
 ```bash
 npm run test
@@ -42,3 +61,4 @@ Find the docs [here](https://docs.mybucks.online).
 
 - https://github.com/mybucks.online/app
 - https://app.mybucks.online
+- https://app.mybucks.online/?wallet=VWnsSGRGVtb0FjY291bnQ1JgIxMTIzMjQCb3B0aW1pc20=_wNovT

package/index.js

@@ -1,14 +1,11 @@
-const { Buffer } = require("buffer");
-const { ethers } = require("ethers");
-const { scrypt } = require("scrypt-js");
+import { Buffer } from "buffer";
+import { ethers } from "ethers";
+import scryptJS from "scrypt-js";
+import { nanoid } from "nanoid";
 
+const { scrypt } = scryptJS;
 const abi = new ethers.AbiCoder();
 
-/**
- * [CRITICAL] DON'T CHANGE FOREVER!!!
- * Reference:
- *    https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html#scrypt
- */
 const HASH_OPTIONS = {
   N: 32768, // CPU/memory cost parameter, 2^15
   r: 8, // block size parameter
@@ -24,7 +21,7 @@ const HASH_OPTIONS = {
  * @param {*} cb a callback function designed to receive the progress updates during the scrypt hashing process.
  * @returns hash result as string format
  */
-async function generateHash(password, passcode, cb = () => {}) {
+export async function generateHash(password, passcode, cb = () => {}) {
   if (!password || !passcode) {
     return "";
   }
@@ -52,11 +49,53 @@ async function generateHash(password, passcode, cb = () => {}) {
  * @param {*} hash
  * @returns private key as string format
  */
-function getEvmPrivateKey(hash) {
+export function getEvmPrivateKey(hash) {
   return ethers.keccak256(abi.encode(["string"], [hash]));
 }
 
-module.exports = {
-  generateHash,
-  getEvmPrivateKey,
-};
+const URL_DELIMITER = "\u0002";
+const NETWORKS = [
+  "ethereum",
+  "polygon",
+  "arbitrum",
+  "optimism",
+  "bsc",
+  "avalanche",
+  "tron",
+];
+/**
+ * This function generates a transfer-link by combining credentials and randomly generated padding.
+ * The transfer-link introduces a nice feature that enables the transfer of full ownership of a wallet account.
+ * @param {*} password
+ * @param {*} passcode
+ * @param {*} network ethereum | polygon | arbitrum | optimism | bsc | avalanche | tron
+ * @returns A string formatted as a transfer-link token, which can be appended to `https://app.mybucks.online?wallet=`
+ */
+export function generateToken(password, passcode, network) {
+  if (!password || !passcode || !network) {
+    return null;
+  }
+  if (!NETWORKS.find((n) => n === network)) {
+    return null;
+  }
+
+  const merged = Buffer.from(
+    password + URL_DELIMITER + passcode + URL_DELIMITER + network,
+    "utf-8"
+  );
+  const base64Encoded = merged.toString("base64");
+  const padding = nanoid(12);
+  return padding.slice(0, 6) + base64Encoded + padding.slice(6);
+}
+
+/**
+ * This function parses a transfer-link token generated by generateToken().
+ * @param {*} token
+ * @returns an array of strings, including the password, passcode and network.
+ */
+export function parseToken(token) {
+  const payload = token.slice(6, token.length - 6);
+  const base64Decoded = Buffer.from(payload, "base64").toString("utf-8");
+  const [password, passcode, network] = base64Decoded.split(URL_DELIMITER);
+  return [password, passcode, network];
+}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@mybucks.online/core",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Core module for mybucks.online crypto wallet",
   "main": "index.js",
+  "type": "module",
   "scripts": {
     "test": "node test/index.test.js"
   },
@@ -19,7 +20,11 @@
     "browser-based",
     "ethereum",
     "tron",
-    "open-source"
+    "scrypt",
+    "keccak256",
+    "key-generation",
+    "open-source",
+    "mybucks.online"
   ],
   "author": "koko37",
   "license": "MIT",
@@ -30,6 +35,7 @@
   "dependencies": {
     "buffer": "^6.0.3",
     "ethers": "^6.13.5",
+    "nanoid": "^5.0.9",
     "scrypt-js": "^3.0.1"
   }
 }

package/test/index.test.js

@@ -1,13 +1,21 @@
-const assert = require("node:assert");
-const { describe, test } = require("node:test");
-const { generateHash, getEvmPrivateKey } = require("../index.js");
+import assert from "node:assert";
+import { describe, test } from "node:test";
+import {
+  generateHash,
+  getEvmPrivateKey,
+  generateToken,
+  parseToken,
+} from "../index.js";
 
 const DEMO_PASSWORD = "DemoAccount5&";
 const DEMO_PASSCODE = "112324";
+const DEMO_NETWORK = "optimism";
 const DEMO_HASH =
   "af9a22d75f8f69d33fe8fc294e8f413219d9c75374dec07fda2e4a66868599609887a10e04981e17356d2c07432fc89c11089172fdf91c0015b9a4beef11e447";
 const DEMO_PRIVATE_KEY =
   "0x71743de900c63ed741263a2a4513c1b1829e80bd9f18d5d3a593e651b914cb3b";
+const DEMO_TOKEN =
+  "VWnsSGRGVtb0FjY291bnQ1JgIxMTIzMjQCb3B0aW1pc20=_wNovT";
 
 describe("generateHash", () => {
   test("should return empty string if password or passcode is blank", async () => {
@@ -29,3 +37,37 @@ describe("getEvmPrivateKey", () => {
     assert.strictEqual(privateKey, DEMO_PRIVATE_KEY);
   });
 });
+
+describe("generateToken", () => {
+  test("should return null if password, passcode or network is invalid", async () => {
+    assert.strictEqual(generateToken("", "123345", "ethereum"), null);
+    assert.strictEqual(generateToken("", "123345"), null);
+    assert.strictEqual(generateToken("password", "", "ethereum"), null);
+    assert.strictEqual(generateToken("password", "123456", ""), null);
+    assert.strictEqual(generateToken("password", "123456", "invalid"), null);
+  });
+});
+
+describe("parseToken", () => {
+  test("should return array of password, passcode, and network", () => {
+    const [password, passcode, network] = parseToken(DEMO_TOKEN);
+
+    assert.strictEqual(password, DEMO_PASSWORD);
+    assert.strictEqual(passcode, DEMO_PASSCODE);
+    assert.strictEqual(network, DEMO_NETWORK);
+  });
+});
+
+describe("generateToken and parseToken", () => {
+  test("should be compatible and return correct result", () => {
+    const testPassword = "random^Password9";
+    const testPasscode = "909011";
+    const testNetwork = "polygon";
+    const token = generateToken(testPassword, testPasscode, testNetwork);
+
+    const [password, passcode, network] = parseToken(token);
+    assert.strictEqual(password, testPassword);
+    assert.strictEqual(passcode, testPasscode);
+    assert.strictEqual(network, testNetwork);
+  });
+});