Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add nodes min requirements to the nodes doc main page #877

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/v3/documentation/infra/nodes/node-types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ Nodes perform different functions within the TON protocol:

Below, you will find more detailed information about each of these node types, as well as about interaction of full and archive nodes with client applications.

:::caution Node usage on personal local machine
You shouldn't run any type of node on your personal local machine for long, even if it satisfies the requirements. Nodes actively use disks and can damage them quickly.
:::

## Full Node

**Full node** is a basic node type within the TON blockchain.
Expand All @@ -22,6 +26,15 @@ Full nodes _prune_ the state of the TON blockchain kept by them - that means, ea

To allow client applications to look for blocks and transactions, as well as to send new transactions into the TON blockchain, full nodes are equipped with the liteserver functionality: see [Interacting with TON nodes](#interacting-with-ton-nodes) below.

### Hardware Requirements (without [validator](/v3/documentation/infra/nodes/node-types#validator-node))

- at least 16 cores CPU
- at least 128 GB RAM
- at least 1TB GB NVMe SSD _OR_ Provisioned 64+k IOPS storage
- 1 Gbit/s network connectivity
- 16 TB/month traffic on peak load
- public IP address (_fixed IP address_)


<Button href="/v3/guidelines/nodes/running-nodes/full-node#run-a-node-video"
colorType="primary" sizeType={'sm'}>
Expand All @@ -40,6 +53,15 @@ They serve as a backend for blockchain explorers and other applications relying
Archive nodes do not prune the blockchain state which elevates their system requirements, especially in terms of storage.
According to the latest estimations, while full nodes and validator nodes require about 1 TB disk space, archive nodes would require about 8 TB to store the complete block history.

### Hardware Requirements

- 16 x Cores CPU
- 128GB ECC Memory
- 9TB SSD _OR_ Provisioned 64+k IOPS storage
- 1 Gbit/s network connectivity
- 16 TB/month traffic on peak load
- a public IP address (fixed IP address)

<Button href="/v3/guidelines/nodes/running-nodes/archive-node"
colorType="primary" sizeType={'sm'}>
Running an Archive Node
Expand All @@ -56,6 +78,19 @@ To be entitled to propose and validate blocks, validators are elected by other p
As a rule, validator operators motivate other TON holders to stake with them to get passive income from resulting rewards.
In this way, validators ensure network stability, security and contribute to its growth.

### Hardware Requirements

- 16 cores CPU
- 128 GB RAM
- 1TB NVME SSD _OR_ Provisioned 64+k IOPS storage
- 1 Gbit/s network connectivity
- public IP address (_fixed IP address_)
- 100 TB/month traffic on peak load

> Typically you'll need at least a 1 Gbit/s connection to reliably accommodate peak loads (the average load is expected to be approximately 100 Mbit/s).

> We draw special attention of validators to IOPS disk requirements, it is crucially important for smooth network operation.

<Button href="/v3/guidelines/nodes/running-nodes/validator-node"
colorType="primary" sizeType={'sm'}>
Running a Validator Node
Expand Down
4 changes: 0 additions & 4 deletions docs/v3/guidelines/nodes/running-nodes/full-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@ We highly recommend installing MyTonCtrl using the supported operating systems:

## Hardware requirements

:::caution Node usage on personal local machine
You shouldn't run any type of node on your personal local machine for long, even if it satisfies the requirements. Nodes actively use disks and can damage them quickly.
:::

### With validator

- 16 cores CPU
Expand Down
2 changes: 1 addition & 1 deletion docs/v3/guidelines/nodes/running-nodes/validator-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

> We draw special attention of validators to IOPS disk requirements, it is crucially important for smooth network operation.

## Port Forwarding
### Port Forwarding

All types of nodes require a static external IP address, one UDP port to be forwarded for incoming connections and all outgoing connections to be open - the node uses random ports for new outgoing connections. It's necessarily for the node to be visible to the outside world over the NAT.

Expand Down
34 changes: 17 additions & 17 deletions sidebars/documentation.js
Original file line number Diff line number Diff line change
Expand Up @@ -189,23 +189,6 @@ module.exports = [
'type': 'html',
'value': '<span class=\'menu__link\'><b><small> Infrastructure Documentation </small></b></span>',
},
'v3/documentation/infra/minter-flow',
{
type: 'category',
label: 'Cross-chain Bridges',
items: [
{
type: 'doc',
label: 'Overview',
id: 'v3/documentation/infra/crosschain/overview',
},
{
type: 'doc',
label: 'Bridges Addresses',
id: 'v3/documentation/infra/crosschain/bridge-addresses',
},
],
},
{
type: 'category',
label: 'Blockchain Nodes',
Expand Down Expand Up @@ -235,6 +218,23 @@ module.exports = [
},
],
},
'v3/documentation/infra/minter-flow',
{
type: 'category',
label: 'Cross-chain Bridges',
items: [
{
type: 'doc',
label: 'Overview',
id: 'v3/documentation/infra/crosschain/overview',
},
{
type: 'doc',
label: 'Bridges Addresses',
id: 'v3/documentation/infra/crosschain/bridge-addresses',
},
],
},
{
'type': 'html',
'value': '<hr/>',
Expand Down