Add comprehensive documentation to mnemonic.ts explaining BIP39 mnemonics and wallet generation

[Copilot]

Overview

This PR addresses the question "what is a mnemonic?" by adding comprehensive documentation to lib/mnemonic.ts. The file previously had no documentation explaining what mnemonics are, how they work, or how to use the module.

Changes Made

Added 104 lines of documentation throughout the file:

Module-Level Documentation

Added a detailed header explaining:

• What a mnemonic is: a 12-24 word BIP39 seed phrase that serves as a human-readable backup for cryptocurrency wallets
• Example mnemonic phrase for clarity
• Key security concepts (mnemonics must be kept secret)
• How one mnemonic can generate multiple wallet addresses using different derivation paths
• Supported blockchains with their BIP44 derivation paths:
  • Solana: m/44'/501'/{index}'/0'
  • Ethereum: m/44'/60'/0'/0/{index}

JSDoc Comments for All Types

• SupportedChain - Documents supported blockchain networks
• SolanaWallet - Field-level documentation for chain, mnemonic, publicKey, secretKey, index, and path
• EthereumWallet - Field-level documentation for chain, mnemonic, address, privateKey, index, and path
• GeneratedWallet - Explains the union type

Comprehensive Function Documentation

• generateWallet() - Full JSDoc with detailed parameter descriptions, return values, error handling, and 3 practical usage examples:
  1. Generating a new wallet
  2. Importing an existing mnemonic
  3. Generating multiple wallets from the same mnemonic
• deriveSolana() and deriveEthereum() - Internal function documentation
• Marked legacy aliases (handleMnemonic, createWalletForChain) as @deprecated

Inline Comments

• Explained BIP44 derivation path structure
• Documented coin type numbers (501 = Solana, 60 = Ethereum)
• Added code logic flow comments

Benefits

✅ Developer Experience - New developers can understand mnemonics without external research
✅ IDE Support - Full autocomplete and hover tooltips for all public APIs
✅ Security - Security considerations clearly highlighted
✅ Maintainability - Self-documenting code with clear explanations
✅ Examples - Practical usage examples for common scenarios

Validation

• ✅ TypeScript compilation passes
• ✅ ESLint validation passes with no warnings
• ✅ No breaking changes to existing functionality
• ✅ Only lib/mnemonic.ts modified (no unintended changes)

Example of Improved Documentation

/**
 * Generates or imports a cryptocurrency wallet from a mnemonic phrase
 * 
 * @param chain - The blockchain network ('solana' or 'ethereum')
 * @param mnemonic - Optional: existing mnemonic phrase to import
 * @param index - The account index for derivation (default: 0)
 * @returns A wallet object containing the mnemonic, keys, and address
 * 
 * @example
 * // Generate a new Solana wallet
 * const wallet = generateWallet('solana');
 * 
 * @example
 * // Import existing mnemonic
 * const wallet = generateWallet('ethereum', 'witch collapse practice...');
 */
export function generateWallet(chain: SupportedChain, mnemonic?: string, index = 0): GeneratedWallet

Developers using this module now have clear, actionable documentation that explains both the "what" (mnemonics are BIP39 seed phrases) and the "how" (usage examples) without needing to consult external resources.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• fonts.googleapis.com
  • Triggering command: /usr/local/bin/node /home/REDACTED/work/Wallet/Wallet/node_modules/next/dist/compiled/jest-worker/processChild.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

On mnemonic.ts, what i sht mnemonic on this

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
zengo	Ready	Preview	Comment	Oct 7, 2025 2:39pm