react-native-quick-scure-bip39/README.md

Secure, based on audited scure-bip39 and react-native-quick-crypto implementation of BIP39 mnemonic phrases

# react-native-quick-scure-bip39

Secure, based on audited [scure-bip39](https://github.com/paulmillr/scure-bip39) and [react-native-quick-crypto](https://github.com/margelo/react-native-quick-crypto) implementation of BIP39 mnemonic phrases

## Usage

> npm install react-native-quick-scure-bip39

Or

> yarn add react-native-quick-scure-bip39

```js
import * as bip39 from 'react-native-quick-scure-bip39';
import { wordlist } from 'react-native-quick-scure-bip39/wordlists/english';

// Generate x random words. Uses Cryptographically-Secure Random Number Generator.
const mn = bip39.generateMnemonic(wordlist);
console.log(mn);

// Reversible: Converts mnemonic string to raw entropy in form of byte array.
const ent = bip39.mnemonicToEntropy(mn, wordlist);

// Reversible: Converts raw entropy in form of byte array to mnemonic string.
bip39.entropyToMnemonic(ent, wordlist);

// Validates mnemonic for being 12-24 words contained in `wordlist`.
bip39.validateMnemonic(mn, wordlist);

// Irreversible: Uses KDF to derive 64 bytes of key data from mnemonic + optional password.
await bip39.mnemonicToSeed(mn, 'password');
bip39.mnemonicToSeedSync(mn, 'password');
```

This submodule contains the word lists defined by BIP39 for Czech, English, French, Italian, Japanese, Korean, Simplified and Traditional Chinese, and Spanish. These are not imported by default, as that would increase bundle sizes too much. Instead, you should import and use them explicitly.

```typescript
function generateMnemonic(wordlist: string[], strength?: number): string;
function mnemonicToEntropy(mnemonic: string, wordlist: string[]): Uint8Array;
function entropyToMnemonic(entropy: Uint8Array, wordlist: string[]): string;
function validateMnemonic(mnemonic: string, wordlist: string[]): boolean;
function mnemonicToSeed(mnemonic: string, passphrase?: string): Promise<Uint8Array>;
function mnemonicToSeedSync(mnemonic: string, passphrase?: string): Uint8Array;
```

All wordlists:

```typescript
import { wordlist } from 'react-native-quick-scure-bip39/bip39/wordlists/czech';
import { wordlist } from 'react-native-quick-scure-bip39/bip39/wordlists/english';
import { wordlist } from 'react-native-quick-scure-bip39/bip39/wordlists/french';
import { wordlist } from 'react-native-quick-scure-bip39/bip39/wordlists/italian';
import { wordlist } from 'react-native-quick-scure-bip39/bip39/wordlists/japanese';
import { wordlist } from 'react-native-quick-scure-bip39/bip39/wordlists/korean';
import { wordlist } from 'react-native-quick-scure-bip39/bip39/wordlists/simplified-chinese';
import { wordlist } from 'react-native-quick-scure-bip39/bip39/wordlists/spanish';
import { wordlist } from 'react-native-quick-scure-bip39/bip39/wordlists/traditional-chinese';
```

## License

[MIT License](./LICENSE)

Copyright (c) 2023 Iliya Bolotov (bolotov-iliya.space)