@mybucks.online/core 1.0.4 → 1.0.5

package/README.md

@@ -18,19 +18,26 @@ 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, 
+  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 address = getEvmWalletAddress(hash);
+console.log("Address: ", address);
 ```
 
 ### 3. Generate and parse (transfer-link's)token
@@ -64,3 +71,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

@@ -45,14 +45,24 @@ 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 wallet = new ethers.Wallet(getEvmPrivateKey(hash));
+  return wallet.address;
+}
+
 const URL_DELIMITER = "\u0002";
 const NETWORKS = [
   "ethereum",
@@ -68,7 +78,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.5",
   "description": "Core module for mybucks.online crypto wallet",
   "main": "index.js",
   "type": "module",

package/test/index.test.js

@@ -3,6 +3,7 @@ import { describe, test } from "node:test";
 import {
   generateHash,
   getEvmPrivateKey,
+  getEvmWalletAddress,
   generateToken,
   parseToken,
 } from "../index.js";
@@ -14,6 +15,7 @@ const DEMO_HASH =
   "af9a22d75f8f69d33fe8fc294e8f413219d9c75374dec07fda2e4a66868599609887a10e04981e17356d2c07432fc89c11089172fdf91c0015b9a4beef11e447";
 const DEMO_PRIVATE_KEY =
   "0x71743de900c63ed741263a2a4513c1b1829e80bd9f18d5d3a593e651b914cb3b";
+const DEMO_WALLET_ADDRESS = "0x347CEB6Bf002Ee1819009bA07d8dCAA95Efe6465"
 const DEMO_TOKEN =
   "VWnsSGRGVtb0FjY291bnQ1JgIxMTIzMjQCb3B0aW1pc20=_wNovT";
 
@@ -38,6 +40,15 @@ 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_ADDRESS);
+  });
+});
+
 describe("generateToken", () => {
   test("should return null if password, passcode or network is invalid", async () => {
     assert.strictEqual(generateToken("", "123345", "ethereum"), null);