Add BIP85 support

[AndreasGassmann]

Adds support for BIP85 - Deterministic Entropy From BIP32 Keychains.

All applications mentioned in the specs are supported (BIP39, WIF, XPRV and HEX).

This feature was requested here: https://github.com/iancoleman/bip39/issues/424

[iancoleman]

Thanks for this. It's a very clean implementation.

This seems useful to include this with the tool.

---

I would like to throw around a few conceptual aspects to make sure I understand the use cases for this feature correctly (I have read bip85 several times but never felt I fully understood the motivation; it seems to me like it allows mnemonics to be derived from other mnemonics, ie bip85 is HD mnemonics which feed into HD keys, does that sound right?).

Does the information within the bip85 section only affect bip85 fields? (I guess from looking at the PR that yes, bip85 info is populated from the Mnemonic section but is not used for any other section of the tool).

---

Add explainer text

The bip85 section could potentially be confusing when shown, as it may seem that the bip85 child key is being used as the basis for the Derivation Path and Derived Addresses section. The current flow of the tool is top-to-bottom so it could seem like the bip85 section is stepping into the flow of information by being positioned where it is. So maybe a small bit of text to explain the bip85 info being shown is a) not used by the tool for derivation and/or b) must be copied and pasted elsewhere to be used for deriving addresses.

A link to bip85 in that explainer text would be great - "For more info see the BIPXX spec" is used throughout the tool.

Additionally, it might be clearer for users if the bip85 info shows in a modal so it's clearly 'isolated' from the existing flow (I really dislike modals so am just brainstorming). I thought maybe left indentation might achieve this visual separation, but indenting might not be a clear enough visual language (especially on mobile). I'm still not sure about the UX for the bip85 feature, I'm open to suggestions (or reasons to not worry about it). So far I'm not terribly worried about it but wonder if we can make the use-case for that info clearer somehow?

---

Tests

I looked at the bip85 test vectors but couldn't see how to confirm them using this tool. Any tips?

Also a test should be added to the tests/spec/tests.js file.

---

Out of curiosity, how does a user specify bip85 usage to another person?

For example, I can fully explain how to get private keys and addresses via "BIP39 abandon abandon ability (no passphrase), BIP44 account 0" (anyone should be able to derive 1Di3Vp7tBWtyQaDABLAjfWtF6V7hYKJtug from that)

How would bip85 fit into an explained derivation sequence like that?

[AndreasGassmann]

Thanks for the detailed feedback. I'll try to address all your points.

BIP85 Use Cases

it seems to me like it allows mnemonics to be derived from other mnemonics

This is one of the use cases, yes.

For me personally, this is the most interesting use case, but BIP85 also specifies different "applications" which derive entropy for different purposes. I think this allows you to derive entropy for things like bitcoin-core (which uses the WIF format), or derive entropy for a monero mnemonic.

For me, the "real life" use case for BIP85 is the following:

• A user generates one mnemonic with a high security standard (ideally offline) and creates a very secure and redundant backup of it. Backing it up in multiple secure locations and maybe even using shamir's secret sharing.
• This mnemonic is used to securely (ideally offline) derive other mnemonics out of it, which can then be used in different applications. So you could use derived mnemonic with index 0 for your ledger and index 1 for something a bit more insecure like a browser wallet (to test out a feature, or whatever reason).
• If someone gains access to one of your child keys, then only that mnemonic/wallet is compromised, all other keys (parent and child keys) are still secure. In fact, the attacker doesn't even know they are linked in any way.
• If you lose access yourself (eg. because your ledger breaks), you can simply recover your original mnemonic and re-generate the mnemonic.

I would advise that people keep a private list of a mapping between index and application where the mnemonic is used, just to make the recovery process easier.

So in summary, the big advantage in my opinion is that you can quickly get new, secure mnemonics, without worrying too much about how they are backed up. I personally run into this problem quite a lot. You want to test out a new wallet and need a new mnemonic for that, so I use your bip39 tool to quickly get one. But then I have to back it up, which takes a considerable amount of effort if you want to do it in a secure and redundant way. BIP85 takes that hassle away without compromising security.

---

Does the information within the bip85 section only affect bip85 fields?

Yes. The BIP85 fields only affect other BIP85 fields. The "BIP85 Child Key" is what is calculated out of the original mnemonic and the configuration provided in the BIP85 section. But the "BIP85 Child Key" is not used anywhere, it has to be copied by the user and pasted into the "BIP39 Mnemonic" field at the top in order to see the addresses etc. that the mnemonic generates.

Add explainer text

The current flow of the tool is top-to-bottom

Yes, I was also concerned about that. At first, I thought about putting it into a new tab in the derivation path section, but those are all linked to addresses, so it didn't make sense.

If you're ok with an explainer text, then I can do that. It would be easy to do and probably clear up most of the confusion.

Maybe we could also consider adding a tabbed section below the "BIP32 Root Key" field, which will contain "BIP85" and the "split mnemonic cards", because they are not directly related to the top-to-bottom flow, but more like additional data that can be generated out of the mnemonic? That table could be hidden by default and only enabled if you tick the "advanced options" box. I think I would prefer that to a modal.

Tests

I will add some tests.

I looked at the bip85 test vectors but couldn't see how to confirm them using this tool. Any tips?

You can use the mnemonic install scatter logic circle pencil average fall shoe quantum disease suspect usage to test the calculated values against the test vectors.

---

Out of curiosity, how does a user specify bip85 usage to another person?

I'm not quite sure what you are asking for here, but I'll explain how you get from a "master mnemonic" to one of the "child mnemonics":

You take a mnemonic and calculate the BIP32 Root Key:

const mnemonic = "install scatter logic circle pencil average fall shoe quantum disease suspect usage" 

const seed = mnemonicToSeed(mnemonic)
// "xprv9s21ZrQH143K2LBWUUQRFXhucrQqBpKdRRxNVq2zBqsx8HVqFk2uYo8kmbaLLHRdqtQpUm98uKfu3vca1LqdGhUtyoFnCNkfmXRyPXLjbKb"

You then derive a new key from the BIP32 Root Key, using a path according to the BIP85 specs.

const path = "m/83696968'/39'/0'/12'/0'"
// 83696968 is a constant defined in BIP85
// 39 is the application number for BIP39, defined in BIP85
// 0 defines the language (english)
// 12 is the length of the resulting mnemonic
// 0 is the index

const childNode = fromSeed(seed).derive(path)

You then take the private key of the child node and calculate the hash of it.

function hmacSHA512(key: Buffer, data: Buffer): Buffer {
  return createHmac('sha512', key).update(data).digest()
}

const hash = hmacSHA512(Buffer.from(bip-entropy-from-k), childNode.privateKey)
// bip-entropy-from-k is defined in the BIP85 specs

That will give you entropy in the length of 64 bytes. It has to be truncated to the length of the new mnemonic:

const truncatedHash = hash.slice(0, 16)
const entropy = truncatedHash.toString('hex') // 6250b68daf746d12a24d58b4787a714b
const childMnemonic = entropyToMnemonic() // girl mad pet galaxy egg matter matrix prison refuse sense ordinary nose

[AndreasGassmann]

I added one test and an explanation.

Is that enough?

Also, one of the tests seems to fail for me, even on master. So I didn't touch it:

1) BIP39 Tool Tests Clears old root keys from memory when mnemonic is cleared
  Message:
    Expected 40 to be 0.

[iancoleman]

Looks good. I'm happy to merge this. Sorry for the slow response, I've been mulling over the ux for this.

One question though, just because I want to make sure I fully understand this before I merge it.

bip85 might fit into the workflow logically by adding a radiobutton in the bip85 section for deciding which mnemonic to use as the root key feeding into the derivation section:

• use bip39 mnemonic for derivation
• use bip85 mnemonic for derivation

So the flow from top to bottom of the tool would be

Entropy (optional) -> Bip39 mnemonic + root seed / hdkeys -> Bip85 mnemonic (optional) -> Bip[32|44|49|84|141] derivation path -> Addresses + keys

Do the radiobuttons sound like an appropriate addition?

[AndreasGassmann]

Hmm, that's a difficult question. In theory I can see how the flow you describe makes sense. But I'm not sure if it wouldn't be clearer to keep it the way it is and have users copy/paste the mnemonic. Because this way, it is clear that it's a new mnemonic, not something that is an "intermediate" step in the flow.

If we look at implementations in wallets (there is currently only Coldcard, AirGap is working on it), then the derivation of the child mnemonic is its own flow. So in those wallets, there is a clear separation between the derivation of the child mnemonic, and then deriving the address from that child mnemonic.

So after thinking about it for the last 20 minutes, I think I would prefer to keep it this way because it would be more in line with the actual use cases (meaning to separate the derivation of child mnemonic and addresses).

What do you think?

[AndreasGassmann]

I just noticed this: Should I add a "BIP85" section under "More info"?

[iancoleman]

have users copy/paste the mnemonic. Because this way, it is clear that it's a new mnemonic, not something that is an "intermediate" step in the flow.

Yes I'm inclined to agree. Let's leave it.

the derivation of the child mnemonic is its own flow. So in those wallets, there is a clear separation between the derivation of the child mnemonic, and then deriving the address from that child mnemonic.

I admit that my first feeling was maybe the bip85 feature should be a different tool altogether and not part of this one, since it's a reasonably different flow to what this tool currently does. But I can see the benefit of it being here, and I feel like we've explored the ux enough that it can be merged satisfactorily.

[AndreasGassmann]

Thanks for merging!

I admit that my first feeling was maybe the bip85 feature should be a different tool altogether and not part of this one, since it's a reasonably different flow to what this tool currently does. But I can see the benefit of it being here, and I feel like we've explored the ux enough that it can be merged satisfactorily.

I know what you mean. For me personally I think it fits into the general use case of this tool, but if you ever change your mind I'll be happy to create a new tool for BIP85 specifically.

[iancoleman]

Some small tweaks to the text in https://github.com/iancoleman/bip39/commit/253f4cb75f04b9596159857b7b6339423bc920ca and https://github.com/iancoleman/bip39/commit/134213954d6380e8b5293e94d59f75b9a9a23df6

[8go]

FYI:

• ColdCard has implemented BIP-85, see https://github.com/Coldcard/firmware/pull/39
• I have raised BIP-85 as a feature request for Trezor, see https://github.com/trezor/trezor-firmware/issues/1528
• Also, a detailed example use-case is given in https://github.com/trezor/trezor-firmware/issues/1528

PS: Thanks for your including this in your tool! Excellent addition!

[AndreasGassmann]

@8go: AirGap Vault now also supports BIP-85: https://github.com/airgap-it/airgap-vault/commit/d64332fc2f332be622a1229acb27f621e23774d6