Skip to content

Commit

Permalink
feat(i18n-de): add new pages for translation
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonKraus committed Apr 22, 2021
1 parent 8ff93a8 commit dfe2964
Show file tree
Hide file tree
Showing 4 changed files with 173 additions and 4 deletions.
12 changes: 8 additions & 4 deletions i18n/de/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@
"message": "Werde ein Validator",
"description": "The label for category Become a validator in sidebar sidebar"
},
"sidebar.sidebar.category.Connecting to node": {
"sidebar.sidebar.category.Connect to a Node": {
"message": "Mit einer Node verbinden",
"description": "The label for category Connecting to node in sidebar sidebar"
"description": "The label for category Connect to a Node in sidebar sidebar"
},
"sidebar.sidebar.category.Other": {
"message": "Andere",
"description": "The label for category Other in sidebar sidebar"
},
"sidebar.sidebar.category.Contributing": {
"sidebar.sidebar.category.Contribute": {
"message": "Beitragen",
"description": "The label for category Contributing in sidebar sidebar"
"description": "The label for category Contribute in sidebar sidebar"
},
"sidebar.sidebar.category.How-to": {
"message": "How-to",
Expand All @@ -42,5 +42,9 @@
"sidebar.sidebar.category.Maintain": {
"message": "Verwalten",
"description": "The label for category Maintain in sidebar sidebar"
},
"sidebar.sidebar.category.Build": {
"message": "Bauen",
"description": "The label for category Build in sidebar sidebar"
}
}
62 changes: 62 additions & 0 deletions i18n/de/docusaurus-plugin-content-docs/current/build_dev_chain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
id: build_dev_chain
title: Set up a development chain
---

import useBaseUrl from '@docusaurus/useBaseUrl';

This section runs you through the process of setting up a local HydraDX chain instance for development.

:::note
Are you looking to set up a node for validation purposes? Please move to our [validator setup guide](/node_setup).
:::

## 01 Install dependencies {#01-install-dependencies}

To prepare a local HydraDX chain instance for development, your machine needs to cover all dependencies for running a Substrate chain. You will need to install a Rust developer environment and make sure that it is configured properly for compiling Substrate runtime code to the WebAssembly (Wasm) target.

You can install and configure all dependencies manually following the [Substrate guide](https://substrate.dev/docs/en/knowledgebase/getting-started), or you could let this script do all the work for you:

```bash
$ curl https://getsubstrate.io -sSf | bash -s -- --fast
$ source ~/.cargo/env
```

## 02 Build {#02-build}

Build the Wasm and native execution environments:

```bash
# Fetch source of the latest stable release
$ git clone https://github.com/galacticcouncil/HydraDX-node -b stable

# Build the binary
$ cd HydraDX-node/
$ cargo build --release
```

You should be able to find the build under `./target/release/hydra-dx`.

## 03 Run {#03-run}

Before running your build you can purge any existing development chains on your machine (you will need to do this often in the development process):

```bash
$ ./target/release/hydra-dx purge-chain --dev
```

Run your build using one of the following commands:

```bash
$ ./target/release/hydra-dx --dev

# Run with detailed logging
$ RUST_LOG=debug RUST_BACKTRACE=1 ./target/release/hydra-dx -lruntime=debug --dev
```

## 04 Connect to your local chain instance {#04-connect-to-your-local-chain-instance}

You can connect to your HydraDX development node using Polkadot/apps and changing network to `Development`. You can also use this link:
https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A9944#/explorer

<img alt="connect to node" src={useBaseUrl('/building/connect-to-node.jpg')} />
67 changes: 67 additions & 0 deletions i18n/de/docusaurus-plugin-content-docs/current/identity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
id: identity
title: Set your Identity
---

import useBaseUrl from '@docusaurus/useBaseUrl';

Account holders have the possibility to set their identity by prodiving specific information and storing it on-chain. Besides that, the identity information can optionally be submitted to the HydraDX registrars for verification. By setting and verifying their identity, validators and nominators help safeguard the trust in the network.

:::note
If you are participating as a HydraDX validator we **highly recommend** that you both set your identity and undergo the verification process. Verified validators appear more trustworthy and attract more nominations, thereby increasing their chances to be included in the set of active validators.
:::

## 01 Set identity {#01-set-identity}

To set your identity, open Polkadot/apps (connected to *HydraDX Snakenet* network) and navigate to *My accounts*. Alternatively, you can follow this link:

https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frpc-01.snakenet.hydradx.io#/accounts

On the accounts page, locate the account holding your bonded HDX tokens. After that, click on the three dots next to the account (on the right side) and select *Set on-chain identity*.

<img alt="authorize" src={useBaseUrl('/identity/set-identity-1.jpg')} />

You will see a popup called *register identity*. Here, you can enter the following information:

* legal name
* email
* web address
* twitter
* riot name (in case you are using Matrix messaging)

In the last field of the popup, you can see the amount of HDX you need to deposit to store your identity information. You will receive this deposit back once you decide to clear your identity at a later point.

<img alt="authorize" src={useBaseUrl('/identity/set-identity-2.jpg')} />

After filling out the information, click on *Set Identity* and sign the transaction using the Polkadot.js browser extension. Once the transaction is confirmed, your identity is set.

## 02 Submit your identity for verification {#02-verify-identity}

After you have set your identity, you can submit it to the network registrars for verification. To do so, open Polkadot/apps and navigate to *Developer* > *Extrinsics*. Alternatively, you can follow this link:

https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frpc-01.snakenet.hydradx.io#/extrinsics

After selecting the relevant HydraDX account from the last step, you need to fill out the following information:

* **extrinsic**: identity
* **action**: requestJudgment
* **reg_index**: here you need to enter the ID of the registrar that you choose to carry out the verification.
HydraDX has 2 registrars: Simon Kraus - HydraSik (ID: **0**) and Jimmy Tudeski - stakenode (ID: **1**).
* **max_fee**: here you need to enter the maximum fee in HDX that you are willing to pay to the registrar for the verification. Only registrars with a fee below your max_fee will be eligible to carry out the verification.

To submit your verification request, click on *Submit Transaction* and sign the transaction.

<img alt="authorize" src={useBaseUrl('/identity/set-identity-3.jpg')} />

Please note that the process of identity verification may take some time to complete. To see the status of your request, navigate to **My accounts** and hover the section displaying your identity - you will see a popup showing the current status.

## 03 Outcome of the verification procedure {#03-verification-outcome}

After processing your verification request, the registrar will submit one of the following judgments which will become visible in your identity status:

* **Unknown** - default value, no judgment has been made yet.
* **Reasonable** - the provided information appears reasonable, however no in-depth checks were made.
* **KnownGood** - the information is correct.
* **OutOfDate** - the information was correct in the past but it is now out of date.
* **LowQuality** - the information is unprecise but it can be fixed by updating it.
* **Erroneous** - the provided information is wrong and might indicate a malicious intent.
36 changes: 36 additions & 0 deletions i18n/de/docusaurus-plugin-content-docs/current/staking_rewards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
id: staking_rewards
title: Staking Rewards
---

import useBaseUrl from '@docusaurus/useBaseUrl';

Staking rewards incentivize validators and nominators to [stake their HDX tokens](/staking). There are three types of staking rewards which are discussed in this article: [base rewards](#base-rewards), [era points](#era-points) and [tips](#tips).

## Base Rewards {#base-rewards}

At the end of every era (24h), all active validator pools receive base rewards in the form of HDX tokens. A validator pool consists of an elected validator (holding their self-staked HDX) and all active nominations which are backing the validator (for more information see [staking](/staking)). A central principle of the Nominated Proof-of-Stake (NPoS) consensus mechanism is that **equal work brings equal rewards**. In other words, since all validator pools essentially carry out the same work, **the available base rewards are divided equally** among them. This means that validator pools are **not** rewarded in proportion to their total stake, which is a major difference from traditional PoS networks.

The mechanism of sharing the base rewards equally among all participating validator pools contributes to the security of the network by preventing the concentration of power in a few validator pools, thereby strengthening decentralization. Over time, it incentivizes nominators to nominate validators with a smaller HDX stake. This process will eventually balance out the power relationships in the network and lead to a situation where all validator pools have roughly an equivalent amount of staked HDX.

The distribution of rewards takes place as follows. After calculating the (equal) amount of rewards for every validator pool, the validator receives its share in the form of **commission fees** for maintaining the node. As a second step, the remaining tokens are distributed among all stakes **proportionally** (including the self-stake of the validator). This means that higher stakes will receive a bigger proportion of the rewards which are attributed to the particular validator pool.

:::note
In our incentivized testnet called Snakenet, the amount of rewards received for staking your HDX tokens is estimated to be around **50% APY**.
:::

## Era points {#era-points}

Validators can earn additional rewards in proportion to the era points which they have gained in the past era. These rewards are added to the base rewards described above. Validators can earn era points by carrying out certain specific actions such as:

* producing a non-uncle block in the Relay Chain.
* producing a reference to a previously unreferenced uncle block.
* producing a referenced uncle block.

:::note
An uncle block is a Relay Chain block valid in every regard, which however has failed to become canonical. This can happen when two or more validators are block producers in a single slot, and the block produced by one validator reaches the next block producer before the others. The lagging blocks are called uncle blocks.
:::

## Tips {#tips}

Finally, validators can earn tips which are also added to the base rewards at the end of every era. Tips represent an additional transaction fee that can be optionally paid by users to give their transaction a higher priority.

0 comments on commit dfe2964

Please sign in to comment.