Skip to content

Commit

Permalink
docs: update loading section
Browse files Browse the repository at this point in the history
docs: update backup methods
  • Loading branch information
odudex committed Jul 7, 2024
1 parent 4dc13d5 commit 85104fa
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 44 deletions.
39 changes: 30 additions & 9 deletions docs/getting-started/usage/loading-a-mnemonic.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,38 +115,59 @@ You will be present to a screen containing wallet attributes, if they are as exp
#### Attributes

**Fingerprint**
<p align="center">
<code>73c5da0a</code>
</p>

The wallet's fingerprint, if you have it noted down, will help you make sure you entered the correct mnemonic and passphrase (optional) and will load the expected wallet.

**Network**
<p align="center">
<code>Mainnet</code>
</p>

Check if you are loading a `Testnet` or `Mainnet` wallet.

**Single/Multisig**
<p align="center">
<code>Single-sig</code>
</p>

Check if you are loading a `Single-sig` or `Multisig` wallet.

**Derivation Path**
<p align="center">
<code>m/84'/0'/0'</code>
</p>

The derivation path is a sequence of numbers, or "nodes," that define the script type, network, and account index of your wallet.
The derivation path is a sequence of numbers, or "nodes", that define the script type, network, and account index of your wallet.

1. Script Type: The first number defines the script type. The default is 84', corresponding to a Native Segwit wallet. Other values include:

44' for Legacy
`44'` for Legacy

`49'` for Nested Segwit

49' for Nested Segwit
`86'` for Taproot

48' for Multisig
`48'` for Multisig


2. Network: The second number defines the network:

0' for Mainnet
`0'` for Mainnet

1' for Testnet
`1'` for Testnet


3. Account Index: The third number is the account index, with 0' being the default.
3. Account Index: The third number is the account index, with `0'` being the default.

For multisig wallets, a fourth node with the value 2' is added to the derivation path.
For multisig wallets, a fourth node with the value `2'` is added to the derivation path.

**Passphrase**
<p align="center">
<code>No Passphrase</code>
</p>

Informs if the wallet has a loaded passphrase.

Expand All @@ -161,7 +182,7 @@ You can optionally choose to type or scan a BIP-39 passphrase. When typing, swip

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

### Customize
#### Customize

<img src="../../../img/maixpy_m5stickv/wallet-customization-options-125.png" align="right">
<img src="../../../img/maixpy_amigo/wallet-customization-options-150.png" align="right">
Expand Down
86 changes: 51 additions & 35 deletions docs/getting-started/usage/navigating-the-main-menu.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,71 +5,54 @@ After entering your mnemonic, and loading a wallet, you will find yourself on Kr

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

### Mnemonic
### Backup Mnemonic
<img src="../../../img/maixpy_m5stickv/backup-options-125.png" align="right">
<img src="../../../img/maixpy_amigo/backup-options-150.png" align="right">

This will open a new submenu with the following options to backup your mnemonic. If you set a [printer driver](../../settings/#driver), it will also give the option to print the backup!
This will open a new submenu with different types of backups. `QR Code` based, `Encrypted` and `Other Formats`

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

#### Words
<img src="../../../img/maixpy_m5stickv/backup-mnemonic-words-125.png" align="right">
<img src="../../../img/maixpy_amigo/backup-mnemonic-words-150.png" align="right">

Display the mnemonic words as text so you can write them down.
If you set a [printer driver](../../settings/#driver), it will also give the option to print them!

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

#### Numbers
<img src="../../../img/maixpy_m5stickv/backup-mnemonic-numbers-125.png" align="right">
<img src="../../../img/maixpy_amigo/backup-mnemonic-numbers-150.png" align="right">

Display the mnemonic word numbers in decimal, hex, or octal format.
#### QR Code

<div style="clear: both"></div>
- **Plaintext QR**

#### Plaintext QR
<img src="../../../img/maixpy_m5stickv/backup-qr-plain-text-125.png" align="right">
<img src="../../../img/maixpy_amigo/backup-qr-plain-text-150.png" align="right">

Generate a QR containing the mnemonic words as regular text, where words are separated by spaces. Any QR code can be printed if a thermal printer driver is set.

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

#### Compact SeedQR
- **Compact SeedQR**

<img src="../../../img/maixpy_m5stickv/backup-compact-qr-125.png" align="right">
<img src="../../../img/maixpy_amigo/backup-compact-qr-150.png" align="right">

A QR code is created from a binary representation of mnemonic words. Format created by SeedSigner, more info [here](https://github.com/SeedSigner/seedsigner/blob/dev/docs/seed_qr/README.md#compactseedqr-specification).

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

#### SeedQR
- **SeedQR**

<img src="../../../img/maixpy_m5stickv/backup-seed-qr-125.png" align="right">
<img src="../../../img/maixpy_amigo/backup-seed-qr-150.png" align="right">

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, more info [here](https://github.com/SeedSigner/seedsigner/blob/dev/docs/seed_qr/README.md).

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

#### Stackbit 1248
<img src="../../../img/maixpy_m5stickv/backup-stackbit-125.png" align="right">
<img src="../../../img/maixpy_amigo/backup-stackbit-150.png" align="right">

This metal backup format represents the BIP-39 mnemonic word's numbers (1-2048). Each of the four digits is converted to a sum of 1, 2, 4 or 8. This option does not print even if a printer driver is set.
- **Encrypted QR Code**

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

#### Tiny Seed
<img src="../../../img/maixpy_m5stickv/backup-tiny-seed-125.png" align="right">
<img src="../../../img/maixpy_amigo/backup-tiny-seed-150.png" align="right">
This option converts the encrypted mnemonic into a QR code. Enter an encryption key and, optionally, a custom ID. When you scan this QR code through "Load Mnemonic" -> "Via Camera" -> "QR Code," you will be prompted to enter the decryption key to load the mnemonic stored in it. Like any QR code, it can be printed if a thermal printer driver is set up.

This metal backup format represents the BIP-39 mnemonic word's numbers (1-2048) in binary format on a metal plate, where the 1's are marked (punched) and the 0's are left intact. You can also print your mnemonic in this format if a thermal printer driver is set.
See this page to find out more about: [Krux Mnemonics Encryption](../../getting-started/features/encrypted-mnemonics.md).

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

### Encrypt Mnemonic
#### Encrypted
<img src="../../../img/maixpy_m5stickv/home-encrypt-options-125.png" align="right">
<img src="../../../img/maixpy_amigo/home-encrypt-options-150.png" align="right">

Expand All @@ -80,19 +63,52 @@ For convenience, you may choose to store the encrypted mnemonic on flash memory
When using any of the encryption methods, you will be prompted to enter an encryption key. This key can be provided in text or QR code format. Additionally, you have the option to set a custom ID for easier management of your mnemonics. If a custom key is not specified, the device's current loaded wallet fingerprint will be used as the ID.


#### Store on Flash
- **Store on Flash**

This option stores the encrypted mnemonic in the device's flash memory. You can decrypt and load it later through the "Load Mnemonic" -> "From Storage" option.

#### Store on SD Card
- **Store on SD Card**

If an SD card is available, this option stores the encrypted mnemonic on it. You can decrypt and load it later through the "Load Mnemonic" -> "From Storage" option.

#### Encrypted QR Code
- **Encrypted QR Code**
It's another path for the same functionality present on QR Code backups, described above.

This option converts the encrypted mnemonic into a QR code. When you scan this QR code through "Load Mnemonic" -> "Via Camera" -> "QR Code," you will be prompted to enter the decryption key to load the mnemonic stored in it. As any QR code, it can be printed if a thermal printer driver is set.
#### Other Formats

See this page to find out more about: [Krux Mnemonics Encryption](../../getting-started/features/encrypted-mnemonics.md).
- **Words**
<img src="../../../img/maixpy_m5stickv/backup-mnemonic-words-125.png" align="right">
<img src="../../../img/maixpy_amigo/backup-mnemonic-words-150.png" align="right">

Display the mnemonic words as text so you can write them down.

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

- **Numbers**
<img src="../../../img/maixpy_m5stickv/backup-mnemonic-numbers-125.png" align="right">
<img src="../../../img/maixpy_amigo/backup-mnemonic-numbers-150.png" align="right">

Display the mnemonic word numbers in decimal, hex, or octal format.

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



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

- **Stackbit 1248**
<img src="../../../img/maixpy_m5stickv/backup-stackbit-125.png" align="right">
<img src="../../../img/maixpy_amigo/backup-stackbit-150.png" align="right">

This metal backup format represents the BIP-39 mnemonic word's numbers (1-2048). Each of the four digits is converted to a sum of 1, 2, 4 or 8. This option does not print even if a printer driver is set.

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

- **Tiny Seed**
<img src="../../../img/maixpy_m5stickv/backup-tiny-seed-125.png" align="right">
<img src="../../../img/maixpy_amigo/backup-tiny-seed-150.png" align="right">

This metal backup format represents the BIP-39 mnemonic word's numbers (1-2048) in binary format on a metal plate, where the 1's are marked (punched) and the 0's are left intact. You can also print your mnemonic in this format if a thermal printer driver is set.

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

Expand Down

0 comments on commit 85104fa

Please sign in to comment.