bip39 1.0.3

  • Readme
  • Changelog
  • Example
  • Installing
  • 81

BIP39 #

Dart implementation of Bitcoin BIP39: Mnemonic code for generating deterministic keys

Convert from bitcoinjs/bip39

Reminder for developers #

Please remember to allow recovery from mnemonic phrases that have invalid checksums (or that you don't have the wordlist)

When a checksum is invalid, warn the user that the phrase is not something generated by your app, and ask if they would like to use it anyway. This way, your app only needs to hold the wordlists for your supported languages, but you can recover phrases made by other apps in other languages.

However, there should be other checks in place, such as checking to make sure the user is inputting 12 words or more separated by a space.

Examples #

// Generate a random mnemonic (uses crypto.randomBytes under the hood), defaults to 128-bits of entropy
var mnemonic = bip39.generateMnemonic()
// => 'seed sock milk update focus rotate barely fade car face mechanic mercy'

bip39.mnemonicToSeedHex('basket actual')
// => String '5cf2d4a8b0355e90295bdfc565a022a409af063d5365bb57bf74d9528f494bfa4400f53d8349b80fdae44082d7f9541e1dba2b003bcfec9d0d53781ca676651f'

bip39.mnemonicToSeed('basket actual')
// => Uint8List [92, 242, 212, 168, 176, 53, 94, 144, 41, 91, 223, 197, 101, 160, 34, 164, 9, 175, 6, 61, 83, 101, 187, 87, 191, 116, 217, 82, 143, 73, 75, 250, 68, 0, 245, 61, 131, 73, 184, 15, 218, 228, 64, 130, 215, 249, 84, 30, 29, 186, 43, 0, 59, 207, 236, 157, 13, 83, 120, 28, 166, 118, 101, 31]

bip39.validateMnemonic(mnemonic)
// => true

bip39.validateMnemonic('basket actual')
// => false
import 'package:bip39/bip39.dart' as bip39;

main() {
    // Only support BIP39 English word list
    // uses HEX strings for entropy
    String randomMnemonic = await bip39.generateMnemonic();

    String seed = bip39.mnemonicToSeedHex("update elbow source spin squeeze horror world become oak assist bomb nuclear");
    // => '77e6a9b1236d6b53eaa64e2727b5808a55ce09eb899e1938ed55ef5d4f8153170a2c8f4674eb94ce58be7b75922e48e6e56582d806253bd3d72f4b3d896738a4'
    
    String mnemonic = await bip39.entropyToMnemonic('00000000000000000000000000000000');
    // => 'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about'
    
    bool isValid = await bip39.validateMnemonic(mnemonic);
    // => true
    
    isValid = await bip39.validateMnemonic('basket actual');
    // => false
    
    String entropy = bip39.mnemonicToEntropy(mnemonic)
    // => String '00000000000000000000000000000000'
}

1.0.0 #

  • Initial version, created by anicdh

1.0.1 & 1.0.2 #

  • Refactor code to use with Flutter

1.0.3 #

  • Remove async function

example/bip39_example.dart

import 'package:bip39/bip39.dart' as bip39;

main() async {
  String randomMnemonic = bip39.generateMnemonic();
  print(randomMnemonic);
  String seed = bip39.mnemonicToSeedHex("update elbow source spin squeeze horror world become oak assist bomb nuclear");
  print(seed);
  String mnemonic = bip39.entropyToMnemonic('00000000000000000000000000000000');
  print(mnemonic);
  bool isValid = bip39.validateMnemonic(mnemonic);
  print(isValid);
  isValid = bip39.validateMnemonic('basket actual');
  print(isValid);
  String entropy = bip39.mnemonicToEntropy(mnemonic);
  print(entropy);
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  bip39: ^1.0.3

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:bip39/bip39.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
85
Health:
Code health derived from static analysis. [more]
95
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
51
Overall:
Weighted score of the above. [more]
81
Learn more about scoring.

We analyzed this package on Apr 8, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6

Health suggestions

Fix lib/src/bip39_base.dart. (-2.48 points)

Analysis of lib/src/bip39_base.dart reported 5 hints:

line 1 col 8: Unused import: 'dart:async'.

line 70 col 17: Unnecessary new keyword.

line 80 col 18: Unnecessary new keyword.

line 99 col 11: Unnecessary new keyword.

line 106 col 15: Unnecessary new keyword.

Fix lib/src/utils/pbkdf2.dart. (-2.48 points)

Analysis of lib/src/utils/pbkdf2.dart reported 5 hints:

line 22 col 5: Unnecessary new keyword.

line 22 col 28: Unnecessary new keyword.

line 22 col 37: Unnecessary new keyword.

line 23 col 14: Unnecessary new keyword.

line 27 col 31: Unnecessary new keyword.

Maintenance suggestions

Package is getting outdated. (-49.04 points)

The package was last published 77 weeks ago.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.58.0 <3.0.0
crypto ^2.0.3 2.1.4
hex ^0.1.2 0.1.2
pointycastle ^1.0.0-rc2 1.0.2
Transitive dependencies
charcode 1.1.3
collection 1.14.12
convert 2.1.1
typed_data 1.1.6
Dev dependencies
test ^1.0.0