Skip to content

Commit

Permalink
Merge pull request darwinia-network#75 from darwinia-network/restruct…
Browse files Browse the repository at this point in the history
…ure_tutorials

Restructure tutorials
  • Loading branch information
1022ranji authored Jan 4, 2022
2 parents 2bf0c88 + 4b7a208 commit 68fc19a
Show file tree
Hide file tree
Showing 79 changed files with 796 additions and 53 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/dvm/wallets/dvm-metamask.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The different network configuration are as follows.

### Address Conversion

Use Apps tool to generate the Stustrate address corresponding to the DVM address.
Use Apps tool to generate the Substrate address corresponding to the DVM address.
1. Copy the DVM address.

![dvm](../../assets/dvm/metamask/m3.png)
Expand Down
5 changes: 5 additions & 0 deletions docs/tutorials/apps_user_guide/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Apps User Guide",
"position": 1
}

Original file line number Diff line number Diff line change
Expand Up @@ -9,36 +9,36 @@ There are mainly three ways to generate a Crab account, you can choose either on

## 1. Crab Web Wallet

![setting](../assets/tut/create-account/1.png)
![setting](../../assets/tut/create-account/1.png)

Enter [Crab Web Wallet](https://apps.darwinia.network), you can see two buttons "Add Account" and "Restore JSON" in the "Account" column.

![create account](../assets/tut/create-account/2.png)
![create account](../../assets/tut/create-account/2.png)

**New account**

Click "Add Account", after setting the basic account information, click the "Save" button. (By default, only "mnemonic", "private key" need to be switched)

![create account](../assets/tut/create-account/3.png)
![create account](../../assets/tut/create-account/3.png)

Click the "Create and Backup Account" button to back up the account "json file"

![create account](../assets/tut/create-account/4.png)
![create account](../../assets/tut/create-account/4.png)

> Be sure to back up `mnemonics, private keys, json files`, etc. When backing up the json file, please keep the password safe. If the password is lost, the address cannot be restored through the json file, but it can be re-imported through the mnemonic word and private key.
**Restore json**

If you have created an account before and backed up a json file, you can directly select "Restore JSON".

![create account](../assets/tut/create-account/5.png)
![create account](../assets/tut/create-account/6.png)
![create account](../../assets/tut/create-account/5.png)
![create account](../../assets/tut/create-account/6.png)

**Restore account via "Mnemonic"**

If you forget the password of the JSON file, you can use the "mnemonic word" to recover it. Click "Add Account" to replace the mnemonic with the original account's mnemonic. (The name and password can be reset)

![create account](../assets/tut/create-account/7.png)
![create account](../../assets/tut/create-account/7.png)

**Generate Vanity account**

Expand All @@ -47,7 +47,7 @@ If you need to generate a Darwinia wallet account containing specific letters, y
- Click [Vanity], fill in the conditions you need to filter

![faucet](../assets/tut/create-account/8.png)
![faucet](../../assets/tut/create-account/8.png)

`Search for` Type here what you would like your address to contain. This tool will generate the keys and show the associated addresses that best match your search. You can use \"?\" as a wildcard for a character.": "",

Expand All @@ -57,11 +57,11 @@ If you need to generate a Darwinia wallet account containing specific letters, y

- Click [Start generation], after waiting for the account to be generated, click [+] to select your favorite account for backup.

![faucet](../assets/tut/create-account/9.png)
![faucet](../../assets/tut/create-account/9.png)

- Click [Save], according to your usage habits, choose to back up the original seed or json file

![faucet](../assets/tut/create-account/10.png)
![faucet](../../assets/tut/create-account/10.png)

> Be sure to back up `mnemonics, private keys, json files`, etc. When backing up the json file, please keep the password safe. If the password is lost, the address cannot be restored through the json file, but it can be re-imported through the mnemonic word and private key.
Expand All @@ -73,17 +73,17 @@ If you need to generate a Darwinia wallet account containing specific letters, y

The browser plugin is available for both [Google Chrome](https://chrome.google.com/webstore/detail/polkadot%7Bjs%7D-extension/mopnmbcafieddcagagdcbnhejhlodfdd?hl=en) and [FireFox](https://addons.mozilla.org/en-US/firefox/addon/polkadot-js-extension).

![polkadot-js](../assets/tut/create-account/11.png)
![polkadot-js](../../assets/tut/create-account/11.png)

**New Account**

Click the extension to open the "Account Management" dialog box, click the "Create New Account" button, and then follow the instructions.

![polkadot-js](../assets/tut/create-account/12.png)
![polkadot-js](../../assets/tut/create-account/12.png)

![polkadot-js](../assets/tut/create-account/13.png)
![polkadot-js](../../assets/tut/create-account/13.png)

![polkadot-js](../assets/tut/create-account/14.png)
![polkadot-js](../../assets/tut/create-account/14.png)

> Make sure to keep the mnemonics safe.
Expand All @@ -93,7 +93,7 @@ Now we will ensure that the addresses are displayed as Darwinia mainnet addresse

Click on "Options" at the top of the plugin window. Select `Crab Network` or `Substrate` in "Display Address Format for" dropdown box.

![polkadot-js](../assets/tut/create-account/15.png)
![polkadot-js](../../assets/tut/create-account/15.png)

> Crab Network share the same `Network ID` as `Substrate`, if you need to choose a network when generating an account, use `substrate` as the same effect as `crab network`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: crab-tut-exchange
title: Exchange Access Guide
sidebar_label: Exchange Access Guide
sidebar_position: 5
sidebar_position: 4
---

## Basic Informations
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Staking",
"position": 4
"position": 2
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@
id: crab-tut-nominator
title: How to become a nominator
sidebar_label: Become a nominator
sidebar_position: 2
sidebar_position: 1
---

> - Staking is a consensus mechanism based on PoS (Proof of Stake / Proof of Stake). Token holders obtain rewards and benefits through pledge, voting, delegation, and locking.
> - Before participating in staking, please make sure you have at least **1** Crab address. If you hold more tokens or have higher security requirements, it is recommended to prepare **2** Crab addresses. If there is no address, please refer to: [How to create an account](../crab-tut-create-account.md).
> - Before participating in staking, please make sure you have at least **1** Crab address. If you hold more tokens or have higher security requirements, it is recommended to prepare **2** Crab addresses. If there is no address, please refer to: [How to create an account](../crab-tut-create-account.md).
> - A small amount of CRING must be prepared in Crab Network's address as fee.

## Start Staking

Enter [Darwinia Wallet](https://apps.darwinia.network) and lick the `Staking` column on the left , Click `Start staking`

![nominate](../../assets/tut/staking-norminator/1.png)
![nominate](../../../assets/tut/staking-norminator/1.png)

Fill in the staking parameters

![nominate](../../assets/tut/staking-norminator/2.png)
![nominate](../../../assets/tut/staking-norminator/2.png)

`Stash account` Account for stashing tokens. Tokens participating in staking will come from this account. The operations of this account are mostly related to changes in stash.

Expand All @@ -36,27 +36,27 @@ Fill in the staking parameters
After filling in the staking parameters, please click `bond` and `submit`

![nominate](../../assets/tut/staking-norminator/3.png)
![nominate](../../../assets/tut/staking-norminator/3.png)

## Nominate a validator

> The identities of the validator and the nominator are mutually exclusive and cannot coexist. If you are running a validator, you need to cancel the validator before proceeding with the nomination.
After completing the staking parameters, click `Nominate` on this page

![nominate](../../assets/tut/staking-norminator/4.png)
![nominate](../../../assets/tut/staking-norminator/4.png)

Choose your favorite validator

![nominate](../../assets/tut/staking-norminator/5.png)
![nominate](../../../assets/tut/staking-norminator/5.png)

Sign and submit

![nominate](../../assets/tut/staking-norminator/6.png)
![nominate](../../../assets/tut/staking-norminator/6.png)

View information about nominated validators

![nominate](../../assets/tut/staking-norminator/7.png)
![nominate](../../../assets/tut/staking-norminator/7.png)

> The operation of nominating validators will take effect from the next era, and it is normal to temporarily delay.
Expand All @@ -76,7 +76,7 @@ The tokens' statuses are following:

There are other operations in staking for the following purposes:

![nominate](../../assets/tut/staking-norminator/8.png)
![nominate](../../../assets/tut/staking-norminator/8.png)

`Stop nomination` Cancels all nominees.

Expand All @@ -92,7 +92,7 @@ There are other operations in staking for the following purposes:

> Please note: 56 era (about 56 days) will be saved, and you will not be able to claim it if it expires.
![nominate](../../assets/tut/staking-norminator/9.png)
![nominate](../../../assets/tut/staking-norminator/9.png)

`Claim Reward` Manually claim the reward, and the reward will be distributed in units of era.

Expand All @@ -110,7 +110,7 @@ There are other operations in staking for the following purposes:

`Set nominees` Re-nominate validator

`Change session key` If you want to upgrade to become a validator, you need to fill in this item. [How to become a validator](/tutorials/staking/crab-tut-validator.md)
`Change session key` If you want to upgrade to become a validator, you need to fill in this item. [How to become a validator](crab-tut-validator.md)

`Set on-chain identity` Set your personal information, such as display, legal name, email, website, twitter and riot. Other users can view this information and contact you.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: crab-tut-validator
title: How to become a validator
sidebar_label: Become a validator
sidebar_position: 1
sidebar_position: 2
---

> - Staking is a consensus mechanism based on PoS (Proof of Stake / Proof of Stake). Token holders obtain rewards and benefits through pledge, voting, delegation, and locking.
Expand Down Expand Up @@ -52,11 +52,11 @@ The result is what you need when setting the session key.

Enter [Crab Wallet](https://apps.darwinia.network) and click the `Staking` column on the left , Click `Start staking`.

![nominate](../../assets/tut/staking-norminator/1.png)
![nominate](../../../assets/tut/staking-norminator/1.png)

Fill in the staking parameters

![nominate](../../assets/tut/staking-norminator/2.png)
![nominate](../../../assets/tut/staking-norminator/2.png)

` Stash account` Account for stashing tokens. Tokens participating in staking will come from this account. The operations of this account are mostly related to changes in stash.

Expand All @@ -74,35 +74,35 @@ Fill in the staking parameters
After filling in the staking parameters, please click `bond` and `submit`

![nominate](../../assets/tut/staking-norminator/3.png)
![nominate](../../../assets/tut/staking-norminator/3.png)

### To be Validator

Click `Set session keys` on this page, completing the generated session keys and submit.

> The session key must be filled with real data, otherwise it will result in missing blocks and be slashed.
![validator](../../assets/tut/validator/v1.png)
![validator](../../../assets/tut/validator/v1.png)

After confirming, click `sign and submit`

> The identities of the validator and the nominator are mutually exclusive and cannot coexist. If you are running a validator, you need to cancel the validator before proceeding with the nomination.
![validator](../../assets/tut/validator/v2.png)
![validator](../../../assets/tut/validator/v2.png)

Click `validate` and set the validator parameters

`Reward commission percentage` Set the proportion of the node's priority distribution of income, the range is 0-100. (Example: If a 5% reward commission is set, this node will first receive 5% of the node's revenue, and the remaining 95% of the node's revenue will be distributed in proportion to the amount of mortgages validated by the validator and nominator; Validator's income = node reward commission + mortgage reward share)

![validator](../../assets/tut/validator/v3.png)
![validator](../../../assets/tut/validator/v3.png)

After confirming, click `sign and submit`

![validator](../../assets/tut/validator/v4.png)
![validator](../../../assets/tut/validator/v4.png)

Go to `staking scan` to view information about validators

![validator](../../assets/tut/validator/v5.png)
![validator](../../../assets/tut/validator/v5.png)

> The operation of validate will take effect after the first epoch of the next era. Prior to this, the validator will be in the [waiting] list.
Expand All @@ -122,7 +122,7 @@ $ docker run -it -v node-data:/darwinia/data quay.io/darwinia-network/darwinia:v

There are other operations in staking for the following purposes:

![validator](../../assets/tut/validator/v6.png)
![validator](../../../assets/tut/validator/v6.png)

`Stop nomination` Cancels all nominees.

Expand All @@ -138,7 +138,7 @@ There are other operations in staking for the following purposes:

> Please note: 56 era (about 56 days) will be saved, and you will not be able to claim it if it expires.
![validator](../../assets/tut/validator/v7.png)
![validator](../../../assets/tut/validator/v7.png)

`Claim Reward` Manually claim the reward, and the reward will be distributed in units of era.

Expand Down
Loading

0 comments on commit 68fc19a

Please sign in to comment.