@neuraiproject/neurai-key 2.5.1 → 2.8.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Raven Rebels
+Copyright (c) 2025 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

package/README.md

@@ -3,6 +3,7 @@
 Generate Neurai addresses from a mnemonic phrase following the standards BIP32, BIP39, BIP44.
 
 That is, use your 12 words to get addresses for Neurai mainnet and testnet.
+The library also support Evrmorecoin EVR, both mainnet and testnet.
 
 
 ## Example get external and internal (change) addresses by path

package/index.ts

@@ -1,6 +1,5 @@
 //Gives us meta data about coins/chains
-//import { chains } from "@hyperbitjs/chains";
-import { chains } from "@neuraiproject/chains";
+import { chains } from "@hyperbitjs/chains";
 
 //bip39 from mnemonic to seed
 import * as bip39 from "bip39";
@@ -8,16 +7,20 @@ import * as bip39 from "bip39";
 const CoinKey = require("coinkey");
 
 //From seed to key
-const HDKey = require("hdkey");
+//const HDKey = require("hdkey");
+import HDKey from "hdkey";
+import { IAddressObject } from "./types";
 
 //Could not declare Network as enum, something wrong with parcel bundler
-export type Network = "xna" | "xna-test";
+export type Network = "xna" | "xna-test" | "evr" | "evr-test";
 
 function getNetwork(name: Network) {
   const c = name.toLowerCase(); //Just to be sure
   const map = {
-    xna: chains.xna.main.versions,
-    "xna-test": chains.xna.test.versions,
+    xna: chains.xna.mainnet.versions,
+    "xna-test": chains.xna.testnet?.versions,
+    evr: chains.evr.mainnet.versions,
+    "evr-test": chains.evr.testnet?.versions,
   };
 
   const network = map[c];
@@ -26,9 +29,17 @@ function getNetwork(name: Network) {
   }
   return network;
 }
-
 /**
- * @param network - should have value "xna", "xna-test"
+ *
+ * @param network
+ * @returns the coin type for the network (blockchain), for example Neurai has coin type 175
+ */
+export function getCoinType(network: Network) {
+  const chain = getNetwork(network);
+  return chain.bip44;
+}
+/**
+ * @param network - should have value "xna", "xna-test", "evr" or "evr-test"
  * @param mnemonic - your mnemonic
  * @param account - accounts in BIP44 starts from 0, 0 is the default account
  * @param position - starts from 0
@@ -40,9 +51,8 @@ export function getAddressPair(
   position: number
 ) {
   const hdKey = getHDKey(network, mnemonic);
-  const chain = getNetwork(network);
-  const coin_type = chain.bip44;
-  //coint_type should always be 1 according to SLIP-0044
+  const coin_type = getCoinType(network);
+
   //https://github.com/satoshilabs/slips/blob/master/slip-0044.md
 
   //Syntax of BIP44
@@ -68,7 +78,11 @@ export function getHDKey(network: Network, mnemonic: string): any {
   return hdKey;
 }
 
-export function getAddressByPath(network: Network, hdKey: any, path: string) {
+export function getAddressByPath(
+  network: Network,
+  hdKey: any,
+  path: string
+): IAddressObject {
   const chain = getNetwork(network);
   const derived = hdKey.derive(path);
   var ck2 = new CoinKey(derived.privateKey, chain);
@@ -86,7 +100,17 @@ export function generateMnemonic() {
 }
 
 export function isMnemonicValid(mnemonic: string) {
-  return bip39.validateMnemonic(mnemonic);
+  //Check all languages
+  const wordlists = Object.values(bip39.wordlists);
+
+  //If mnemonic is valid in any language, return true, otherwise false
+  for (const wordlist of wordlists) {
+    const v = bip39.validateMnemonic(mnemonic, wordlist);
+    if (v === true) {
+      return true;
+    }
+  }
+  return false;
 }
 /**
  *
@@ -108,12 +132,41 @@ export function getAddressByWIF(network: Network, privateKeyWIF: string) {
 
 export const entropyToMnemonic = bip39.entropyToMnemonic;
 
+export function generateAddressObject(
+  network: Network = "xna"
+): IAddressObject {
+  const mnemonic = generateMnemonic();
+  const account = 0;
+  const position = 0;
+  const addressPair = getAddressPair(network, mnemonic, account, position);
+  const addressObject = addressPair.external;
+
+  const result = {
+    ...addressObject,
+    mnemonic,
+    network,
+  };
+  return result;
+}
+
+/**
+ * Generates a random Address Object
+ *
+ * @deprecated use generateAddressObject
+ * @param network
+ * @returns
+ */
+export function generateAddress(network: Network = "xna") {
+  return generateAddressObject(network);
+}
 export default {
   entropyToMnemonic,
+  generateAddress,
+  generateMnemonic,
   getAddressByPath,
   getAddressByWIF,
   getAddressPair,
+  getCoinType,
   getHDKey,
-  generateMnemonic,
   isMnemonicValid,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neuraiproject/neurai-key",
-  "version": "2.5.1",
+  "version": "2.8.1",
   "description": "Generate Neurai addresses from mnemonic code. BIP32, BIP39, BIP44",
   "source": "index.ts",
   "main": "dist/main.js",
@@ -27,19 +27,19 @@
   },
   "homepage": "https://github.com/neuraiproject/neurai-key#readme",
   "dependencies": {
-    "@hyperbitjs/chains": "^0.2.0",
+    "@hyperbitjs/chains": "^1.2.0",
     "bip39": "^3.0.4",
     "coinkey": "^3.0.0",
     "hdkey": "^2.0.1"
   },
   "devDependencies": {
-    "@parcel/packager-ts": "^2.8.3",
-    "@parcel/transformer-typescript-types": "^2.8.3",
-    "@types/hdkey": "^2.0.1",
+    "@parcel/packager-ts": "^2.10.3",
+    "@parcel/transformer-typescript-types": "^2.10.3",
+    "@types/hdkey": "^2.0.3",
     "@types/node": "^18.14.0",
     "browserify": "^17.0.0",
     "jest": "^29.4.0",
-    "parcel": "^2.8.3",
+    "parcel": "^2.10.3",
     "typescript": "^4.9.4"
   }
 }

package/test.js

@@ -44,7 +44,7 @@ test("Validate Wallet Import Format (WIF) test-net ", () => {
   );
 });
 
-test("Validate get public address from Wallet Import Format (WIF) main-et ", () => {
+test("Validate get public address from Wallet Import Format (WIF) main-net ", () => {
   const network = "xna";
   const WIF = "KyWuYcev1hJ7YJZTjWx8coXNRm4jRbMEhgVVVC8vDcTaKRCMASUE";
   const addressObject = NeuraiKey.getAddressByWIF(network, WIF);
@@ -69,3 +69,58 @@ test("Non valid bytes to mnemonic should fail", () => {
     "patient feed learn prison angle convince first napkin uncover track open theory"
   );
 });
+
+describe("Validate diff languages", () => {
+  it("Should accept spanish mnemonic", () => {
+    const m =
+      "velero nuera pepino reír barro reforma negar rumbo atento separar pesa puma";
+    const valid = NeuraiKey.isMnemonicValid(m);
+    expect(valid).toBe(true);
+  });
+
+  it("Should accept French mnemonic", () => {
+    const m =
+      "vaseux mixte ozone quiétude besogne punaise membre réussir avarice samedi pantalon poney";
+    const valid = NeuraiKey.isMnemonicValid(m);
+    expect(valid).toBe(true);
+  });
+});
+
+it("Should accept Italian mnemonic", () => {
+  const m =
+    "veloce perforare recinto sciroppo bici scelto parabola sguardo avanzato sonnifero remoto rustico";
+  const valid = NeuraiKey.isMnemonicValid(m);
+  expect(valid).toBe(true);
+});
+
+describe("generateAddress", () => {
+  it("should generate an address with a mnemonic", () => {
+    // Call the function
+    const result = NeuraiKey.generateAddressObject();
+
+    // Assertions
+    expect(result).toHaveProperty("mnemonic");
+    expect(result.mnemonic).toBeDefined();
+    expect(result.network).toBe("xna"); //Test default
+    expect(result).toHaveProperty("address"); // replace 'key' with the actual property you expect in addressObject
+    // ... you can add more assertions based on the expected structure of the result
+  });
+
+  it("default network should be xna for Neurai", () => {
+    const network = "xna-test";
+    // Call the function
+    const result = NeuraiKey.generateAddressObject(network);
+    // Assertions
+    expect(result.network).toBe(network); //Test default
+  });
+
+  it("Should handle xna-test", () => {
+    const network = "xna-test";
+    // Call the function
+    const result = NeuraiKey.generateAddressObject(network);
+    // Assertions
+    expect(result.network).toBe(network); //Test default
+  });
+
+  // Add more tests if needed to cover different scenarios
+});

package/types.ts

@@ -0,0 +1,7 @@
+export interface IAddressObject {
+  address: string;
+  mnemonic?: string;
+  path: string;
+  privateKey: string;
+  WIF: string;
+}