@scintilla-network/mnemonic

Advanced BIP39 mnemonic generation and management library with comprehensive multi-language support.

Features

🌍 Multi-Language Support
- English (default)
- Japanese (日本語)
- Spanish (Español)
- French (Français)
- Italian (Italiano)
- Korean (한국어)
- Czech (Čeština)
- Portuguese (Português)
- Chinese (Simplified & Traditional)
🔑 Key Management
- BIP39 mnemonic generation
- Seed generation
- Master key derivation
- Password protection
🔒 Security
- Built on Noble Hashes
- PBKDF2 with 2048 iterations
- Optional password protection
- BIP39 specification compliant

Standalone Bundle

For offline/air-gapped environments, you can build standalone bundles containing all dependencies:

npm run build:standalone

This creates two self-contained ES modules:

public/mnemonic.standalone.js - Readable version with usage examples (~435 KB)
public/mnemonic.standalone.min.js - Minified version for production (~336 KB, published to npm)

Usage:

// Import from readable version (with examples)
import { Mnemonic } from './public/mnemonic.standalone.js';

// Or from minified version
import { Mnemonic } from './public/mnemonic.standalone.min.js';

const entropy = new Uint8Array([/* your entropy bytes */]);
const mnemonic = Mnemonic.generateMnemonic(128, 'EN', () => entropy);

Installation

npm install @scintilla-network/mnemonic

Browser

  <script type="module">
    import { Mnemonic } from 'https://unpkg.com/@scintilla-network/mnemonic'
</script>

Quick Start

import { Mnemonic } from '@scintilla-network/mnemonic';

// Generate new mnemonic (24 words by default)
const mnemonic = new Mnemonic();
console.log(mnemonic.phrase);

// Generate seed
const seed = mnemonic.toSeed();

Usage Guide

Mnemonic Generation

import { Mnemonic } from '@scintilla-network/mnemonic';
// Default 24 words (256-bit entropy)
const mnemonic = new Mnemonic();

// Custom entropy (12 words = 128 bits)
const shortPhrase = Mnemonic.generateMnemonic(128);

// Custom as instance of Mnemonic
const shortMnemonic = new Mnemonic(Mnemonic.generateMnemonic(128));

// From existing phrase
const phrase = 'shrimp various silver merge kidney kitten winter pluck smooth kidney enemy bulb';
const imported = new Mnemonic(phrase);

const isValid = Mnemonic.validate(phrase);

Multi-Language Support

// Generate japanese mnemonic
const jaMnemonic = new Mnemonic(null, 'japanese');
console.log(jaMnemonic);

// Set default language
setDefaultWordlist('spanish');
const spanishMnemonic = new Mnemonic();

// Available languages
console.log(Object.keys(wordlists));
// ['EN', 'JA', 'ES', 'FR', 'IT', 'KO', 'CS', 'PT', 'ZH_CN', 'ZH_TW']

Seed Generation

const mnemonic = new Mnemonic();

// Without password
const seed = mnemonic.toSeed();

// With password protection
const protectedSeed = mnemonic.toSeed('mypassword');

API Reference

`Mnemonic`

Constructor

new Mnemonic(mnemonic?: string)

mnemonic: Optional existing phrase. Generates new if omitted

Static Methods

Mnemonic.generateMnemonic(bytes?: number): string

bytes: Entropy (128-256, multiple of 32). Default: 256

Mnemonic.validate(string): boolean

string: The mnemonic to validate

Instance Methods

toSeed(password?: string): Uint8Array

BIP39 Utilities

setDefaultWordlist(language: string): void
getDefaultWordlist(): string[]
validateMnemonic(mnemonic: string, wordlist?: string[]): boolean

Security Considerations

Never store mnemonics in plaintext
Use password protection

License

MIT License - see the LICENSE file for details

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.