Skip to content

Commit

Permalink
docs other small changes
Browse files Browse the repository at this point in the history
  • Loading branch information
tadeubas committed Feb 26, 2024
1 parent 56f554d commit bf9ec98
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/faq.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ If you are in a dark environment, you can hold down the ENTER button of the M5St
## Why am I getting an error when I try to scan a QR code?
If Krux is recognizing that it sees a QR code but is displaying an error message after reading it, the likely reason is that the QR code is not in a format that Krux works with. We have listed the supported formats below:

For BIP39 mnemonics:
For BIP-39 mnemonics:

1. BIP-39 Plaintext (Used by Krux and [https://iancoleman.io/bip39/](https://iancoleman.io/bip39/))
2. SeedSigner [SeedQR and CompactSeedQR](https://github.com/SeedSigner/seedsigner/blob/dev/docs/seed_qr/README.md) Formats
Expand Down
4 changes: 3 additions & 1 deletion docs/getting-started/features/encrypted-mnemonics.en.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Introduction

There are many possible security layers one could add to protect a wallet’s private key, adding a passphrase to the mnemonic is the most common. To encrypt a mnemonic would have similar use case as the passphrase, but, depending on how it is done, the user experience could be different. The main difference from passphrases to Krux’s encrypted mnemonic implementation is that when users type the wrong key, instead of loading a different wallet, encrypted mnemonics will return an error. This is not considered an advantage, but a difference, that may be desired or not. The implementation also has the convenience of storing a mnemonic ID together with stored or QR code encrypted mnemonics. Mnemonic encryption, with its own key, can be used together with passphrases as an extra security layer.
There are many possible security layers one could add to protect a wallet’s private key, adding a BIP-39 passphrase to the mnemonic is the most common. To encrypt a BIP-39 mnemonic would have similar use case as the BIP-39 passphrase, but, depending on how it is done, the user experience could be different. The main difference from BIP-39 passphrases to Krux’s encrypted mnemonic implementation is that when users type the wrong key, instead of loading a different wallet (as BIP-39 passphrase would normally do), encrypted mnemonics will return an error. This difference may be desired or not. The implementation also has the convenience of storing a mnemonic ID together with the stored or QR code encrypted mnemonics. Mnemonic encryption, with its own key, can be used together with BIP-39 passphrase as an extra security layer.

## Encrypted QR Codes Data and Parsing
In search of efficiency and smaller QR codes, all data is converted to bytes and organized like a Bitcoin transaction, with variable and fixed length fields. The following data is present on the QR code:
Expand All @@ -23,3 +23,5 @@ In search of efficiency and smaller QR codes, all data is converted to bytes and

## Considerations
Storage of encrypted mnemonics on the device or SD cards are meant for convenience only and should not be considered a form of backup. Always make a physical backup of your keys that is independent from electronic devices and test recovering your wallet from this backup before you send funds to it.

Remember that the stored encrypted mnemonic is protected by the key you defined to encrypt it. If the defined [key is weak](https://www.hivesystems.io/blog/are-your-passwords-in-the-green), your encrypted mnemonic will not be protected. If you have stored a mnemonic with funds in the device's internal flash memory using a [weak key](https://www.hivesystems.io/blog/are-your-passwords-in-the-green), the best way to undo this is to [wipe the device](./tools.en.md#wipe-device).
2 changes: 1 addition & 1 deletion docs/getting-started/features/tools.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Enter a text input to create, print or transcript a QR code that can be later us
<img src="../../../img/maixpy_m5stickv/delete-mnemonic-125.png" align="right">
<img src="../../../img/maixpy_amigo_tft/delete-mnemonic-150.png" align="right">

Delete any stored encrypted mnemonic, on device's internal memory or SD card.
Delete any stored encrypted mnemonic, on device's internal memory or SD card. For more info see [Krux Encrypted Mnemonics](./encrypted-mnemonics.en.md).

<div style="clear: both"></div>

Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started/usage/navigating-the-main-menu.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ A QR code is created from a binary representation of mnemonic words. Format crea

#### SeedQR

Words are converted to their BIP39 numeric indexes, those numbers are then concatenated as a string and finally converted to a QR code. Format created by SeedSigner
Words are converted to their BIP-39 numeric indexes, those numbers are then concatenated as a string and finally converted to a QR code. Format created by SeedSigner

#### Stackbit 1248

Words are converted to their BIP39 numeric indexes, then each of the four digits is converted to a sum of 1,2,4 or 8.
Words are converted to their BIP-39 numeric indexes, then each of the four digits is converted to a sum of 1,2,4 or 8.

#### Tiny Seed

This metal backup format represent BIP39 mnemonic word numbers index on its binary form on a metal plate, where 1's are marked(punched) and 0's are left intact
This metal backup format represent BIP-39 mnemonic word numbers index on its binary form on a metal plate, where 1's are marked(punched) and 0's are left intact

<div style="clear: both"></div>

Expand Down

0 comments on commit bf9ec98

Please sign in to comment.