Make bip39 optional

Author: danielailie

README.md

@@ -50,6 +50,14 @@ This package requires `@multiversx/sdk-bls-wasm` for BLS (Boneh-Lynn-Shacham) cr
 npm install @multiversx/sdk-bls-wasm
 ```
 
+### bip39
+
+This package provides mnemonic and seed generation functionality using `bip39`, but it is not bundled by default. If you plan to use mnemonic-related features, make sure to install this optional dependency:
+
+```bash
+npm install bip39
+```
+
 ### Building the library
 
 In order to compile the library, run the following:

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@multiversx/sdk-core",
-  "version": "13.10.0",
+  "version": "13.11.0",
   "description": "MultiversX SDK for JavaScript and TypeScript",
   "author": "MultiversX",
   "homepage": "https://multiversx.com",
@@ -40,7 +40,6 @@
     "@multiversx/sdk-transaction-decoder": "1.0.2",
     "json-bigint": "1.0.0",
     "bech32": "1.1.4",
-    "bip39": "3.1.0",
     "blake2b": "2.1.3",
     "buffer": "6.0.3",
     "ed25519-hd-key": "1.1.2",
@@ -79,6 +78,7 @@
   },
   "optionalDependencies": {
     "axios": "^1.7.4",
-    "@multiversx/sdk-bls-wasm": "0.3.5"
+    "@multiversx/sdk-bls-wasm": "0.3.5",
+    "bip39": "3.1.0"
   }
 }

package.json

@@ -1,11 +1,22 @@
-import { entropyToMnemonic, generateMnemonic, mnemonicToEntropy, mnemonicToSeedSync, validateMnemonic } from "bip39";
 import { derivePath } from "ed25519-hd-key";
 import { ErrBadMnemonicEntropy, ErrWrongMnemonic } from "../errors";
 import { UserSecretKey } from "./userKeys";
 
 const MNEMONIC_STRENGTH = 256;
 const BIP44_DERIVATION_PREFIX = "m/44'/508'/0'/0'";
 
+let bip39: any;
+
+function loadBip39() {
+    if (!bip39) {
+        try {
+            bip39 = require("bip39");
+        } catch (error) {
+            throw new Error("bip39 is required but not installed. Please install 'bip39' to use mnemonic features.");
+        }
+    }
+}
+
 export class Mnemonic {
     private readonly text: string;
 
@@ -14,36 +25,41 @@ export class Mnemonic {
     }
 
     static generate(): Mnemonic {
-        const text = generateMnemonic(MNEMONIC_STRENGTH);
+        loadBip39(); // Load bip39 when needed
+        const text = bip39.generateMnemonic(MNEMONIC_STRENGTH);
         return new Mnemonic(text);
     }
 
     static fromString(text: string) {
+        loadBip39(); // Load bip39 when needed
         text = text.trim();
 
         Mnemonic.assertTextIsValid(text);
         return new Mnemonic(text);
     }
 
     static fromEntropy(entropy: Uint8Array): Mnemonic {
+        loadBip39(); // Load bip39 when needed
         try {
-            const text = entropyToMnemonic(Buffer.from(entropy));
+            const text = bip39.entropyToMnemonic(Buffer.from(entropy));
             return new Mnemonic(text);
         } catch (err: any) {
             throw new ErrBadMnemonicEntropy(err);
         }
     }
 
     public static assertTextIsValid(text: string) {
-        let isValid = validateMnemonic(text);
+        loadBip39(); // Load bip39 when needed
+        let isValid = bip39.validateMnemonic(text);
 
         if (!isValid) {
             throw new ErrWrongMnemonic();
         }
     }
 
     deriveKey(addressIndex: number = 0, password: string = ""): UserSecretKey {
-        let seed = mnemonicToSeedSync(this.text, password);
+        loadBip39(); // Load bip39 when needed
+        let seed = bip39.mnemonicToSeedSync(this.text, password);
         let derivationPath = `${BIP44_DERIVATION_PREFIX}/${addressIndex}'`;
         let derivationResult = derivePath(derivationPath, seed.toString("hex"));
         let key = derivationResult.key;
@@ -55,7 +71,8 @@ export class Mnemonic {
     }
 
     getEntropy(): Uint8Array {
-        const entropy = mnemonicToEntropy(this.text);
+        loadBip39(); // Load bip39 when needed
+        const entropy = bip39.mnemonicToEntropy(this.text);
         return Buffer.from(entropy, "hex");
     }