@mybucks.online/core 1.0.4 → 1.0.6

package/README.md

@@ -18,19 +18,30 @@ It fully runs on your **browser side** without using any storage or invoking any
 npm install @mybucks.online/core
 ```
 
-### 2. Generate hash and private-key
+### 2. Generate hash, private-key and wallet address
 
 ```javascript
-import { getEvmPrivateKey, generateHash } from "@mybucks.online/core";
+import { 
+  getEvmPrivateKey, 
+  getEvmWalletAddress, 
+  getTronWalletAddress,
+  generateHash
+} from "@mybucks.online/core";
 
 const showProgress = (p) => {
   console.log(`progress: ${p * 100}%`);
 };
 
 const hash = await generateHash(password, passcode, showProgress);
-const privateKey = getEvmPrivateKey(hash);
 
+const privateKey = getEvmPrivateKey(hash);
 console.log("Private key: ", privateKey);
+
+const address1 = getEvmWalletAddress(hash);
+console.log("EVM Address: ", address1);
+
+const address2 = getTronWalletAddress(hash);
+console.log("TRON Address: ", address2);
 ```
 
 ### 3. Generate and parse (transfer-link's)token
@@ -64,3 +75,4 @@ Find the docs [here](https://docs.mybucks.online).
   password: **DemoAccount5&**  
   passcode: **112324**
 - https://app.mybucks.online/?wallet=VWnsSGRGVtb0FjY291bnQ1JgIxMTIzMjQCb3B0aW1pc20=_wNovT
+- https://app.mybucks.online/?wallet=1jpFD8RGVtb0FjY291bnQ1JgIxMTIzMjQCYmFzZQ==fhk-GL

package/index.js

@@ -2,6 +2,7 @@ import { Buffer } from "buffer";
 import { ethers } from "ethers";
 import scryptJS from "scrypt-js";
 import { nanoid } from "nanoid";
+import { TronWeb } from "tronweb";
 
 const { scrypt } = scryptJS;
 const abi = new ethers.AbiCoder();
@@ -45,14 +46,35 @@ export async function generateHash(password, passcode, cb = () => {}) {
 }
 
 /**
- * This function derives the EVM private key from the result of the scrypt hash.
- * @param {*} hash
+ * This function derives the EVM private key from a result of the scrypt hash.
+ * @param {*} hash scrypt hash result
  * @returns private key as string format
  */
 export function getEvmPrivateKey(hash) {
   return ethers.keccak256(abi.encode(["string"], [hash]));
 }
 
+/**
+ * This function returns the EVM wallet address from a result of the scrypt hash.
+ * @param {*} hash scrypt hash result
+ * @returns address as string format
+ */
+export function getEvmWalletAddress(hash) {
+  const privateKey = getEvmPrivateKey(hash);
+  const wallet = new ethers.Wallet(privateKey);
+  return wallet.address;
+}
+
+/**
+ * This function returns the TRON wallet address from a result of the scrypt hash.
+ * @param {*} hash scrypt hash result
+ * @returns address as string format
+ */
+export function getTronWalletAddress(hash) {
+  const privateKey = getEvmPrivateKey(hash);
+  return TronWeb.address.fromPrivateKey(privateKey.slice(2));
+}
+
 const URL_DELIMITER = "\u0002";
 const NETWORKS = [
   "ethereum",
@@ -61,6 +83,7 @@ const NETWORKS = [
   "optimism",
   "bsc",
   "avalanche",
+  "base",
   "tron",
 ];
 /**
@@ -68,7 +91,7 @@ const NETWORKS = [
  * 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
+ * @param {*} network ethereum | polygon | arbitrum | optimism | bsc | avalanche | base | 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) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mybucks.online/core",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Core module for mybucks.online crypto wallet",
   "main": "index.js",
   "type": "module",
@@ -36,6 +36,7 @@
     "buffer": "^6.0.3",
     "ethers": "^6.13.5",
     "nanoid": "^5.0.9",
-    "scrypt-js": "^3.0.1"
+    "scrypt-js": "^3.0.1",
+    "tronweb": "^6.0.1"
   }
 }

package/test/index.test.js

@@ -3,6 +3,8 @@ import { describe, test } from "node:test";
 import {
   generateHash,
   getEvmPrivateKey,
+  getEvmWalletAddress,
+  getTronWalletAddress,
   generateToken,
   parseToken,
 } from "../index.js";
@@ -10,11 +12,15 @@ import {
 const DEMO_PASSWORD = "DemoAccount5&";
 const DEMO_PASSCODE = "112324";
 const DEMO_NETWORK = "optimism";
+
 const DEMO_HASH =
   "af9a22d75f8f69d33fe8fc294e8f413219d9c75374dec07fda2e4a66868599609887a10e04981e17356d2c07432fc89c11089172fdf91c0015b9a4beef11e447";
 const DEMO_PRIVATE_KEY =
   "0x71743de900c63ed741263a2a4513c1b1829e80bd9f18d5d3a593e651b914cb3b";
-const DEMO_TOKEN =
+const DEMO_WALLET_EVM_ADDRESS = "0x347CEB6Bf002Ee1819009bA07d8dCAA95Efe6465";
+const DEMO_WALLET_TRON_ADDRESS = "TEkjnbpr2cTgRFgmrbv2Gb7GdgupZ5Sh3A";
+
+const DEMO_TRANSFER_TOKEN =
   "VWnsSGRGVtb0FjY291bnQ1JgIxMTIzMjQCb3B0aW1pc20=_wNovT";
 
 describe("generateHash", () => {
@@ -38,19 +44,47 @@ describe("getEvmPrivateKey", () => {
   });
 });
 
+describe("getEvmWalletAddress", () => {
+  test("should return a valid wallet address", async () => {
+    const hash = await generateHash(DEMO_PASSWORD, DEMO_PASSCODE);
+    const address = getEvmWalletAddress(hash);
+
+    assert.strictEqual(address, DEMO_WALLET_EVM_ADDRESS);
+  });
+});
+
+describe("getTronWalletAddress", () => {
+  test("should return a valid wallet address", async () => {
+    const hash = await generateHash(DEMO_PASSWORD, DEMO_PASSCODE);
+    const address = getTronWalletAddress(hash);
+
+    assert.strictEqual(address, DEMO_WALLET_TRON_ADDRESS);
+  });
+});
+
 describe("generateToken", () => {
-  test("should return null if password, passcode or network is invalid", async () => {
+  test("should return null if password, passcode or network is invalid", () => {
     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);
   });
+
+  test("should return valid token", async () => {
+    const token = generateToken(DEMO_PASSWORD, DEMO_PASSCODE, DEMO_NETWORK);
+
+    // The first and last 6 characters serve as random padding.
+    assert.strictEqual(
+      token.slice(6, token.length - 6),
+      DEMO_TRANSFER_TOKEN.slice(6, DEMO_TRANSFER_TOKEN.length - 6)
+    );
+  });
 });
 
 describe("parseToken", () => {
   test("should return array of password, passcode, and network", () => {
-    const [password, passcode, network] = parseToken(DEMO_TOKEN);
+    const [password, passcode, network] = parseToken(DEMO_TRANSFER_TOKEN);
 
     assert.strictEqual(password, DEMO_PASSWORD);
     assert.strictEqual(passcode, DEMO_PASSCODE);