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);
115 function delayedPhraseChanged() {
116 hideValidationError();
118 if (phraseChangeTimeoutEvent
!= null) {
119 clearTimeout(phraseChangeTimeoutEvent
);
121 phraseChangeTimeoutEvent
= setTimeout(phraseChanged
, 400);
124 function phraseChanged() {
126 hideValidationError();
127 setMnemonicLanguage();
128 // Get the mnemonic phrase
129 var phrase
= DOM
.phrase
.val();
130 var errorText
= findPhraseErrors(phrase
);
132 showValidationError(errorText
);
135 // Calculate and display
136 var passphrase
= DOM
.passphrase
.val();
137 calcBip32RootKeyFromSeed(phrase
, passphrase
);
138 calcForDerivationPath();
142 function delayedEntropyChanged() {
143 hideValidationError();
145 if (entropyChangeTimeoutEvent
!= null) {
146 clearTimeout(entropyChangeTimeoutEvent
);
148 entropyChangeTimeoutEvent
= setTimeout(entropyChanged
, 400);
151 function entropyChanged() {
152 setMnemonicFromEntropy();
156 function delayedRootKeyChanged() {
157 // Warn if there is an existing mnemonic or passphrase.
158 if (DOM
.phrase
.val().length
> 0 || DOM
.passphrase
.val().length
> 0) {
159 if (!confirm("This will clear existing mnemonic and passphrase")) {
160 DOM
.rootKey
.val(bip32RootKey
);
164 hideValidationError();
166 // Clear existing mnemonic and passphrase
168 DOM
.passphrase
.val("");
170 if (rootKeyChangedTimeoutEvent
!= null) {
171 clearTimeout(rootKeyChangedTimeoutEvent
);
173 rootKeyChangedTimeoutEvent
= setTimeout(rootKeyChanged
, 400);
176 function rootKeyChanged() {
178 hideValidationError();
179 // Validate the root key TODO
180 var rootKeyBase58
= DOM
.rootKey
.val();
181 var errorText
= validateRootKey(rootKeyBase58
);
183 showValidationError(errorText
);
186 // Calculate and display
187 calcBip32RootKeyFromBase58(rootKeyBase58
);
188 calcForDerivationPath();
192 function calcForDerivationPath() {
194 hideValidationError();
195 // Get the derivation path
196 var derivationPath
= getDerivationPath();
197 var errorText
= findDerivationPathErrors(derivationPath
);
199 showValidationError(errorText
);
202 calcBip32ExtendedKey(derivationPath
);
207 function generateClicked() {
208 if (isUsingOwnEntropy()) {
213 setTimeout(function() {
214 setMnemonicLanguage();
215 var phrase
= generateRandomPhrase();
223 function languageChanged() {
224 setTimeout(function() {
225 setMnemonicLanguage();
226 if (DOM
.phrase
.val().length
> 0) {
227 var newPhrase
= convertPhraseToNewLanguage();
228 DOM
.phrase
.val(newPhrase
);
232 DOM
.generate
.trigger("click");
237 function toggleIndexes() {
238 showIndex
= !showIndex
;
239 $("td.index span").toggleClass("invisible");
242 function toggleAddresses() {
243 showAddress
= !showAddress
;
244 $("td.address span").toggleClass("invisible");
247 function togglePublicKeys() {
248 showPubKey
= !showPubKey
;
249 $("td.pubkey span").toggleClass("invisible");
252 function togglePrivateKeys() {
253 showPrivKey
= !showPrivKey
;
254 $("td.privkey span").toggleClass("invisible");
259 function generateRandomPhrase() {
260 if (!hasStrongRandom()) {
261 var errorText
= "This browser does not support strong randomness";
262 showValidationError(errorText
);
265 var numWords
= parseInt(DOM
.strength
.val());
266 var strength
= numWords
/ 3 * 32;
267 var words
= mnemonic
.generate(strength
);
268 DOM
.phrase
.val(words
);
272 function calcBip32RootKeyFromSeed(phrase
, passphrase
) {
273 seed
= mnemonic
.toSeed(phrase
, passphrase
);
274 bip32RootKey
= bitcoin
.HDNode
.fromSeedHex(seed
, network
);
277 function calcBip32RootKeyFromBase58(rootKeyBase58
) {
278 bip32RootKey
= bitcoin
.HDNode
.fromBase58(rootKeyBase58
, network
);
281 function calcBip32ExtendedKey(path
) {
282 bip32ExtendedKey
= bip32RootKey
;
283 // Derive the key from the path
284 var pathBits
= path
.split("/");
285 for (var i
=0; i
<pathBits
.length
; i
++) {
286 var bit
= pathBits
[i
];
287 var index
= parseInt(bit
);
291 var hardened
= bit
[bit
.length
-1] == "'";
293 bip32ExtendedKey
= bip32ExtendedKey
.deriveHardened(index
);
296 bip32ExtendedKey
= bip32ExtendedKey
.derive(index
);
301 function showValidationError(errorText
) {
307 function hideValidationError() {
313 function findPhraseErrors(phrase
) {
314 // TODO make this right
315 // Preprocess the words
316 phrase
= mnemonic
.normalizeString(phrase
);
317 var words
= phraseToWordArray(phrase
);
319 for (var i
=0; i
<words
.length
; i
++) {
321 var language
= getLanguage();
322 if (WORDLISTS
[language
].indexOf(word
) == -1) {
323 console
.log("Finding closest match to " + word
);
324 var nearestWord
= findNearestWord(word
);
325 return word
+ " not in wordlist, did you mean " + nearestWord
+ "?";
328 // Check the words are valid
329 var properPhrase
= wordArrayToPhrase(words
);
330 var isValid
= mnemonic
.check(properPhrase
);
332 return "Invalid mnemonic";
337 function validateRootKey(rootKeyBase58
) {
339 bitcoin
.HDNode
.fromBase58(rootKeyBase58
);
342 return "Invalid root key";
347 function getDerivationPath() {
348 if (DOM
.bip44tab
.hasClass("active")) {
349 var purpose
= parseIntNoNaN(DOM
.bip44purpose
.val(), 44);
350 var coin
= parseIntNoNaN(DOM
.bip44coin
.val(), 0);
351 var account
= parseIntNoNaN(DOM
.bip44account
.val(), 0);
352 var change
= parseIntNoNaN(DOM
.bip44change
.val(), 0);
354 path
+= purpose
+ "'/";
356 path
+= account
+ "'/";
358 DOM
.bip44path
.val(path
);
359 var derivationPath
= DOM
.bip44path
.val();
360 console
.log("Using derivation path from BIP44 tab: " + derivationPath
);
361 return derivationPath
;
363 else if (DOM
.bip32tab
.hasClass("active")) {
364 var derivationPath
= DOM
.bip32path
.val();
365 console
.log("Using derivation path from BIP32 tab: " + derivationPath
);
366 return derivationPath
;
369 console
.log("Unknown derivation path");
373 function findDerivationPathErrors(path
) {
374 // TODO is not perfect but is better than nothing
376 // https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#test-vectors
378 // https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#extended-keys
379 var maxDepth
= 255; // TODO verify this!!
380 var maxIndexValue
= Math
.pow(2, 31); // TODO verify this!!
381 if (path
[0] != "m") {
382 return "First character must be 'm'";
384 if (path
.length
> 1) {
385 if (path
[1] != "/") {
386 return "Separator must be '/'";
388 var indexes
= path
.split("/");
389 if (indexes
.length
> maxDepth
) {
390 return "Derivation depth is " + indexes
.length
+ ", must be less than " + maxDepth
;
392 for (var depth
= 1; depth
<indexes
.length
; depth
++) {
393 var index
= indexes
[depth
];
394 var invalidChars
= index
.replace(/^[0-9]+'?$/g, "")
395 if (invalidChars
.length
> 0) {
396 return "Invalid characters " + invalidChars
+ " found at depth " + depth
;
398 var indexValue
= parseInt(index
.replace("'", ""));
400 return "Invalid number at depth " + depth
;
402 if (indexValue
> maxIndexValue
) {
403 return "Value of " + indexValue
+ " at depth " + depth
+ " must be less than " + maxIndexValue
;
410 function displayBip32Info() {
413 var rootKey
= bip32RootKey
.toBase58();
414 DOM
.rootKey
.val(rootKey
);
415 var extendedPrivKey
= bip32ExtendedKey
.toBase58();
416 DOM
.extendedPrivKey
.val(extendedPrivKey
);
417 var extendedPubKey
= bip32ExtendedKey
.toBase58(false);
418 DOM
.extendedPubKey
.val(extendedPubKey
);
419 // Display the addresses and privkeys
420 clearAddressesList();
421 displayAddresses(0, 20);
424 function displayAddresses(start
, total
) {
425 for (var i
=0; i
<total
; i
++) {
426 var index
= i
+ start
;
431 function TableRow(index
) {
433 var useHardenedAddresses
= DOM
.hardenedAddresses
.prop("checked");
439 function calculateValues() {
440 setTimeout(function() {
442 if (useHardenedAddresses
) {
443 key
= bip32ExtendedKey
.deriveHardened(index
);
446 key
= bip32ExtendedKey
.derive(index
);
448 var address
= key
.getAddress().toString();
449 var privkey
= key
.privKey
.toWIF(network
);
450 var pubkey
= key
.pubKey
.toHex();
451 var indexText
= getDerivationPath() + "/" + index
;
452 if (useHardenedAddresses
) {
453 indexText
= indexText
+ "'";
455 addAddressToList(indexText
, address
, pubkey
, privkey
);
463 function showMore() {
464 var start
= DOM
.addresses
.children().length
;
465 var rowsToAdd
= parseInt(DOM
.rowsToAdd
.val());
466 if (isNaN(rowsToAdd
)) {
468 DOM
.rowsToAdd
.val("20");
470 if (rowsToAdd
> 200) {
471 var msg
= "Generating " + rowsToAdd
+ " rows could take a while. ";
472 msg
+= "Do you want to continue?";
477 displayAddresses(start
, rowsToAdd
);
480 function clearDisplay() {
481 clearAddressesList();
483 hideValidationError();
486 function clearAddressesList() {
487 DOM
.addresses
.empty();
490 function clearKey() {
492 DOM
.extendedPrivKey
.val("");
493 DOM
.extendedPubKey
.val("");
496 function addAddressToList(indexText
, address
, pubkey
, privkey
) {
497 var row
= $(addressRowTemplate
.html());
499 var indexCell
= row
.find(".index span");
500 var addressCell
= row
.find(".address span");
501 var pubkeyCell
= row
.find(".pubkey span");
502 var privkeyCell
= row
.find(".privkey span");
504 indexCell
.text(indexText
);
505 addressCell
.text(address
);
506 pubkeyCell
.text(pubkey
);
507 privkeyCell
.text(privkey
);
510 indexCell
.addClass("invisible");
513 addressCell
.addClass("invisible");
516 pubkeyCell
.addClass("invisible");
519 privkeyCell
.addClass("invisible");
521 DOM
.addresses
.append(row
);
524 function hasStrongRandom() {
525 return 'crypto' in window
&& window
['crypto'] !== null;
528 function disableForms() {
529 $("form").on("submit", function(e
) {
534 function parseIntNoNaN(val
, defaultVal
) {
535 var v
= parseInt(val
);
542 function showPending() {
544 .text("Calculating...")
548 function findNearestWord(word
) {
549 var language
= getLanguage();
550 var words
= WORDLISTS
[language
];
551 var minDistance
= 99;
552 var closestWord
= words
[0];
553 for (var i
=0; i
<words
.length
; i
++) {
554 var comparedTo
= words
[i
];
555 var distance
= Levenshtein
.get(word
, comparedTo
);
556 if (distance
< minDistance
) {
557 closestWord
= comparedTo
;
558 minDistance
= distance
;
564 function hidePending() {
570 function populateNetworkSelect() {
571 for (var i
=0; i
<networks
.length
; i
++) {
572 var network
= networks
[i
];
573 var option
= $("<option>");
574 option
.attr("value", i
);
575 option
.text(network
.name
);
576 DOM
.phraseNetwork
.append(option
);
580 function getLanguage() {
581 var defaultLanguage
= "english";
582 // Try to get from existing phrase
583 var language
= getLanguageFromPhrase();
584 // Try to get from url if not from phrase
585 if (language
.length
== 0) {
586 language
= getLanguageFromUrl();
588 // Default to English if no other option
589 if (language
.length
== 0) {
590 language
= defaultLanguage
;
595 function getLanguageFromPhrase(phrase
) {
596 // Check if how many words from existing phrase match a language.
599 phrase
= DOM
.phrase
.val();
601 if (phrase
.length
> 0) {
602 var words
= phraseToWordArray(phrase
);
603 var languageMatches
= {};
604 for (l
in WORDLISTS
) {
605 // Track how many words match in this language
606 languageMatches
[l
] = 0;
607 for (var i
=0; i
<words
.length
; i
++) {
608 var wordInLanguage
= WORDLISTS
[l
].indexOf(words
[i
]) > -1;
609 if (wordInLanguage
) {
610 languageMatches
[l
]++;
613 // Find languages with most word matches.
614 // This is made difficult due to commonalities between Chinese
615 // simplified vs traditional.
617 var mostMatchedLanguages
= [];
618 for (var l
in languageMatches
) {
619 var numMatches
= languageMatches
[l
];
620 if (numMatches
> mostMatches
) {
621 mostMatches
= numMatches
;
622 mostMatchedLanguages
= [l
];
624 else if (numMatches
== mostMatches
) {
625 mostMatchedLanguages
.push(l
);
629 if (mostMatchedLanguages
.length
> 0) {
630 // Use first language and warn if multiple detected
631 language
= mostMatchedLanguages
[0];
632 if (mostMatchedLanguages
.length
> 1) {
633 console
.warn("Multiple possible languages");
634 console
.warn(mostMatchedLanguages
);
641 function getLanguageFromUrl() {
642 for (var language
in WORDLISTS
) {
643 if (window
.location
.hash
.indexOf(language
) > -1) {
650 function setMnemonicLanguage() {
651 var language
= getLanguage();
652 // Load the bip39 mnemonic generator for this language if required
653 if (!(language
in mnemonics
)) {
654 mnemonics
[language
] = new Mnemonic(language
);
656 mnemonic
= mnemonics
[language
];
659 function convertPhraseToNewLanguage() {
660 var oldLanguage
= getLanguageFromPhrase();
661 var newLanguage
= getLanguageFromUrl();
662 var oldPhrase
= DOM
.phrase
.val();
663 var oldWords
= phraseToWordArray(oldPhrase
);
665 for (var i
=0; i
<oldWords
.length
; i
++) {
666 var oldWord
= oldWords
[i
];
667 var index
= WORDLISTS
[oldLanguage
].indexOf(oldWord
);
668 var newWord
= WORDLISTS
[newLanguage
][index
];
669 newWords
.push(newWord
);
671 newPhrase
= wordArrayToPhrase(newWords
);
675 // TODO look at jsbip39 - mnemonic.splitWords
676 function phraseToWordArray(phrase
) {
677 var words
= phrase
.split(/\s/g);
679 for (var i
=0; i
<words
.length
; i
++) {
681 if (word
.length
> 0) {
688 // TODO look at jsbip39 - mnemonic.joinWords
689 function wordArrayToPhrase(words
) {
690 var phrase
= words
.join(" ");
691 var language
= getLanguageFromPhrase(phrase
);
692 if (language
== "japanese") {
693 phrase
= words
.join("\u3000");
698 function isUsingOwnEntropy() {
699 return DOM
.useEntropy
.prop("checked");
702 function setMnemonicFromEntropy() {
704 // Work out minimum base for entropy
705 var entropyStr
= DOM
.entropy
.val();
706 var entropy
= Entropy
.fromString(entropyStr
);
707 if (entropy
.hexStr
.length
== 0) {
710 // Show entropy details
711 var extraBits
= 32 - (entropy
.binaryStr
.length
% 32);
712 var extraChars
= Math
.ceil(extraBits
* Math
.log(2) / Math
.log(entropy
.base
.asInt
));
713 var strength
= "an extremely weak";
714 if (entropy
.hexStr
.length
>= 8) {
715 strength
= "a very weak";
717 if (entropy
.hexStr
.length
>= 12) {
720 if (entropy
.hexStr
.length
>= 24) {
721 strength
= "a strong";
723 if (entropy
.hexStr
.length
>= 32) {
724 strength
= "a very strong";
726 if (entropy
.hexStr
.length
>= 40) {
727 strength
= "an extremely strong";
729 if (entropy
.hexStr
.length
>=48) {
730 strength
= "an even stronger"
732 var msg
= "Have " + entropy
.binaryStr
.length
+ " bits of entropy, " + extraChars
+ " more " + entropy
.base
.str
+ " chars required to generate " + strength
+ " mnemonic: " + entropy
.cleanStr
;
733 showEntropyError(msg
);
734 // Discard trailing entropy
735 var hexStr
= entropy
.hexStr
.substring(0, Math
.floor(entropy
.hexStr
.length
/ 8) * 8);
736 // Convert entropy string to numeric array
738 for (var i
=0; i
<hexStr
.length
/ 2; i
++) {
739 var entropyByte
= parseInt(hexStr
[i
*2].concat(hexStr
[i
*2+1]), 16);
740 entropyArr
.push(entropyByte
)
742 // Convert entropy array to mnemonic
743 var phrase
= mnemonic
.toMnemonic(entropyArr
);
744 // Set the mnemonic in the UI
745 DOM
.phrase
.val(phrase
);
748 function hideEntropyError() {
749 DOM
.entropyError
.addClass("hidden");
752 function showEntropyError(msg
) {
753 DOM
.entropyError
.text(msg
);
754 DOM
.entropyError
.removeClass("hidden");
760 onSelect: function() {
761 network
= bitcoin
.networks
.bitcoin
;
762 DOM
.bip44coin
.val(0);
766 name: "Bitcoin Testnet",
767 onSelect: function() {
768 network
= bitcoin
.networks
.testnet
;
769 DOM
.bip44coin
.val(1);
774 onSelect: function() {
775 network
= bitcoin
.networks
.litecoin
;
776 DOM
.bip44coin
.val(2);
781 onSelect: function() {
782 network
= bitcoin
.networks
.dogecoin
;
783 DOM
.bip44coin
.val(3);
788 onSelect: function() {
789 network
= bitcoin
.networks
.shadow
;
790 DOM
.bip44coin
.val(35);
794 name: "ShadowCash Testnet",
795 onSelect: function() {
796 network
= bitcoin
.networks
.shadowtn
;
797 DOM
.bip44coin
.val(1);
802 onSelect: function() {
803 network
= bitcoin
.networks
.viacoin
;
804 DOM
.bip44coin
.val(14);
808 name: "Viacoin Testnet",
809 onSelect: function() {
810 network
= bitcoin
.networks
.viacointestnet
;
811 DOM
.bip44coin
.val(1);
816 onSelect: function() {
817 network
= bitcoin
.networks
.jumbucks
;
818 DOM
.bip44coin
.val(26);
823 onSelect: function() {
824 network
= bitcoin
.networks
.clam
;
825 DOM
.bip44coin
.val(23);
830 onSelect: function() {
831 network
= bitcoin
.networks
.dash
;
832 DOM
.bip44coin
.val(5);
837 onSelect: function() {
838 network
= bitcoin
.networks
.namecoin
;
839 DOM
.bip44coin
.val(7);
844 onSelect: function() {
845 network
= bitcoin
.networks
.peercoin
;
846 DOM
.bip44coin
.val(6);