Skip to content

Commit

Permalink
Merge pull request #271 from alephium/fix-screenshots
Browse files Browse the repository at this point in the history
Fix screenshots in desktop wallet docs
  • Loading branch information
nop33 authored Dec 4, 2023
2 parents bdff67d + 66939cd commit fc49f51
Show file tree
Hide file tree
Showing 23 changed files with 45 additions and 39 deletions.
16 changes: 16 additions & 0 deletions docs/ralph/built-in-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,22 @@ Returns the id of the sub contract.
---

### subContractIdInParentGroup

```Rust
fn subContractIdInParentGroup!(contract:<Contract>, subContractPath:ByteVec) -> (ByteVec)
```

Returns the id of the sub contract.

> @param **contract** *the parent contract of the sub-contract*
>
> @param **subContractPath** *the path of the sub-contract*
>
> @returns *the id of the sub contract*
---

## Asset Functions
---
### approveToken
Expand Down
36 changes: 14 additions & 22 deletions docs/wallet/desktop-wallet/advanced-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,17 @@ To make sure this doesn't happen, the wallet allows you to easily consolidate yo

:::

In the `Addresses` tab, click on the `Advanced operations` icon and choose `Consolidate UTXOs`.

<img src={require("./media/af1.png").default} alt="UTXO consolidation" width="auto" style={{ height: '200px' }} />

<img src={require("./media/af4.png").default} alt="UTXO consolidation" width="auto" style={{ height: '200px' }} />

Select the address from which you want to consolidate the UTXOs and select the destination address (it can be the same address). Click on `Consolidate` and your UTXOs will be consolidated.

In the `Addresses` tab, click on `Show Operations` in the `Advanced Management` section and choose `Consolidate UTXOs`.
<img src={require("./media/af2.png").default} alt="Landing page" width="auto" style={{ height: '200px' }} />

<img src={require("./media/af1.png").default} alt="Landing page" width="auto" style={{ height: '200px' }} />

Select the address from which you want to consolidate the UTXOs and select the destination address (it can be the same address). Click on `Consolidate` and your UTXOs will be consolidated.

<img src={require("./media/af2.png").default} alt="Landing page" width="auto" style={{ height: '200px' }} />

## 2. Passphrase (ADVANCED SECURITY FEATURE)
## 2. Passphrase (ADVANCED SECURITY FEATURE)

Introduced in version 1.3.0

Expand All @@ -37,11 +35,12 @@ Please, read the following documentation and this [article](https://medium.com/@
:::

### 1. Important Takeaways
* The Passphrase is an advanced security feature that adds an additional word that you choose to your existing Secret Recovery Phrase.
* Using a Passphrase will cause an entirely new wallet to be created which cannot be accessed via the Secret Recovery Phrase alone.
* The desktop wallet password is different from the Passphrase. The password is only used on your computer to encrypt and store the Secret Recovery Phrase. The Passphrase is an additional word to that Secret Recovery Phrase and is not stored in the wallet.
* Apart from adding another layer of security, the Passphrase grants you plausible deniability when under duress.
* **If you decide to use a Passphrase, it is vital to store it and back it up securely in a different physical location than the Secret Recovery Phrase. You must remember your Passphrase perfectly. Changing a single character (even, for example, from lower to upper-case), will result in the generation of a completely new wallet. **

- The Passphrase is an advanced security feature that adds an additional word that you choose to your existing Secret Recovery Phrase.
- Using a Passphrase will cause an entirely new wallet to be created which cannot be accessed via the Secret Recovery Phrase alone.
- The desktop wallet password is different from the Passphrase. The password is only used on your computer to encrypt and store the Secret Recovery Phrase. The Passphrase is an additional word to that Secret Recovery Phrase and is not stored in the wallet.
- Apart from adding another layer of security, the Passphrase grants you plausible deniability when under duress.
- **If you decide to use a Passphrase, it is vital to store it and back it up securely in a different physical location than the Secret Recovery Phrase. You must remember your Passphrase perfectly. Changing a single character (even, for example, from lower to upper-case), will result in the generation of a completely new wallet. **

Assuming you have created a wallet using the desktop wallet app, you have a list of 24 words referred to as your Secret Recovery Phrase. This phrase can be used to restore your wallet and access your funds. If this 24-word Secret Recovery Phrase gets stolen, the attacker will be able to steal your funds. To enhance the security of our desktop wallet users and to prevent loss of funds due to theft of the 24-word Secret Recovery Phrase, we implemented the [BIP39 passphrase](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki#from-mnemonic-to-seed) feature.

Expand All @@ -57,18 +56,11 @@ It is important to remember that any unique Passphrase will generate and give ac

To use a Passphrase, simply tick the `Use optional passphrase (advanced)` and enter the optional Passphrase of your choice.

<img src={require("./media/af3.png").default} alt="Landing page" width="auto" style={{ height: '200px' }} />
<img src={require("./media/af5.png").default} alt="Landing page" width="auto" style={{ height: '200px' }} />

### 3. Limitations of Passphrase-enabled wallets

1. You cannot (yet) use colored labels for your generated addresses.
2. Any additionally generated addresses will need to be re-generated after every login.

This may change in the future.







This may change in the future.
10 changes: 5 additions & 5 deletions docs/wallet/desktop-wallet/configure-mining-wallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ title: Configure a Mining Wallet
sidebar_label: Configure a Mining Wallet
---

# Configure a Mining Wallet
# Configure a Mining Wallet

A mining wallet is slightly different and needs to have **one address per group**. Currently, Alephium is running 4 groups, meaning it is needed to have 4 addresses. The desktop wallet can generate them easily for you.

To do this, simply unfold the `Advanced Settings` in the welcome screen at the end of the wallet creation process.
To do this, simply unfold the `Advanced Settings` in the welcome screen at the end of the wallet creation process.

<img src={require("./media/mw1.png").default} alt="Prompt to create a new wallet" width="auto" style={{ height: '200px' }} />
<img src={require("./media/mw1.png").default} alt="Prompt to create a new wallet" width="auto" style={{ height: '200px' }} />

Alternatively, you can create additional addresses manually after you log into your wallet by going to the `Addresses` tab, click on `Show Operations` in the `Advanced Management` section and choose `Generate one address per group`
Alternatively, you can create additional addresses manually after you log into your wallet by going to the `Addresses` tab, click on the `Advanced operations` icon and choose `Generate one address per group`

<img src={require("./media/mw2.png").default} alt="Advanced management section" width="auto" style={{ height: '200px' }} />
<img src={require("./media/af4.png").default} alt="Advanced management section" width="auto" style={{ height: '200px' }} />
22 changes: 10 additions & 12 deletions docs/wallet/desktop-wallet/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,10 @@ By default, the wallet will be connected to the Alephium public node. Should you
:::

<img src={require("./media/gs1.png").default} alt="Desktop Wallet Landing page" width="auto" style={{ height: '200px' }} />

<img src={require("./media/gs2.png").default} alt="Prompt to create new wallet" width="auto" style={{ height: '200px' }} />

<img src={require("./media/gs3.png").default} alt="Prompt to chose a name and set a password" width="auto" style={{ height: '200px' }} />

<img src={require("./media/gs3.png").default} alt="Prompt to chose a name and set a password" width="auto" style={{ height: '200px' }} />

1. Click on `Create/Import a new wallet`, then click `New wallet`.

Expand All @@ -37,28 +36,27 @@ By default, the wallet will be connected to the Alephium public node. Should you

<img src={require("./media/gs6.png").default} alt="Landing page of a brand new wallet" width="auto" style={{ height: '200px' }} />


3. In the highlighted box, you will see 24 words. These are your wallet's 24-word Secret Recovery Phrase. This is your most precious piece of information, and you must store it wisely, safely, and carefully.

4. You will now be asked to verify that you got the 24-word Secret Recovery Phrase right. Click `Ready` and select the words in the right order. If the process was done correctly, the words turn green. If a mistake was made, they turn red: don't worry, you can reorder the words until you get the Phrase right.

5. Everything is now ready! Welcome to your new wallet.


## 3. Transfer ALPH

<img src={require("./media/gs7.png").default} alt="Landing page of Desktop Wallet" width="auto" style={{ height: '200px' }} />

<img src={require("./media/gs8.png").default} alt="Prompt to enter destination address and amount of transaction" width="auto" style={{ height: '200px' }} />

<img src={require("./media/gs9.png").default} alt="Prompt to enter destination address and amount of transaction" width="auto" style={{ height: '200px' }} />

1. To send ALPH, simply click on the `Send` button in the left menu.

2. Enter the amount of ALPH (e.g. 100) and recipient's address.

3. (Optional) You can set a lock time by ticking the corresponding box. In that case, the ALPH will be sent to the recipient address but subject to an on-chain lock until the date you have indicated. Please note that it is not possible to change the lock-time once the transaction has been submitted.

4. Click `Review` and carefully review your transaction details. Once you click on `Send` the ALPH will be transferred to the recipient.
4. Click `Check` and carefully review your transaction details. Once you click on `Send` the ALPH will be transferred to the recipient.

:::info

Expand All @@ -68,18 +66,18 @@ The transaction can be seen in both the `Overview` tab as well as the `Addresses

## 4. Manage Addresses

You can see all the existing addresses displayed in a list in the `Addresses` tab, with information such as their label, respective balances, number of transactions and group number.
You can see all the existing addresses displayed in a list in the `Addresses` tab, with information such as their label, respective balances, group number, etc.

<img src={require("./media/gs9.png").default} alt="Address page" width="auto" style={{ height: '200px' }} />
<img src={require("./media/gs10.png").default} alt="Address page" width="auto" style={{ height: '200px' }} />

Clicking on one of the `+ Generate new address` buttons brings you to the `New address` page where you'll be able to create and label the new address. By default, addresses are generated in a random group. You can manually choose a specific group under the `Advanced options` section.
Clicking on one of the `+ New address` buttons brings you to the `New address` page where you'll be able to create and label the new address. By default, addresses are generated in a random group. You can manually choose a specific group under the `Advanced options` section.

<img src={require("./media/gs10.png").default} alt="Prompt to create a new address" width="auto" style={{ height: '200px' }} />
<img src={require("./media/gs11.png").default} alt="Prompt to create a new address" width="auto" style={{ height: '200px' }} />

By clicking on a specific address, you'll see the address details including its transaction history.

<img src={require("./media/gs11.png").default} alt="View of a singel address" width="auto" style={{ height: '200px' }} />
<img src={require("./media/gs12.png").default} alt="View of a singel address" width="auto" style={{ height: '200px' }} />

Using the Settings wheel at the top of the application, you will be able to edit the Address label, choose it as your default address or sweep all its unlocked funds to an address of your choice.

<img src={require("./media/gs12.png").default} alt="Prompt to configure address options" width="auto" style={{ height: '200px' }} />
<img src={require("./media/gs13.png").default} alt="Prompt to configure address options" width="auto" style={{ height: '200px' }} />
Binary file modified docs/wallet/desktop-wallet/media/af1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet/desktop-wallet/media/af2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/wallet/desktop-wallet/media/af4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/wallet/desktop-wallet/media/af5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet/desktop-wallet/media/gs1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet/desktop-wallet/media/gs10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet/desktop-wallet/media/gs11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet/desktop-wallet/media/gs12.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/wallet/desktop-wallet/media/gs13.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet/desktop-wallet/media/gs2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet/desktop-wallet/media/gs3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet/desktop-wallet/media/gs4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet/desktop-wallet/media/gs5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet/desktop-wallet/media/gs6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet/desktop-wallet/media/gs7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet/desktop-wallet/media/gs8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet/desktop-wallet/media/gs9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet/desktop-wallet/media/overview1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet/desktop-wallet/media/overview2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fc49f51

Please sign in to comment.