Skip to content

Commit

Permalink
Fix readme (#95)
Browse files Browse the repository at this point in the history
* Fix readme

* more readme fixes
  • Loading branch information
R-Santev authored Dec 20, 2024
1 parent e35caeb commit accb799
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,10 @@ The foundation of your validator identity is built upon three distinct private k
There are different options on how and where the secrets to be stored but we recommend storing the keys encrypted on your local file system and maintaining offline backups. To generate these keys, use the following command, which encrypts them locally:

```
hydra secrets init --chain-id 8844 --data-dir node-secrets
hydra secrets init --chain-id 4488 --data-dir node-secrets
```

This command initiates the creation of your node's secrets for a testnet chain with ID 8844, storing them in a directory named node-secrets. During this process, you'll confirm each secret and establish a password for file encryption.
This command initiates the creation of your node's secrets for the HydraChain with ID 4488, storing them in a directory named node-secrets. During this process, you'll confirm each secret and establish a password for file encryption.

Successful execution results in a summary of your generated and initialized secrets, including your public key (address), BLS public key, and node ID.

Expand Down Expand Up @@ -130,7 +130,7 @@ For more details on available commands and their usage, you can append the `--he

The genesis.json file is crucial, containing details about the genesis block and node configurations.
**Important: Do not alter this file to avoid potential loss of funds.**
Future releases will automate this configuration. You can find the Testnet genesis file in the extracted folder containing the [release assets](#executable) and place it in your node directory.
Future releases will automate this configuration. You can find the HydraChain genesis file in the extracted folder containing the [release assets](#executable) and place it in your node directory.

#### Secrets Configuration File

Expand All @@ -157,7 +157,7 @@ This process may take some time, as the node needs to fully sync with the blockc

After your node is operational and fully synced, you're ready to become a validator. This requires:

- Funding Your Account: Obtain sufficient Hydra by visiting the [Faucet](#faucet) section. You can obtain funds to a second metamask account and transfer them to the validator address. Or alternatively you can import the private key of your validator into Metamask to operate with it directly.
- (TestNet Only) Funding Your Account: Obtain sufficient Hydra by visiting the [Faucet](#faucet) section. You can obtain funds to a second metamask account and transfer them to the validator address. Or alternatively you can import the private key of your validator into Metamask to operate with it directly.

**Note:** Currently, you will have to import the validator's private key into Metamask to be able to interact with the web UI which can be considered as a security issue, but we will provide better option in the future.

Expand Down Expand Up @@ -236,7 +236,7 @@ hydra hydragon commission --data-dir ./node-secrets --claim true --jsonrpc http:
To reduce the risk of stalling caused by validators experiencing temporary issues or acting maliciously, we’ve implemented an ejection and ban mechanism. Anyone who recongizes a suspicious activity, and the rules are met, can execute the ban process. Below is an outline of how the system works (specific conditions are detailed in our [genesis contracts](https://github.com/Hydra-Chain/hydragon-core-contracts)):

1. **Initial Ejection**: If your validator stops proposing or participating in consensus whether due to hardware failure, software issues, or malicious intent—the ban procedure will be initiated. The validator will be ejected, allowing time for recovery. If no action is taken, a ban may follow. The threshold to trigger this process is initially set at 18,000 blocks (~2 hours), depending on block creation speed.
2. **Ban Procedure**: After ejection, you can rejoin by resolving the issue and running the appropriate command (explained [below](#re-activate)). However, if you fail to act within the final threshold (86,400 seconds or ~24 hours), your validator will be permanently banned. This will result in a penalty (currently 700 HYDRA) , a small reward for the reporter (currently 300 HYDRA; applied only if ban is executed by reporter different than the Governance), and the remaining funds being prepared for withdrawal. Once banned, you will no longer be able to participate as a validator.
2. **Ban Procedure**: After ejection, you can rejoin by resolving the issue and running the appropriate command (explained [below](#re-activate)). However, if you fail to act within the final threshold (86,400 seconds or ~24 hours), your validator will be permanently banned. This will result in a penalty (currently 1,000 HYDRA) , of which 700 HYDRA will be burned and a small reward for the reporter (currently 300 HYDRA; applied only if ban is executed by reporter different than the Governance), and the remaining funds being prepared for withdrawal.

#### Re-activate

Expand Down Expand Up @@ -313,7 +313,7 @@ Here are the Hydra Chain node CLI commands that currently can be used:

## Becoming a delegator

We've implemented the initial version of a straightforward dashboard, enabling users to connect their wallet, request testing HYDRA coins from our Faucet, and access to [delegation](#delegation) section where one can delegate funds to validators. To access the Dashboard Interface, please visit [testnetapp.hydrachain.org](https://testnetapp.hydrachain.org).
We've implemented the initial version of a straightforward Staking dashboard, where one can delegate funds to validators. To access the Dashboard Interface, please visit [stake.hydrachain.org](https://stake.hydrachain.org/).

### Adding Hydragon network to Metamask

Expand All @@ -327,37 +327,37 @@ In this section, we will explain how to add the Hydragon network to your Metamas
**Network name:**

```
Hydra Testnet (or any name that suits you)
Hydra Chain
```

**New RPC URL:**

```
https://rpc.testnet.hydrachain.org
https://rpc-mainnet.hydrachain.org
```

**Chain ID:**

```
8844
4488
```

**Currency symbol:**

```
tHYDRA
HYDRA
```

**Block explorer URL (Optional):**

```
https://hydragon.hydrachain.org
https://skynet.hydrachain.org
```

- Then, click `Save` to add the network.
- After performing the above steps, you will be able to see the custom network when you access the network selector (same as the first step).

### Faucet
### Faucet (TestNet Only)

In the Faucet section, users have the option to request a fixed amount of test HYDRA coins, granting them opportunity to explore the staking/delegation processes and other features. Please note that there will be a waiting period before users can request test tokens again.

Expand All @@ -370,7 +370,7 @@ In the Faucet section, users have the option to request a fixed amount of test H

In the Delegation section, users can interact with an intuitive UI to delegate to active validators. There are two types of delegation available: normal delegation, which can be undelegated at any time. It offers a fixed APR. There is also a vested position delegation, which includes a lockup mechanism. With vested delegation, users can potentially earn up to almost 80% APR, depending on different economical parameters. It's important to note that penalties apply for undelegating from a still active vested positions. More details regarding APR calculations and vested delegation can be found in our upcoming public paper. Here's how to proceed:

- Navigate to [testnetapp.hydrachain.org](https://testnetapp.hydrachain.org) to access the Delegation section of our platform. If you're already on the platform, you can find the `Delegation` section in the sidebar on the left.
- Navigate to [stake.hydrachain.org](https://stake.hydrachain.org) to access the Delegation section of our platform. If you're already on the platform, you can find the `Delegation` section in the sidebar on the left.

- Upon entering the Delegation section, you'll find an overview of your delegation, including the number of validators, the current APR, the total delegated HYDRA, and a table listing all the validators. Click on Actions (Details) in order to see more details for the selected validator.

Expand Down

0 comments on commit accb799

Please sign in to comment.