3 // mnemonics is populated as required by getLanguage
4 var mnemonics
= { "english": new Mnemonic("english") };
5 var mnemonic
= mnemonics
["english"];
7 var bip32RootKey
= null;
8 var bip32ExtendedKey
= null;
9 var network
= bitcoin
.networks
.bitcoin
;
10 var addressRowTemplate
= $("#address-row-template");
13 var showAddress
= true;
14 var showPubKey
= true;
15 var showPrivKey
= true;
17 var entropyChangeTimeoutEvent
= null;
18 var phraseChangeTimeoutEvent
= null;
19 var rootKeyChangedTimeoutEvent
= null;
22 DOM
.network
= $(".network");
23 DOM
.phraseNetwork
= $("#network-phrase");
24 DOM
.useEntropy
= $(".use-entropy");
25 DOM
.entropyContainer
= $(".entropy-container");
26 DOM
.entropy
= $(".entropy");
27 DOM
.entropyError
= $(".entropy-error");
28 DOM
.phrase
= $(".phrase");
29 DOM
.passphrase
= $(".passphrase");
30 DOM
.generateContainer
= $(".generate-container");
31 DOM
.generate
= $(".generate");
32 DOM
.seed
= $(".seed");
33 DOM
.rootKey
= $(".root-key");
34 DOM
.extendedPrivKey
= $(".extended-priv-key");
35 DOM
.extendedPubKey
= $(".extended-pub-key");
36 DOM
.bip32tab
= $("#bip32-tab");
37 DOM
.bip44tab
= $("#bip44-tab");
38 DOM
.bip32panel
= $("#bip32");
39 DOM
.bip44panel
= $("#bip44");
40 DOM
.bip32path
= $("#bip32-path");
41 DOM
.bip44path
= $("#bip44-path");
42 DOM
.bip44purpose
= $("#bip44 .purpose");
43 DOM
.bip44coin
= $("#bip44 .coin");
44 DOM
.bip44account
= $("#bip44 .account");
45 DOM
.bip44change
= $("#bip44 .change");
46 DOM
.strength
= $(".strength");
47 DOM
.hardenedAddresses
= $(".hardened-addresses");
48 DOM
.addresses
= $(".addresses");
49 DOM
.rowsToAdd
= $(".rows-to-add");
50 DOM
.more
= $(".more");
51 DOM
.feedback
= $(".feedback");
52 DOM
.tab
= $(".derivation-type a");
53 DOM
.indexToggle
= $(".index-toggle");
54 DOM
.addressToggle
= $(".address-toggle");
55 DOM
.publicKeyToggle
= $(".public-key-toggle");
56 DOM
.privateKeyToggle
= $(".private-key-toggle");
57 DOM
.languages
= $(".languages a");
61 DOM
.network
.on("change", networkChanged
);
62 DOM
.useEntropy
.on("change", setEntropyVisibility
);
63 DOM
.entropy
.on("input", delayedEntropyChanged
);
64 DOM
.phrase
.on("input", delayedPhraseChanged
);
65 DOM
.passphrase
.on("input", delayedPhraseChanged
);
66 DOM
.generate
.on("click", generateClicked
);
67 DOM
.more
.on("click", showMore
);
68 DOM
.rootKey
.on("input", delayedRootKeyChanged
);
69 DOM
.bip32path
.on("input", calcForDerivationPath
);
70 DOM
.bip44purpose
.on("input", calcForDerivationPath
);
71 DOM
.bip44coin
.on("input", calcForDerivationPath
);
72 DOM
.bip44account
.on("input", calcForDerivationPath
);
73 DOM
.bip44change
.on("input", calcForDerivationPath
);
74 DOM
.tab
.on("shown.bs.tab", calcForDerivationPath
);
75 DOM
.hardenedAddresses
.on("change", calcForDerivationPath
);
76 DOM
.indexToggle
.on("click", toggleIndexes
);
77 DOM
.addressToggle
.on("click", toggleAddresses
);
78 DOM
.publicKeyToggle
.on("click", togglePublicKeys
);
79 DOM
.privateKeyToggle
.on("click", togglePrivateKeys
);
80 DOM
.languages
.on("click", languageChanged
);
83 hideValidationError();
84 populateNetworkSelect();
89 function networkChanged(e
) {
90 var networkIndex
= e
.target
.value
;
91 networks
[networkIndex
].onSelect();
100 function setEntropyVisibility() {
101 if (isUsingOwnEntropy()) {
102 DOM
.entropyContainer
.removeClass("hidden");
103 DOM
.generateContainer
.addClass("hidden");
104 DOM
.phrase
.prop("readonly", true);
109 DOM
.entropyContainer
.addClass("hidden");
110 DOM
.generateContainer
.removeClass("hidden");
111 DOM
.phrase
.prop("readonly", false);
116 function delayedPhraseChanged() {
117 hideValidationError();
119 if (phraseChangeTimeoutEvent
!= null) {
120 clearTimeout(phraseChangeTimeoutEvent
);
122 phraseChangeTimeoutEvent
= setTimeout(phraseChanged
, 400);
125 function phraseChanged() {
127 hideValidationError();
128 setMnemonicLanguage();
129 // Get the mnemonic phrase
130 var phrase
= DOM
.phrase
.val();
131 var errorText
= findPhraseErrors(phrase
);
133 showValidationError(errorText
);
136 // Calculate and display
137 var passphrase
= DOM
.passphrase
.val();
138 calcBip32RootKeyFromSeed(phrase
, passphrase
);
139 calcForDerivationPath();
143 function delayedEntropyChanged() {
144 hideValidationError();
146 if (entropyChangeTimeoutEvent
!= null) {
147 clearTimeout(entropyChangeTimeoutEvent
);
149 entropyChangeTimeoutEvent
= setTimeout(entropyChanged
, 400);
152 function entropyChanged() {
153 // If blank entropy, clear mnemonic, addresses, errors
154 if (DOM
.entropy
.val().trim().length
== 0) {
158 showValidationError("Blank entropy");
161 // Get the current phrase to detect changes
162 var phrase
= DOM
.phrase
.val();
163 // Set the phrase from the entropy
164 setMnemonicFromEntropy();
165 // Recalc addresses if the phrase has changed
166 var newPhrase
= DOM
.phrase
.val();
167 if (newPhrase
!= phrase
) {
168 if (newPhrase
.length
== 0) {
180 function delayedRootKeyChanged() {
181 // Warn if there is an existing mnemonic or passphrase.
182 if (DOM
.phrase
.val().length
> 0 || DOM
.passphrase
.val().length
> 0) {
183 if (!confirm("This will clear existing mnemonic and passphrase")) {
184 DOM
.rootKey
.val(bip32RootKey
);
188 hideValidationError();
190 // Clear existing mnemonic and passphrase
192 DOM
.passphrase
.val("");
194 if (rootKeyChangedTimeoutEvent
!= null) {
195 clearTimeout(rootKeyChangedTimeoutEvent
);
197 rootKeyChangedTimeoutEvent
= setTimeout(rootKeyChanged
, 400);
200 function rootKeyChanged() {
202 hideValidationError();
203 // Validate the root key TODO
204 var rootKeyBase58
= DOM
.rootKey
.val();
205 var errorText
= validateRootKey(rootKeyBase58
);
207 showValidationError(errorText
);
210 // Calculate and display
211 calcBip32RootKeyFromBase58(rootKeyBase58
);
212 calcForDerivationPath();
216 function calcForDerivationPath() {
218 hideValidationError();
219 // Get the derivation path
220 var derivationPath
= getDerivationPath();
221 var errorText
= findDerivationPathErrors(derivationPath
);
223 showValidationError(errorText
);
226 calcBip32ExtendedKey(derivationPath
);
231 function generateClicked() {
232 if (isUsingOwnEntropy()) {
237 setTimeout(function() {
238 setMnemonicLanguage();
239 var phrase
= generateRandomPhrase();
247 function languageChanged() {
248 setTimeout(function() {
249 setMnemonicLanguage();
250 if (DOM
.phrase
.val().length
> 0) {
251 var newPhrase
= convertPhraseToNewLanguage();
252 DOM
.phrase
.val(newPhrase
);
256 DOM
.generate
.trigger("click");
261 function toggleIndexes() {
262 showIndex
= !showIndex
;
263 $("td.index span").toggleClass("invisible");
266 function toggleAddresses() {
267 showAddress
= !showAddress
;
268 $("td.address span").toggleClass("invisible");
271 function togglePublicKeys() {
272 showPubKey
= !showPubKey
;
273 $("td.pubkey span").toggleClass("invisible");
276 function togglePrivateKeys() {
277 showPrivKey
= !showPrivKey
;
278 $("td.privkey span").toggleClass("invisible");
283 function generateRandomPhrase() {
284 if (!hasStrongRandom()) {
285 var errorText
= "This browser does not support strong randomness";
286 showValidationError(errorText
);
289 var numWords
= parseInt(DOM
.strength
.val());
290 var strength
= numWords
/ 3 * 32;
291 var words
= mnemonic
.generate(strength
);
292 DOM
.phrase
.val(words
);
296 function calcBip32RootKeyFromSeed(phrase
, passphrase
) {
297 seed
= mnemonic
.toSeed(phrase
, passphrase
);
298 bip32RootKey
= bitcoin
.HDNode
.fromSeedHex(seed
, network
);
301 function calcBip32RootKeyFromBase58(rootKeyBase58
) {
302 bip32RootKey
= bitcoin
.HDNode
.fromBase58(rootKeyBase58
, network
);
305 function calcBip32ExtendedKey(path
) {
306 bip32ExtendedKey
= bip32RootKey
;
307 // Derive the key from the path
308 var pathBits
= path
.split("/");
309 for (var i
=0; i
<pathBits
.length
; i
++) {
310 var bit
= pathBits
[i
];
311 var index
= parseInt(bit
);
315 var hardened
= bit
[bit
.length
-1] == "'";
317 bip32ExtendedKey
= bip32ExtendedKey
.deriveHardened(index
);
320 bip32ExtendedKey
= bip32ExtendedKey
.derive(index
);
325 function showValidationError(errorText
) {
331 function hideValidationError() {
337 function findPhraseErrors(phrase
) {
338 // Preprocess the words
339 phrase
= mnemonic
.normalizeString(phrase
);
340 var words
= phraseToWordArray(phrase
);
341 // Detect blank phrase
342 if (words
.length
== 0) {
343 return "Blank mnemonic";
346 for (var i
=0; i
<words
.length
; i
++) {
348 var language
= getLanguage();
349 if (WORDLISTS
[language
].indexOf(word
) == -1) {
350 console
.log("Finding closest match to " + word
);
351 var nearestWord
= findNearestWord(word
);
352 return word
+ " not in wordlist, did you mean " + nearestWord
+ "?";
355 // Check the words are valid
356 var properPhrase
= wordArrayToPhrase(words
);
357 var isValid
= mnemonic
.check(properPhrase
);
359 return "Invalid mnemonic";
364 function validateRootKey(rootKeyBase58
) {
366 bitcoin
.HDNode
.fromBase58(rootKeyBase58
);
369 return "Invalid root key";
374 function getDerivationPath() {
375 if (DOM
.bip44tab
.hasClass("active")) {
376 var purpose
= parseIntNoNaN(DOM
.bip44purpose
.val(), 44);
377 var coin
= parseIntNoNaN(DOM
.bip44coin
.val(), 0);
378 var account
= parseIntNoNaN(DOM
.bip44account
.val(), 0);
379 var change
= parseIntNoNaN(DOM
.bip44change
.val(), 0);
381 path
+= purpose
+ "'/";
383 path
+= account
+ "'/";
385 DOM
.bip44path
.val(path
);
386 var derivationPath
= DOM
.bip44path
.val();
387 console
.log("Using derivation path from BIP44 tab: " + derivationPath
);
388 return derivationPath
;
390 else if (DOM
.bip32tab
.hasClass("active")) {
391 var derivationPath
= DOM
.bip32path
.val();
392 console
.log("Using derivation path from BIP32 tab: " + derivationPath
);
393 return derivationPath
;
396 console
.log("Unknown derivation path");
400 function findDerivationPathErrors(path
) {
401 // TODO is not perfect but is better than nothing
403 // https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#test-vectors
405 // https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#extended-keys
406 var maxDepth
= 255; // TODO verify this!!
407 var maxIndexValue
= Math
.pow(2, 31); // TODO verify this!!
408 if (path
[0] != "m") {
409 return "First character must be 'm'";
411 if (path
.length
> 1) {
412 if (path
[1] != "/") {
413 return "Separator must be '/'";
415 var indexes
= path
.split("/");
416 if (indexes
.length
> maxDepth
) {
417 return "Derivation depth is " + indexes
.length
+ ", must be less than " + maxDepth
;
419 for (var depth
= 1; depth
<indexes
.length
; depth
++) {
420 var index
= indexes
[depth
];
421 var invalidChars
= index
.replace(/^[0-9]+'?$/g, "")
422 if (invalidChars
.length
> 0) {
423 return "Invalid characters " + invalidChars
+ " found at depth " + depth
;
425 var indexValue
= parseInt(index
.replace("'", ""));
427 return "Invalid number at depth " + depth
;
429 if (indexValue
> maxIndexValue
) {
430 return "Value of " + indexValue
+ " at depth " + depth
+ " must be less than " + maxIndexValue
;
437 function displayBip32Info() {
440 var rootKey
= bip32RootKey
.toBase58();
441 DOM
.rootKey
.val(rootKey
);
442 var extendedPrivKey
= bip32ExtendedKey
.toBase58();
443 DOM
.extendedPrivKey
.val(extendedPrivKey
);
444 var extendedPubKey
= bip32ExtendedKey
.toBase58(false);
445 DOM
.extendedPubKey
.val(extendedPubKey
);
446 // Display the addresses and privkeys
447 clearAddressesList();
448 displayAddresses(0, 20);
451 function displayAddresses(start
, total
) {
452 for (var i
=0; i
<total
; i
++) {
453 var index
= i
+ start
;
458 function TableRow(index
) {
460 var useHardenedAddresses
= DOM
.hardenedAddresses
.prop("checked");
466 function calculateValues() {
467 setTimeout(function() {
469 if (useHardenedAddresses
) {
470 key
= bip32ExtendedKey
.deriveHardened(index
);
473 key
= bip32ExtendedKey
.derive(index
);
475 var address
= key
.getAddress().toString();
476 var privkey
= key
.privKey
.toWIF(network
);
477 var pubkey
= key
.pubKey
.toHex();
478 var indexText
= getDerivationPath() + "/" + index
;
479 if (useHardenedAddresses
) {
480 indexText
= indexText
+ "'";
482 addAddressToList(indexText
, address
, pubkey
, privkey
);
490 function showMore() {
491 var start
= DOM
.addresses
.children().length
;
492 var rowsToAdd
= parseInt(DOM
.rowsToAdd
.val());
493 if (isNaN(rowsToAdd
)) {
495 DOM
.rowsToAdd
.val("20");
497 if (rowsToAdd
> 200) {
498 var msg
= "Generating " + rowsToAdd
+ " rows could take a while. ";
499 msg
+= "Do you want to continue?";
504 displayAddresses(start
, rowsToAdd
);
507 function clearDisplay() {
508 clearAddressesList();
510 hideValidationError();
513 function clearAddressesList() {
514 DOM
.addresses
.empty();
517 function clearKey() {
519 DOM
.extendedPrivKey
.val("");
520 DOM
.extendedPubKey
.val("");
523 function addAddressToList(indexText
, address
, pubkey
, privkey
) {
524 var row
= $(addressRowTemplate
.html());
526 var indexCell
= row
.find(".index span");
527 var addressCell
= row
.find(".address span");
528 var pubkeyCell
= row
.find(".pubkey span");
529 var privkeyCell
= row
.find(".privkey span");
531 indexCell
.text(indexText
);
532 addressCell
.text(address
);
533 pubkeyCell
.text(pubkey
);
534 privkeyCell
.text(privkey
);
537 indexCell
.addClass("invisible");
540 addressCell
.addClass("invisible");
543 pubkeyCell
.addClass("invisible");
546 privkeyCell
.addClass("invisible");
548 DOM
.addresses
.append(row
);
551 function hasStrongRandom() {
552 return 'crypto' in window
&& window
['crypto'] !== null;
555 function disableForms() {
556 $("form").on("submit", function(e
) {
561 function parseIntNoNaN(val
, defaultVal
) {
562 var v
= parseInt(val
);
569 function showPending() {
571 .text("Calculating...")
575 function findNearestWord(word
) {
576 var language
= getLanguage();
577 var words
= WORDLISTS
[language
];
578 var minDistance
= 99;
579 var closestWord
= words
[0];
580 for (var i
=0; i
<words
.length
; i
++) {
581 var comparedTo
= words
[i
];
582 var distance
= Levenshtein
.get(word
, comparedTo
);
583 if (distance
< minDistance
) {
584 closestWord
= comparedTo
;
585 minDistance
= distance
;
591 function hidePending() {
597 function populateNetworkSelect() {
598 for (var i
=0; i
<networks
.length
; i
++) {
599 var network
= networks
[i
];
600 var option
= $("<option>");
601 option
.attr("value", i
);
602 option
.text(network
.name
);
603 DOM
.phraseNetwork
.append(option
);
607 function getLanguage() {
608 var defaultLanguage
= "english";
609 // Try to get from existing phrase
610 var language
= getLanguageFromPhrase();
611 // Try to get from url if not from phrase
612 if (language
.length
== 0) {
613 language
= getLanguageFromUrl();
615 // Default to English if no other option
616 if (language
.length
== 0) {
617 language
= defaultLanguage
;
622 function getLanguageFromPhrase(phrase
) {
623 // Check if how many words from existing phrase match a language.
626 phrase
= DOM
.phrase
.val();
628 if (phrase
.length
> 0) {
629 var words
= phraseToWordArray(phrase
);
630 var languageMatches
= {};
631 for (l
in WORDLISTS
) {
632 // Track how many words match in this language
633 languageMatches
[l
] = 0;
634 for (var i
=0; i
<words
.length
; i
++) {
635 var wordInLanguage
= WORDLISTS
[l
].indexOf(words
[i
]) > -1;
636 if (wordInLanguage
) {
637 languageMatches
[l
]++;
640 // Find languages with most word matches.
641 // This is made difficult due to commonalities between Chinese
642 // simplified vs traditional.
644 var mostMatchedLanguages
= [];
645 for (var l
in languageMatches
) {
646 var numMatches
= languageMatches
[l
];
647 if (numMatches
> mostMatches
) {
648 mostMatches
= numMatches
;
649 mostMatchedLanguages
= [l
];
651 else if (numMatches
== mostMatches
) {
652 mostMatchedLanguages
.push(l
);
656 if (mostMatchedLanguages
.length
> 0) {
657 // Use first language and warn if multiple detected
658 language
= mostMatchedLanguages
[0];
659 if (mostMatchedLanguages
.length
> 1) {
660 console
.warn("Multiple possible languages");
661 console
.warn(mostMatchedLanguages
);
668 function getLanguageFromUrl() {
669 for (var language
in WORDLISTS
) {
670 if (window
.location
.hash
.indexOf(language
) > -1) {
677 function setMnemonicLanguage() {
678 var language
= getLanguage();
679 // Load the bip39 mnemonic generator for this language if required
680 if (!(language
in mnemonics
)) {
681 mnemonics
[language
] = new Mnemonic(language
);
683 mnemonic
= mnemonics
[language
];
686 function convertPhraseToNewLanguage() {
687 var oldLanguage
= getLanguageFromPhrase();
688 var newLanguage
= getLanguageFromUrl();
689 var oldPhrase
= DOM
.phrase
.val();
690 var oldWords
= phraseToWordArray(oldPhrase
);
692 for (var i
=0; i
<oldWords
.length
; i
++) {
693 var oldWord
= oldWords
[i
];
694 var index
= WORDLISTS
[oldLanguage
].indexOf(oldWord
);
695 var newWord
= WORDLISTS
[newLanguage
][index
];
696 newWords
.push(newWord
);
698 newPhrase
= wordArrayToPhrase(newWords
);
702 // TODO look at jsbip39 - mnemonic.splitWords
703 function phraseToWordArray(phrase
) {
704 var words
= phrase
.split(/\s/g);
706 for (var i
=0; i
<words
.length
; i
++) {
708 if (word
.length
> 0) {
715 // TODO look at jsbip39 - mnemonic.joinWords
716 function wordArrayToPhrase(words
) {
717 var phrase
= words
.join(" ");
718 var language
= getLanguageFromPhrase(phrase
);
719 if (language
== "japanese") {
720 phrase
= words
.join("\u3000");
725 function isUsingOwnEntropy() {
726 return DOM
.useEntropy
.prop("checked");
729 function setMnemonicFromEntropy() {
732 var entropyStr
= DOM
.entropy
.val();
733 // Work out minimum base for entropy
734 var entropy
= Entropy
.fromString(entropyStr
);
735 if (entropy
.binaryStr
.length
== 0) {
738 // Show entropy details
739 var extraBits
= 32 - (entropy
.binaryStr
.length
% 32);
740 var extraChars
= Math
.ceil(extraBits
* Math
.log(2) / Math
.log(entropy
.base
.asInt
));
741 var words
= Math
.floor(entropy
.binaryStr
.length
/ 32) * 3;
742 var strength
= "an extremely weak";
744 strength
= "a very weak";
750 strength
= "a strong";
753 strength
= "a very strong";
756 strength
= "an extremely strong";
759 strength
= "an even stronger"
761 var msg
= "Have " + entropy
.binaryStr
.length
+ " bits of entropy, " + extraChars
+ " more " + entropy
.base
.str
+ " chars required to generate " + strength
+ " mnemonic: " + entropy
.cleanStr
;
762 showEntropyError(msg
);
763 // Discard trailing entropy
764 var bitsToUse
= Math
.floor(entropy
.binaryStr
.length
/ 32) * 32;
765 var binaryStr
= entropy
.binaryStr
.substring(0, bitsToUse
);
766 // Convert entropy string to numeric array
768 for (var i
=0; i
<binaryStr
.length
/ 8; i
++) {
769 var byteAsBits
= binaryStr
.substring(i
*8, i
*8+8);
770 var entropyByte
= parseInt(byteAsBits
, 2);
771 entropyArr
.push(entropyByte
)
773 // Convert entropy array to mnemonic
774 var phrase
= mnemonic
.toMnemonic(entropyArr
);
775 // Set the mnemonic in the UI
776 DOM
.phrase
.val(phrase
);
779 function hideEntropyError() {
780 DOM
.entropyError
.addClass("hidden");
783 function showEntropyError(msg
) {
784 DOM
.entropyError
.text(msg
);
785 DOM
.entropyError
.removeClass("hidden");
791 onSelect: function() {
792 network
= bitcoin
.networks
.bitcoin
;
793 DOM
.bip44coin
.val(0);
797 name: "Bitcoin Testnet",
798 onSelect: function() {
799 network
= bitcoin
.networks
.testnet
;
800 DOM
.bip44coin
.val(1);
805 onSelect: function() {
806 network
= bitcoin
.networks
.litecoin
;
807 DOM
.bip44coin
.val(2);
812 onSelect: function() {
813 network
= bitcoin
.networks
.dogecoin
;
814 DOM
.bip44coin
.val(3);
819 onSelect: function() {
820 network
= bitcoin
.networks
.shadow
;
821 DOM
.bip44coin
.val(35);
825 name: "ShadowCash Testnet",
826 onSelect: function() {
827 network
= bitcoin
.networks
.shadowtn
;
828 DOM
.bip44coin
.val(1);
833 onSelect: function() {
834 network
= bitcoin
.networks
.viacoin
;
835 DOM
.bip44coin
.val(14);
839 name: "Viacoin Testnet",
840 onSelect: function() {
841 network
= bitcoin
.networks
.viacointestnet
;
842 DOM
.bip44coin
.val(1);
847 onSelect: function() {
848 network
= bitcoin
.networks
.jumbucks
;
849 DOM
.bip44coin
.val(26);
854 onSelect: function() {
855 network
= bitcoin
.networks
.clam
;
856 DOM
.bip44coin
.val(23);
861 onSelect: function() {
862 network
= bitcoin
.networks
.dash
;
863 DOM
.bip44coin
.val(5);
868 onSelect: function() {
869 network
= bitcoin
.networks
.namecoin
;
870 DOM
.bip44coin
.val(7);
875 onSelect: function() {
876 network
= bitcoin
.networks
.peercoin
;
877 DOM
.bip44coin
.val(6);