Skip to content

Commit 707f201

Browse files
rhazberriesgitbook-bot
authored andcommitted
GitBook: [master] 194 pages and 3 assets modified
1 parent 58c2ed5 commit 707f201

32 files changed

+659
-108
lines changed
Loading
Loading
Loading

SUMMARY.md

+13-14
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
* [Introduction](README.md)
44
* [Wallets](wallets/README.md)
5-
* [Harmony Wallet \(Harmony Browser Extension\)](wallets/chrome-extension.md)
6-
* [Trust Wallet](wallets/trustwallet.md)
75
* [Ledger](wallets/ledger/README.md)
86
* [Download & Setup](wallets/ledger/download-and-setup.md)
97
* [Ledger with HMY CLI](wallets/ledger/using-with-hmy-cli.md)
@@ -16,7 +14,8 @@
1614
* [Create/Import/Export Wallet](wallets/mathwallet/create-import-wallet.md)
1715
* [Sending Transactions via Math Wallet](wallets/mathwallet/send-tx.md)
1816
* [Staking Transactions via Math Wallet](wallets/mathwallet/staking-transactions.md)
19-
* [Command-line Tools](wallets/harmony-cli/README.md)
17+
* [Harmony Chrome Extension](wallets/chrome-extension.md)
18+
* [Harmony CLI](wallets/harmony-cli/README.md)
2019
* [Download & Setup](wallets/harmony-cli/download-setup.md)
2120
* [Create or Import Wallet](wallets/harmony-cli/create-import-wallet.md)
2221
* [Sending Transactions](wallets/harmony-cli/send-tx.md)
@@ -31,16 +30,17 @@
3130
* [Download & setup](wallets/safepal/download-and-setup.md)
3231
* [Create/import account](wallets/safepal/create-import-account.md)
3332
* [Send transaction](wallets/safepal/send-transaction.md)
33+
* [Trust Wallet](wallets/trustwallet.md)
3434
* [Wallet Management](wallets/wallet-management/README.md)
3535
* [Private Key Management](wallets/wallet-management/key-management.md)
36-
* [Missing Funds on Exchange](wallets/wallet-management/missing-funds-on-exchange.md)
36+
* [Missing Funds on Exchanges](wallets/wallet-management/missing-funds-on-exchange.md)
3737
* [Delegators](delegator/README.md)
3838
* [Staking Dashboard](delegator/staking-dashboard/README.md)
39+
* [Walkthrough](delegator/staking-dashboard/choosing-a-validator.md)
3940
* [Staking Transactions](delegator/staking-dashboard/staking-transactions.md)
4041
* [Sending Transactions](delegator/staking-dashboard/sending-transactions.md)
4142
* [Open Staking — Frequently Asked Questions](delegator/staking-dashboard/open-staking-frequently-asked-questions.md)
42-
* [Dashboard Walkthrough](delegator/choosing-a-validator.md)
43-
* [Delegation on Harmony \(video\)](delegator/delegator-journey.md)
43+
* [Informational Videos](delegator/delegator-journey.md)
4444
* [Validators](validators/README.md)
4545
* [Terms & Concepts](validators/definitions/README.md)
4646
* [Validator, BLS key, Instance](validators/definitions/validator-keys-and-bids/README.md)
@@ -79,21 +79,20 @@
7979
* [Changing Validator Information](validators/managing-your-validator/changing-validator-information.md)
8080
* [Delegating To A Validator](validators/managing-your-validator/delegating-to-a-validator.md)
8181
* [Undelegating From A Validator](validators/managing-your-validator/undelegating-to-a-validator.md)
82-
* [Seeing Stakers](validators/managing-your-validator/seeing-stakers.md)
82+
* [Check Your Delegations](validators/managing-your-validator/seeing-stakers.md)
8383
* [Collecting Rewards](validators/managing-your-validator/collecting-rewards.md)
8484
* [Adding A Validator Logo](validators/managing-your-validator/adding-a-validator-logo.md)
85-
* [Staking Dashboard](validators/staking-dashboard.md)
86-
* [Validator Info Doc](validators/validator-info-doc.md)
85+
* [Staking Dashboard Basics](validators/staking-dashboard.md)
86+
* [Validator Information Terms](validators/validator-info-doc.md)
87+
* [Validator Security Tips](validators/validator-security.md)
88+
* [Network Status Monitoring](validators/network-status.md)
8789
* [Troubleshooting](validators/validator-troubleshooting/README.md)
88-
* [Why am I not elected in the EPOS Committee](validators/validator-troubleshooting/why-am-i-not-elected-in-the-epos-committee.md)
90+
* [My validator is not elected](validators/validator-troubleshooting/why-am-i-not-elected-in-the-epos-committee.md)
8991
* [Frequently Asked Questions \(FAQ\)](validators/validator-troubleshooting/frequently-asked-questions-faq.md)
90-
* [Monitoring & Security](validators/extras/README.md)
91-
* [Validator Security](validators/extras/validator-security.md)
92-
* [Network Status](validators/extras/network-status.md)
9392
* [Tools](validators/tools/README.md)
9493
* [Telegram Bots](validators/tools/telegram-bots.md)
9594
* [Dashboards](validators/tools/dashboards.md)
96-
* [Calculators](validators/tools/calculators.md)
95+
* [Reward Calculators](validators/tools/calculators.md)
9796
* [Text User Interface \(TUI\)](validators/tools/text-user-interface-tui.md)
9897
* [Mobile Apps](validators/tools/mobile-apps/README.md)
9998
* [One Validator Dashboard](validators/tools/mobile-apps/one-validator-dashboard.md)

delegator/delegator-journey.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
description: How to maximize returns under the EPOS mechanism
2+
description: Media content for staking on Harmony
33
---
44

5-
# Delegation on Harmony \(video\)
5+
# Informational Videos
66

7-
Harmony's revolutionary Effective Proof of Stake mechanism \([https://youtu.be/M8c06bxWyQc](https://www.youtube.com/watch?v=M8c06bxWyQc)\) is the fairest yet for allowing open participation in a public blockchain.
87

9-
{% embed url="https://www.youtube.com/watch?time\_continue=4&v=k3cwL2tB3DI&feature=emb\_logo" caption="OPEN STAKING: The Delegator Journey on Harmony Protocol" %}
8+
9+
{% embed url="https://www.youtube.com/watch?time\_continue=4&v=k3cwL2tB3DI&feature=emb\_logo" caption="" %}
1010

1111
{% embed url="https://www.youtube.com/watch?v=U8\_6bJZqGpQ&list=PLAzkb1vJXQOR3ZEl25MKiz5-CMw6xVkaW&index=2" %}
1212

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Walkthrough
2+
3+
In order to choose their validators and manage their delegation, delegators have access to a range of information on the Staking Dashboard.
4+
5+
![Screen zoomed for demonstration purpose.](../../.gitbook/assets/image%20%28161%29.png)
6+
7+
| **Portfolio Page** | Delegators can claim full rewards and monitor validators in their delegation portfolio. |
8+
| :--- | :--- |
9+
| Staked | Amount of ONE delegated |
10+
| Available | Amount of ONE that available to delegate |
11+
| Rewards | Rewards yet to be claimed |
12+
| Portfolio allocation | Delegation amount across different validators |
13+
| Expected return | expected annual percentage return rate |
14+
| Returned in | Epochs left until undelegation funds will be accessible |
15+
| Reward \(up to date\) | Unclaimed rewards |
16+
| Status | Election status of the validator in current epoch |
17+
18+
19+
20+
![Screen shot is zoomed for demonstration purpose.](../../.gitbook/assets/image%20%2876%29.png)
21+
22+
| **Validator list** | Delegators can access necessary information of validators at a glance to choose desired validator\(s\). |
23+
| :--- | :--- |
24+
| Effective Median Stake | Median of ONE staked among the top elected slots |
25+
| Total Stake | Total ONE staked in the Harmony network |
26+
| Current block height | current block height of Harmony blockchain |
27+
| All | All validators created & listed onchain |
28+
| Elected | Validator currently selected & eligible to sign blocks & earn rewards |
29+
| Not Elected | Validator currently not-selected to sign blocks due to low stake or insufficient uptime |
30+
| Expected return | Expected annual return rate |
31+
| Stake | Total ONE staked by the validator |
32+
| Fees | Commission on rewards charged by validator |
33+
| Uptime \(AVG\) | Signing percentage for this validator's nodes |
34+
| Status | Election status of validator in current epoch |
35+
| Name | The validators' moniker |
36+
37+
38+
39+
![Screen zoomed for demonstration purpose.](../../.gitbook/assets/image%20%28171%29.png)
40+
41+
| **Validator Profile** | Delegators can check detailed information of a validator and delegate/undelegate this validator. |
42+
| :--- | :--- |
43+
| Delegated | Total ONE delegated to this validator |
44+
| Self stake | Amount of ONE staked by validator |
45+
| Max delegation | Maximum ONE stake allowed by the validator, including self-stake |
46+
| Validator since | Block number at which validator registered |
47+
| Fee | Commission on rewards charged by validator |
48+
| Max daily change | daily change in commission allowed for this validator |
49+
| Uptime \(AVG\) | Signing percentage for this validator's nodes |
50+
| Slots | Number of seats \(bls keys\) associated with the Validator |
51+
| Elected slots | Number of seats \(bls keys\) elected in the current committee |
52+
| Expected return | Expected annual return rate |
53+
| Lifetime rewards | all rewards collected by the validator |
54+
| Shards | Shards in which validator's BLS keys belong, shown order is based on time to add |
55+
| Stake & delegation history | Stake and delegation amount for the validator at every epoch |
56+
| Reward rate history | Expected annual percentage return rate for validator at every epoch |
57+
| Delegators | List of accounts that delegated to this validator and delegation amount |
58+
59+
60+
61+
![](../../.gitbook/assets/image%20%28186%29.png)
62+
63+
![](../../.gitbook/assets/image%20%28175%29.png)
64+
65+
| **Analytics** | Delegator can access both intuitive and statistical information on the stake distribution among validators and 4 shards. |
66+
| :--- | :--- |
67+
| Slots | The slots occupied by this validator |
68+
| Bid | Bid per BLS key |
69+
| Effective | Validator's effective ONE staked |
70+
| total | Validator's total ONE staked |
71+
| Self stake | Amount of ONE staked by validator |
72+

showcases/apps.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,11 @@ SoccerPlayers is an NFT collectible game deployed on Harmony blockchain. It is l
1515

1616
![](../.gitbook/assets/harmony-soccer-2.png)
1717

18-
19-
20-
## [OneMoji](https://peekpi.github.io/onemoji/dist/)**** <a id="onemoji"></a>
18+
## [OneMoji](https://peekpi.github.io/onemoji/dist/)
2119

2220
_Disclaimer: this game is ported from_ [_Nyftimoji_](https://niftymoji.com/)_, an Ethereum based game, for non-commercial purposes._
2321

24-
You can use 20 $one tokens to mint an emoji token \(HRC 721 token\) using smart contract. The lucky number you input and the block hash will decide which emoji you are going to get from a library of 3,470 emojis.
25-
26-
22+
You can use 20 $ONE tokens to mint an emoji token \(HRC 721 token\) using smart contract. The lucky number you input and the block hash will decide which emoji you are going to get from a library of 3,470 emojis.
2723

2824
![](../.gitbook/assets/onemoji-2%20%281%29.png)
2925

validators/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,3 @@ Harmony’s Effective Proof-of-Stake \(EPoS\) is the first staking mechanism in
2424

2525
{% page-ref page="validator-troubleshooting/" %}
2626

27-
{% page-ref page="extras/" %}
28-

validators/first-time-setup/creating-a-validator.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The CLI will prompt you to enter your BLS key file password.
3838

3939
`--name` will be the name displayed on the Staking Explorer **\(string\)**
4040

41-
`--identity` is additional information for the validator **\(string\)**
41+
`--identity` unique identifier for the validator **\(string\)**
4242

4343
`--details` is the description of the validator **\(string\)**
4444

@@ -63,7 +63,11 @@ The CLI will prompt you to enter your BLS key file password.
6363
{% endhint %}
6464

6565
{% hint style="info" %}
66-
rate, max-rate max-change-rate takes value between 0 and 1 with 0.1 = 10%
66+
`--rate`, `--max-rate`, and `--max-change-rate` accepts numbers between 0 and 1 representing percentages
67+
{% endhint %}
68+
69+
{% hint style="info" %}
70+
If you have a Keybase account, we recommend you use your Keybase public key fingerprint as your validator's identity. The field is unique, ensuring that other validator's can not attempt to impersonate you. This data will also help with some awesome integrations & features in the future!
6771
{% endhint %}
6872

6973
### When does the validator participate in election? <a id="when-does-the-validator-become-active"></a>
@@ -83,15 +87,15 @@ Example output:
8387
```
8488

8589
{% hint style="warning" %}
86-
If you don't want to participate in the election anymore, you can turn your validator inactive using an [Edit Validator transaction](https://docs.harmony.one/home/validators/managing-your-validator/changing-validator-information) with`--active false.`
90+
If you do not wish to participate anymore, you can turn your validator inactive using an [Edit Validator transaction](https://docs.harmony.one/home/validators/managing-your-validator/changing-validator-information) with`--active false.`
8791
{% endhint %}
8892

8993
## Checking Validator Information <a id="checking-validator-information"></a>
9094

91-
Use the format command **./hmy --node="https://api.s0.t.hmny.io" blockchain validator information \[ONE ADDRESS\]** to check your validator information:
95+
Example command:
9296

9397
```bash
94-
./hmy --node="https://api.s0.t.hmny.io" blockchain validator information one1u6c4wer2dkm767hmjeehnwu6tqqur62gx9vqsd
98+
./hmy blockchain validator information one1u6c4wer2dkm767hmjeehnwu6tqqur62gx9vqsd --node="https://api.s0.t.hmny.io"
9599
```
96100

97101
Example output:
@@ -175,7 +179,7 @@ Example output:
175179
```
176180

177181
{% hint style="warning" %}
178-
If your validator does not sign more than 2/3 of the blocks in an epoch, the validator will be removed from the pool of eligible validators.
182+
If your validator has signed less than 66% of the blocks in an epoch, it will be removed from the pool of eligible validators.
179183

180184
In order to be included in the pool again, you will have to use send an [Edit Validator transaction](creating-a-validator.md) with `--active true`.
181185
{% endhint %}
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Upload a custom logo to be displayed on your Staking Dashboard profile
3+
---
4+
15
# Adding A Validator Logo
26

37
### Uploading A Custom Logo <a id="uploading-a-custom-logo"></a>
@@ -6,13 +10,17 @@
610

711
2. Add your logo by creating the logo image name using your Harmony one address as the file name and placing it inside "validators" folder. The logo image needs to be a .jpg file with 256x256 pixels or 512x512 pixels.
812

9-
Exemple: validators/one1pdv9lrdwl0rg5vglh4xtyrv3wjk3wsqket7zxy.jpg
13+
Example: validators/one1pdv9lrdwl0rg5vglh4xtyrv3wjk3wsqket7zxy.jpg
1014

1115
{% hint style="danger" %}
12-
Do not upload the .jpg file name in the root repository. It needs be be inside folder "validators".
16+
Do not upload the .jpg file in the main repository directory. It must be inside the "validators" directory.
1317
{% endhint %}
1418

1519
3. Create a pull request for your changes. A Harmony team member will review the image & approve it.
1620

1721
![](https://blobs.gitbook.com/assets%2F-M-IDt7HenNiPUXWT_3k%2F-M1q8Eka44xqHjcC7U5S%2F-M1qUcrcCDBse9V2-zhm%2FScreen%20Shot%202020-03-07%20at%2011.34.55%20AM.png?alt=media&token=1c53a6a9-ce60-414e-9c57-21f9d6e7b731)
1822

23+
### Keybase
24+
25+
If you have a Keybase account & have put your PGP public key finger print as your "identity", your Keybase profile picture will automatically be used for your validator image!
26+

validators/managing-your-validator/changing-validator-information.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: How to update your validator information
3+
---
4+
15
# Changing Validator Information
26

37
You can edit your validator’s information using the CLI with the following command.
@@ -38,8 +42,8 @@ Sending the command without the arguments will leave those fields of your valida
3842
{% endhint %}
3943

4044
{% hint style="danger" %}
41-
`--max-rate` and `--max-change-rate` cannot be changed later.
45+
`--max-rate` and `--max-change-rate` cannot be changed after creation.
4246

43-
`--min-self-delegation` has to be at least 10,000 ONE.
47+
`--min-self-delegation` must be minimum 10,000 ONE.
4448
{% endhint %}
4549

validators/managing-your-validator/checking-validator-information.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: How to see your current validator information
3+
---
4+
15
# Checking Validator Information
26

37
## Using the Binary:
@@ -97,6 +101,6 @@
97101
{% hint style="warning" %}
98102
If your validator does not sign more than 2/3 of the blocks in an epoch, the validator will be removed from the pool of eligible validators.
99103

100-
In order to be included in the pool again, you will have to use send an [Edit Validator transaction](https://docs.harmony.one/validators/validator/managing-your-validator/changing-your-validator-profile) with `--active true.`
104+
In order to be included in the pool again, you will have to use send an [Edit Validator transaction](changing-validator-information.md) with `--active true.`
101105
{% endhint %}
102106

validators/managing-your-validator/collecting-rewards.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1+
---
2+
description: How to collect your rewards
3+
---
4+
15
# Collecting Rewards
26

3-
You can collect your block rewards with the following command.
7+
You can collect your rewards with the following command.
48

59
## Using the Binary:
610

validators/managing-your-validator/delegating-to-a-validator.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: How to delegate tokens to a validator
3+
---
4+
15
# Delegating To A Validator
26

37
You can delegate tokens to a validator using the following command.

validators/managing-your-validator/seeing-stakers.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,27 @@
1-
# Seeing Stakers
1+
---
2+
description: How to see your delegators
3+
---
4+
5+
# Check Your Delegations
26

37
You can see the number of delegations to your validator with the following command.
48

59
## Using the Binary:
610

711
```bash
8-
./hmy --node="https://api.s0.t.hmny.io" blockchain delegation by-validator [VALIDATOR ADDRESS]
12+
./hmy blockchain delegation by-validator [VALIDATOR ADDRESS] --node="https://api.s0.t.hmny.io"
913
```
1014

1115
## Using the Shell Wrapper:
1216

1317
```bash
14-
./hmy.sh -- node="https://api.s0.t.hmny.io" blockchain delegation by-validator [VALIDATOR ADDRESS]
18+
./hmy.sh -- blockchain delegation by-validator [VALIDATOR ADDRESS] --node="https://api.s0.t.hmny.io"
1519
```
1620

17-
### Example:
21+
## Example:
1822

1923
```bash
20-
./hmy node="https://api.s0.t.hmny.io" blockchain delegation by-validator one1km7xg8e3xjys7azp9f4xp8hkw79vm2h3f2lade
24+
./hmy blockchain delegation by-validator one1km7xg8e3xjys7azp9f4xp8hkw79vm2h3f2lade --node="https://api.s0.t.hmny.io"
2125
```
2226

2327
#### Output:

validators/managing-your-validator/undelegating-to-a-validator.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: How to undelegate your tokens from a validator
3+
---
4+
15
# Undelegating From A Validator
26

37
You can un-delegate tokens from a validator using the following command:

validators/network-status.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Network Status Monitoring
2+
3+
You can check the status of Harmony Mainnet & Testnet [here](https://monitor.hmny.io/status)!
4+
5+
6+
7+
8+

validators/staking-dashboard.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
1-
# Staking Dashboard
1+
# Staking Dashboard Basics
22

33
Here is the Staking Explorer link: [https://staking.harmony.one/welcome](https://staking.harmony.one/welcome)
44

55
![](../.gitbook/assets/image%20%28137%29.png)
66

7-
Using the Staking Explorer is an easy way to stake, delegate, send funds and control all information associated with the validators.
7+
The Staking Explorer is an easy way to stake, delegate, send funds and view all information of Harmony validators.
88

9-
First you need to login into an account , you can create new address or using an existing address, for example your validator account that you created using CLI
9+
You can explore the dashboard without using your ONE address, but the ONE address you use will be used for any transactions.
10+
11+
You can log into an account using the Harmony Chrome Extension, MathWallet Chrome Extension, or Ledger Nano S.
1012

1113
![](../.gitbook/assets/image%20%2874%29.png)
1214

13-
After you login, there are several option available, for example you can check all available validators that you can delegate
15+
After logging in, you can view network analytics, a list of validators, validator profiles, and other information to help you decide who to delegate to.
1416

1517
![](../.gitbook/assets/image%20%2898%29.png)
1618

17-
For each transation/delegation you will need to confirm it, for that you can use several ways, using Harmony Browser Extension or ledger nano S.
19+
Every transaction or delegation must be signed. You can use the Harmony Chrome Extension, which supports Ledger Nano S.
1820

1921
**Harmony Browser Extension:** [https://docs.harmony.one/home/wallets/chrome-extension](https://docs.harmony.one/home/wallets/chrome-extension)
2022

0 commit comments

Comments
 (0)