Skip to content

Commit

Permalink
improve doc, add genesis flag to solo (#712)
Browse files Browse the repository at this point in the history
* improve doc, add genesis flag to solo

* update docs

* add running mode to pub/authority nodes spec
  • Loading branch information
libotony authored Apr 25, 2024
1 parent d847c46 commit 863f794
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,11 @@

## Getting Started

VechainThor is the layer 1 blockchain, highly compatible with Ethereum, which powers the vechain ecosystem.
VechainThor is a public blockchain that is designed for mass adoption of blockchain technology by enterprise users of
VechainThor is the layer 1 blockchain, highly compatible with EVM<sup>*</sup>, which powers the vechain ecosystem.
VechainThor is a public blockchain that is designed for the mass adoption of blockchain technology by enterprise users of
all sizes and is intended to serve as a foundation for a sustainable and scalable enterprise blockchain ecosystem.

- † - VechainThor is currently up-to-date with the Ethereum's `Paris` hard fork, supporting Solidity version `0.8.18`.

>VechainThor is currently up-to-date with the EVM's `paris` hard fork, set [evmVersion](https://docs.soliditylang.org/en/latest/using-the-compiler.html#setting-the-evm-version-to-target) to `paris` if you are using solidity compiler version `0.8.20` or above.
___

## Documentation
Expand Down
18 changes: 10 additions & 8 deletions docs/hosting-a-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,40 +22,42 @@ ___

### System Requirements

#### Authority Master Nodes


#### Authority Nodes
Below spec is the node configured in full node without logs.

| Resource | Minimum Specification | Recommended Specification |
|-----------|-----------------------|---------------------------|
| CPU | 2 Core | 4 Core |
| RAM | 8 GB | 16 GB |
| Bandwidth | 10 Mbit | 20 Mbit |
| Disk | 500 GB SSD | 1 TB fast NVMe SSD |
| Disk | 300 GB NVMe SSD | 500 GB NVMe SSD |

#### Public Nodes

**Note**: For public nodes, it is essential to configure them with a robust and secure setup, including protection
against DDoS attacks and intrusion detection systems (IDS).

Below spec is the node configured in full archive node.

| Resource | Minimum Specification | Recommended Specification |
|-----------|-----------------------|---------------------------|
| CPU | 8 Core | 16 Core |
| RAM | 16 GB | 64 GB |
| Bandwidth | 10 Mbit | 20 Mbit |
| Disk | 500 GB SSD | 2 TB SSD |
| Disk | 600 GB SSD | 1 TB SSD |

___

### Important Considerations

#### Archive Node
#### Full Archive Node

An archive node is a full node that stores all historical data of the blockchain, containing complete historical data of
all transactions and blocks, including forks and variations. Running an archive node requires more resources than
A full archive node is a full node that stores all historical data of the blockchain, containing complete historical data of
all transactions and blocks, including forks and variations. Running a full archive node requires more resources than
running a regular full node, but it provides access to the complete history of the blockchain.

To run an archive node, you need to set the `--disable-pruner` flag when starting the node. For example:
To run a full archive node, you need to set the `--disable-pruner` flag when starting the node. For example:

```shell
bin/thor --network main --disable-pruner
Expand Down
5 changes: 2 additions & 3 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ ___
Start a discovery node:

```shell
disco --keyhex=99f0500549792796c14fed62011a51081dc5b5e68fe8bd8a13b86be829c4fd36
disco
```

Output:
Expand Down Expand Up @@ -160,7 +160,6 @@ bin/thor -h
| Flag | Description |
|-----------------------------|---------------------------------------------------------------------------------------------|
| `--network` | The network to join (main\|test) or path to the genesis file |
| `--config-dir` | The directory to use for common configuration files |
| `--data-dir` | Directory for blockchain databases |
| `--beneficiary` | Address for block rewards |
| `--api-addr` | API service listening address (default: "localhost:8669") |
Expand All @@ -176,7 +175,6 @@ bin/thor -h
| `--target-gas-limit` | Target block gas limit (adaptive if set to 0) (default: 0) |
| `--pprof` | Turn on go-pprof |
| `--skip-logs` | Skip writing event\|transfer logs (/logs API will be disabled) |
| `--verify-logs` | Verify the logs DB at startup |
| `--cache` | Megabytes of RAM allocated to trie nodes cache (default: 4096) |
| `--disable-pruner` | Disable state pruner to keep all history |
| `--bootnode` | Comma-separated list of bootnode IDs |
Expand All @@ -187,6 +185,7 @@ bin/thor -h

| Flag | Description |
|------------------------------|----------------------------------------------------|
| `--genesis` | Path to genesis file(default: builtin devnet) |
| `--on-demand` | Create new block when there is pending transaction |
| `--persist` | Save blockchain data to disk(default to memory) |
| `--gas-limit` | Gas limit for each block |
Expand Down

0 comments on commit 863f794

Please sign in to comment.