diff --git a/docs/ralph/built-in-functions.md b/docs/ralph/built-in-functions.md index efc7718d..0a39f1a5 100644 --- a/docs/ralph/built-in-functions.md +++ b/docs/ralph/built-in-functions.md @@ -446,6 +446,22 @@ Returns the id of the sub contract. --- +### subContractIdInParentGroup + +```Rust +fn subContractIdInParentGroup!(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 diff --git a/docs/wallet/desktop-wallet/advanced-features.md b/docs/wallet/desktop-wallet/advanced-features.md index 62cd6503..c3903d6a 100644 --- a/docs/wallet/desktop-wallet/advanced-features.md +++ b/docs/wallet/desktop-wallet/advanced-features.md @@ -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`. +UTXO consolidation +UTXO consolidation +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`. +Landing page -Landing page - -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. - -Landing page - -## 2. Passphrase (ADVANCED SECURITY FEATURE) +## 2. Passphrase (ADVANCED SECURITY FEATURE) Introduced in version 1.3.0 @@ -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. @@ -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. -Landing page +Landing page ### 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. diff --git a/docs/wallet/desktop-wallet/configure-mining-wallet.md b/docs/wallet/desktop-wallet/configure-mining-wallet.md index fbc2c96a..11c6d84d 100644 --- a/docs/wallet/desktop-wallet/configure-mining-wallet.md +++ b/docs/wallet/desktop-wallet/configure-mining-wallet.md @@ -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. -Prompt to create a new wallet +Prompt to create a new wallet -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` -Advanced management section +Advanced management section diff --git a/docs/wallet/desktop-wallet/getting-started.md b/docs/wallet/desktop-wallet/getting-started.md index 5da72cde..1954feab 100644 --- a/docs/wallet/desktop-wallet/getting-started.md +++ b/docs/wallet/desktop-wallet/getting-started.md @@ -20,11 +20,10 @@ By default, the wallet will be connected to the Alephium public node. Should you ::: Desktop Wallet Landing page - + Prompt to create new wallet - -Prompt to chose a name and set a password +Prompt to chose a name and set a password 1. Click on `Create/Import a new wallet`, then click `New wallet`. @@ -37,20 +36,19 @@ By default, the wallet will be connected to the Alephium public node. Should you Landing page of a brand new wallet - 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 Landing page of Desktop Wallet Prompt to enter destination address and amount of transaction +Prompt to enter destination address and amount of transaction 1. To send ALPH, simply click on the `Send` button in the left menu. @@ -58,7 +56,7 @@ By default, the wallet will be connected to the Alephium public node. Should you 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 @@ -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. -Address page +Address page -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. -Prompt to create a new address +Prompt to create a new address By clicking on a specific address, you'll see the address details including its transaction history. -View of a singel address +View of a singel address 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. -Prompt to configure address options +Prompt to configure address options diff --git a/docs/wallet/desktop-wallet/media/af1.png b/docs/wallet/desktop-wallet/media/af1.png index ab0bf421..bb2d8621 100644 Binary files a/docs/wallet/desktop-wallet/media/af1.png and b/docs/wallet/desktop-wallet/media/af1.png differ diff --git a/docs/wallet/desktop-wallet/media/af2.png b/docs/wallet/desktop-wallet/media/af2.png index 8e62bb6a..793e2c46 100644 Binary files a/docs/wallet/desktop-wallet/media/af2.png and b/docs/wallet/desktop-wallet/media/af2.png differ diff --git a/docs/wallet/desktop-wallet/media/af4.png b/docs/wallet/desktop-wallet/media/af4.png new file mode 100644 index 00000000..3bd2a10c Binary files /dev/null and b/docs/wallet/desktop-wallet/media/af4.png differ diff --git a/docs/wallet/desktop-wallet/media/af5.png b/docs/wallet/desktop-wallet/media/af5.png new file mode 100644 index 00000000..7dca96cf Binary files /dev/null and b/docs/wallet/desktop-wallet/media/af5.png differ diff --git a/docs/wallet/desktop-wallet/media/gs1.png b/docs/wallet/desktop-wallet/media/gs1.png index 66a4f651..1c41bcf9 100644 Binary files a/docs/wallet/desktop-wallet/media/gs1.png and b/docs/wallet/desktop-wallet/media/gs1.png differ diff --git a/docs/wallet/desktop-wallet/media/gs10.png b/docs/wallet/desktop-wallet/media/gs10.png index 184d4478..e6e29233 100644 Binary files a/docs/wallet/desktop-wallet/media/gs10.png and b/docs/wallet/desktop-wallet/media/gs10.png differ diff --git a/docs/wallet/desktop-wallet/media/gs11.png b/docs/wallet/desktop-wallet/media/gs11.png index 5d7e6e53..391584ca 100644 Binary files a/docs/wallet/desktop-wallet/media/gs11.png and b/docs/wallet/desktop-wallet/media/gs11.png differ diff --git a/docs/wallet/desktop-wallet/media/gs12.png b/docs/wallet/desktop-wallet/media/gs12.png index b6c33a90..bd69c409 100644 Binary files a/docs/wallet/desktop-wallet/media/gs12.png and b/docs/wallet/desktop-wallet/media/gs12.png differ diff --git a/docs/wallet/desktop-wallet/media/gs13.png b/docs/wallet/desktop-wallet/media/gs13.png new file mode 100644 index 00000000..01adc960 Binary files /dev/null and b/docs/wallet/desktop-wallet/media/gs13.png differ diff --git a/docs/wallet/desktop-wallet/media/gs2.png b/docs/wallet/desktop-wallet/media/gs2.png index 303f05fa..a16e8b23 100644 Binary files a/docs/wallet/desktop-wallet/media/gs2.png and b/docs/wallet/desktop-wallet/media/gs2.png differ diff --git a/docs/wallet/desktop-wallet/media/gs3.png b/docs/wallet/desktop-wallet/media/gs3.png index 32f815f0..bab09449 100644 Binary files a/docs/wallet/desktop-wallet/media/gs3.png and b/docs/wallet/desktop-wallet/media/gs3.png differ diff --git a/docs/wallet/desktop-wallet/media/gs4.png b/docs/wallet/desktop-wallet/media/gs4.png index 9e3607fb..e99d6667 100644 Binary files a/docs/wallet/desktop-wallet/media/gs4.png and b/docs/wallet/desktop-wallet/media/gs4.png differ diff --git a/docs/wallet/desktop-wallet/media/gs5.png b/docs/wallet/desktop-wallet/media/gs5.png index d65ddd76..d3a6e57a 100644 Binary files a/docs/wallet/desktop-wallet/media/gs5.png and b/docs/wallet/desktop-wallet/media/gs5.png differ diff --git a/docs/wallet/desktop-wallet/media/gs6.png b/docs/wallet/desktop-wallet/media/gs6.png index eb9c83ff..082c5316 100644 Binary files a/docs/wallet/desktop-wallet/media/gs6.png and b/docs/wallet/desktop-wallet/media/gs6.png differ diff --git a/docs/wallet/desktop-wallet/media/gs7.png b/docs/wallet/desktop-wallet/media/gs7.png index d6a110bb..cd2f3448 100644 Binary files a/docs/wallet/desktop-wallet/media/gs7.png and b/docs/wallet/desktop-wallet/media/gs7.png differ diff --git a/docs/wallet/desktop-wallet/media/gs8.png b/docs/wallet/desktop-wallet/media/gs8.png index 8a2cd15a..96e05985 100644 Binary files a/docs/wallet/desktop-wallet/media/gs8.png and b/docs/wallet/desktop-wallet/media/gs8.png differ diff --git a/docs/wallet/desktop-wallet/media/gs9.png b/docs/wallet/desktop-wallet/media/gs9.png index 8cd21902..013f7ea9 100644 Binary files a/docs/wallet/desktop-wallet/media/gs9.png and b/docs/wallet/desktop-wallet/media/gs9.png differ diff --git a/docs/wallet/desktop-wallet/media/overview1.png b/docs/wallet/desktop-wallet/media/overview1.png index 8d3bd866..313cdad6 100644 Binary files a/docs/wallet/desktop-wallet/media/overview1.png and b/docs/wallet/desktop-wallet/media/overview1.png differ diff --git a/docs/wallet/desktop-wallet/media/overview2.png b/docs/wallet/desktop-wallet/media/overview2.png index 04efa049..240263f1 100644 Binary files a/docs/wallet/desktop-wallet/media/overview2.png and b/docs/wallet/desktop-wallet/media/overview2.png differ