Skip to content

Commit d0a1fcc

Browse files
authored
Merge pull request 0LNetworkCommunity#133 from petticur/add-network-diagram
Add network architecture page
2 parents 0c021fe + 3a938e3 commit d0a1fcc

File tree

3 files changed

+24
-0
lines changed

3 files changed

+24
-0
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Network Architecture
2+
There are three types of note in the network. All nodes run the same binary software. The difference between node types is
3+
by configuration and the arrangement of network connectivity.
4+
* Validator Node (VN): A node controlled by an on-chain account that is in the set of currently active validators.
5+
The purpose of VNs is to provide chain consensus and to maintain authoratitive chain state.
6+
Validator nodes communicate with each other to
7+
maintain consensus and propagate new transactions. Validator node p2p networking is permissioned: a connection not originating from another validator node
8+
will not succeed.
9+
* Validator Full Node (VFN): A node run in association with a VN, controlled by the same account.
10+
The role of the VFN is to provide p2p service to other "downstream" nodes that in turn provide services to users.
11+
The purpose of the VFN as a distinct concept from the VN is to act as a
12+
resource isolation mechanism between the VN and Full Nodes (see below). VFNs receive new chain state from their peer VN and propagate
13+
that new chain state "downstream" to FNs. Resource isolation is achieved by only allowing connections
14+
on a non-permissioned p2p network to VNs to come from the peer VFN. Because VNs provide no p2p service except to peer validators,
15+
the VFN is the only route by which network state propagates from VNs out to users connected to FNs.
16+
* Full Node (FN): A node run by any entity wishing to provide API service. API service is used by end-users e.g. wallet users and commercial services
17+
such as explorers and chain data indexers. Full Nodes may peer with VFNs to receive new chain state, or with other nodes known to the operators.
18+
Full Nodes are the only providers of API service to any client anywhere in the network.
19+
20+
The diagram below illustrates the arrangement of node types showing their network configuration:
21+
![Network Diagram](/img/node-network-details.png "Network Diagram")
22+
More text

sidebars.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ const sidebars = {
3737
items: [
3838
'guides/node-operators/validators/validator-quickstart',
3939
'guides/node-operators/validators/detailed-instructions',
40+
4041
'guides/node-operators/validators/governance-tx',
4142
'guides/node-operators/validators/hot-upgrades',
4243
'guides/node-operators/validators/network-health',
@@ -45,6 +46,7 @@ const sidebars = {
4546
'guides/node-operators/validators/sybil-resistance',
4647
'guides/node-operators/validators/vfn-setup',
4748
'guides/node-operators/validators/with-docker-setup',
49+
'guides/node-operators/validators/network-architecture',
4850
{
4951
type: 'category',
5052
label: 'YAML templates',
169 KB
Loading

0 commit comments

Comments
 (0)