Skip to content

Commit edd36f4

Browse files
committed
update formatting for the infra section
1 parent 0ea64f7 commit edd36f4

File tree

15 files changed

+190
-189
lines changed

15 files changed

+190
-189
lines changed

infrastructure/index.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,33 @@ template: index-page.html
88

99
Running infrastructure on Polkadot is essential to supporting the network’s performance and security. Operators must focus on reliability, ensure proper configuration, and meet the necessary hardware requirements to contribute effectively to the decentralized ecosystem.
1010

11-
- Not sure where to start? Visit the [Choosing the Right Role](#choosing-the-right-role) section for guidance
12-
- Ready to get started? Jump to [In This Section](#in-this-section) to get started
11+
- Not sure where to start? Visit the [Choosing the Right Role](#choosing-the-right-role) section for guidance.
12+
- Ready to get started? Jump to [In This Section](#in-this-section) to get started.
1313

1414
## Choosing the Right Role
1515

1616
Selecting your role within the Polkadot ecosystem depends on your goals, resources, and expertise. Below are detailed considerations for each role:
1717

1818
- **Running a node**:
19-
- **Purpose** - a node provides access to network data and supports API queries. It is commonly used for:
20-
- **Development and testing** - offers a local instance to simulate network conditions and test applications
21-
- **Production use** - acts as a data source for dApps, clients, and other applications needing reliable access to the blockchain
22-
- **Requirements** - moderate hardware resources to handle blockchain data efficiently
23-
- **Responsibilities** - a node’s responsibilities vary based on its purpose:
24-
- **Development and testing** - enables developers to test features, debug code, and simulate network interactions in a controlled environment
25-
- **Production use** - provides consistent and reliable data access for dApps and other applications, ensuring minimal downtime
19+
- **Purpose**: A node provides access to network data and supports API queries. It is commonly used for.
20+
- **Development and testing**: Offers a local instance to simulate network conditions and test applications.
21+
- **Production use**: Acts as a data source for dApps, clients, and other applications needing reliable access to the blockchain.
22+
- **Requirements**: Moderate hardware resources to handle blockchain data efficiently.
23+
- **Responsibilities**: A node’s responsibilities vary based on its purpose.
24+
- **Development and testing**: Enables developers to test features, debug code, and simulate network interactions in a controlled environment.
25+
- **Production use**: Provides consistent and reliable data access for dApps and other applications, ensuring minimal downtime.
2626

2727
- **Running a validator**:
28-
- **Purpose** - validators play a critical role in securing the Polkadot relay chain. They validate parachain block submissions, participate in consensus, and help maintain the network's overall integrity
29-
- **Requirements** - becoming a validator requires:
30-
- **Staking** - a variable amount of DOT tokens to secure the network and demonstrate commitment
31-
- **Hardware** - high-performing hardware resources capable of supporting intensive blockchain operations
32-
- **Technical expertise** - proficiency in setting up and maintaining nodes, managing updates, and understanding Polkadot's consensus mechanisms
33-
- **Community involvement** - building trust and rapport within the community to attract nominators willing to stake with your validator
34-
- **Responsibilities** - validators have critical responsibilities to ensure network health:
35-
- **Uptime** - maintain near-constant availability to avoid slashing penalties for downtime or unresponsiveness
36-
- **Network security** - participate in consensus and verify parachain transactions to uphold the network's security and integrity
37-
- **Availability** - monitor the network for events and respond to issues promptly, such as misbehavior reports or protocol updates
28+
- **Purpose**: Validators play a critical role in securing the Polkadot relay chain. They validate parachain block submissions, participate in consensus, and help maintain the network's overall integrity.
29+
- **Requirements**: Becoming a validator requires.
30+
- **Staking**: A variable amount of DOT tokens to secure the network and demonstrate commitment.
31+
- **Hardware**: High-performing hardware resources capable of supporting intensive blockchain operations.
32+
- **Technical expertise**: Proficiency in setting up and maintaining nodes, managing updates, and understanding Polkadot's consensus mechanisms.
33+
- **Community involvement**: Building trust and rapport within the community to attract nominators willing to stake with your validator.
34+
- **Responsibilities**: Validators have critical responsibilities to ensure network health.
35+
- **Uptime**: Maintain near-constant availability to avoid slashing penalties for downtime or unresponsiveness.
36+
- **Network security**: Participate in consensus and verify parachain transactions to uphold the network's security and integrity.
37+
- **Availability**: Monitor the network for events and respond to issues promptly, such as misbehavior reports or protocol updates.
3838

3939
## In This Section
4040

infrastructure/running-a-node/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ Running a node on the Polkadot network enables you to access blockchain data, in
1212

1313
Full nodes and bootnodes serve different roles within the network, each contributing in unique ways to connectivity and data access:
1414

15-
- **Full node** - stores blockchain data, validates transactions, and can serve as a source for querying data
16-
- **Bootnode** - assists new nodes in discovering peers and connecting to the network, but doesn’t store blockchain data
15+
- **Full node**: Stores blockchain data, validates transactions, and can serve as a source for querying data.
16+
- **Bootnode**: Assists new nodes in discovering peers and connecting to the network, but doesn’t store blockchain data.
1717

1818
The following sections describe the different types of full nodes—pruned, archive, and light nodes—and the unique features of each for various use cases.
1919

2020
## Types of Full Nodes
2121

2222
The three main types of nodes are as follows:
2323

24-
- **Pruned node** - prunes historical states of all finalized block states older than a specified number except for the genesis block's state
25-
- **Archive node** - preserves all the past blocks and their states, making it convenient to query the past state of the chain at any given time. Archive nodes use a lot of disk space, which means they should be limited to use cases that require easy access to past on-chain data, such as block explorers
26-
- **Light node** - has only the runtime and the current state but doesn't store past blocks, making them useful for resource-restricted devices
24+
- **Pruned node**: Prunes historical states of all finalized block states older than a specified number except for the genesis block's state.
25+
- **Archive node**: Preserves all the past blocks and their states, making it convenient to query the past state of the chain at any given time. Archive nodes use a lot of disk space, which means they should be limited to use cases that require easy access to past on-chain data, such as block explorers.
26+
- **Light node**: Has only the runtime and the current state but doesn't store past blocks, making them useful for resource-restricted devices.
2727

2828
Each node type can be configured to provide remote access to blockchain data via RPC endpoints, allowing external clients, like dApps or developers, to submit transactions, query data, and interact with the blockchain remotely.
2929

@@ -34,8 +34,8 @@ Each node type can be configured to provide remote access to blockchain data via
3434

3535
A pruned node retains only a subset of finalized blocks, discarding older data. The two main types of pruning are:
3636

37-
- **State pruning** - removes the states of old blocks while retaining block headers
38-
- **Block pruning** - removes both the full content of old blocks and their associated states, but keeps the block headers
37+
- **State pruning**: Removes the states of old blocks while retaining block headers.
38+
- **Block pruning**: Removes both the full content of old blocks and their associated states, but keeps the block headers.
3939

4040
Despite these deletions, pruned nodes are still capable of performing many essential functions, such as displaying account balances, making transfers, setting up session keys, and participating in staking.
4141

infrastructure/running-a-node/setup-bootnode.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ This guide will walk you through setting up a Polkadot bootnode, configuring P2P
1515

1616
Before you start, you need to have the following prerequisites:
1717

18-
- Verify a working Polkadot (`polkadot`) binary is available on your machine
19-
- Ensure you have nginx installed. Please refer to the [Installation Guide](https://nginx.org/en/docs/install.html){target=\_blank} for help with installation if needed
20-
- A VPS or other dedicated server setup
18+
- Verify a working Polkadot (`polkadot`) binary is available on your machine.
19+
- Ensure you have nginx installed. Please refer to the [Installation Guide](https://nginx.org/en/docs/install.html){target=\_blank} for help with installation if needed.
20+
- A VPS or other dedicated server setup.
2121

2222
## Accessing the Bootnode
2323

2424
Bootnodes must be accessible through three key channels to connect with other nodes in the network:
2525

26-
- **P2P** - a direct peer-to-peer connection, set by:
26+
- **P2P**: A direct peer-to-peer connection, set by.
2727

2828
```bash
2929

@@ -33,8 +33,8 @@ Bootnodes must be accessible through three key channels to connect with other no
3333

3434
This is not enabled by default on non-validator nodes like archive RPC nodes.
3535

36-
- **P2P/WS** - a WebSocket (WS) connection, also configured via `--listen-addr`
37-
- **P2P/WSS** - a secure WebSocket (WSS) connection using SSL, often required for light clients. An SSL proxy is needed, as the node itself cannot handle certificates
36+
- **P2P/WS**: A WebSocket (WS) connection, also configured via `--listen-addr`.
37+
- **P2P/WSS**: A secure WebSocket (WSS) connection using SSL, often required for light clients. An SSL proxy is needed, as the node itself cannot handle certificates.
3838

3939
## Node Key
4040

infrastructure/running-a-node/setup-full-node.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Now that you're familiar with the different types of nodes, this section will wa
2121

2222
Before getting started, ensure the following prerequisites are met:
2323

24-
- Ensure [Rust](https://www.rust-lang.org/tools/install){target=\_blank} is installed on your operating system
24+
- Ensure [Rust](https://www.rust-lang.org/tools/install){target=\_blank} is installed on your operating system.
2525
- [Install the necessary dependencies for the Polkadot SDK](/develop/parachains/install-polkadot-sdk/){target=\_blank}
2626

2727
!!! warning
@@ -73,8 +73,8 @@ This section will walk you through installing and building the Polkadot binary f
7373

7474
Once installed, you have a couple options for installing the Polkadot binary:
7575

76-
- If Rust is installed, then `cargo` can be used similar to the macOS instructions
77-
- Or, the instructions in the Linux section can be used
76+
- If Rust is installed, then `cargo` can be used similar to the macOS instructions.
77+
- Or, the instructions in the Linux section can be used.
7878

7979
??? interface "Linux (pre-built binary)"
8080

@@ -255,9 +255,9 @@ Once you've fully configured your start-up command, you can execute it in your t
255255

256256
The node startup settings allow you to choose what to expose, how many connections to expose, and which systems should be granted access through the RPC server.
257257

258-
- You can limit the methods to use with `--rpc-methods`; an easy way to set this to a safe mode is `--rpc-methods safe`
259-
- You can set your maximum connections through `--rpc-max-connections`, for example, `--rpc-max-connections 200`
260-
- By default, localhost and Polkadot.js can access the RPC server. You can change this by setting `--rpc-cors`. To allow access from everywhere, you can use `--rpc-cors all`
258+
- You can limit the methods to use with `--rpc-methods`; an easy way to set this to a safe mode is `--rpc-methods safe`.
259+
- You can set your maximum connections through `--rpc-max-connections`, for example, `--rpc-max-connections 200`.
260+
- By default, localhost and Polkadot.js can access the RPC server. You can change this by setting `--rpc-cors`. To allow access from everywhere, you can use `--rpc-cors all`.
261261

262262
For a list of important flags when running RPC nodes, refer to the Parity DevOps documentation: [Important Flags for Running an RPC Node](https://paritytech.github.io/devops-guide/guides/rpc_index.html?#important-flags-for-running-an-rpc-node){target=\_blank}.
263263

infrastructure/running-a-node/setup-secure-wss.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Apache2 can run in various modes, including `prefork`, `worker`, and `event`. In
8282
8383
## Connect to the Node
8484
85-
1. Open [Polkadot.js Apps interface](https://polkadot.js.org/apps){target=\_blank} and click the logo in the top left to switch the node
85+
1. Open [Polkadot.js Apps interface](https://polkadot.js.org/apps){target=\_blank} and click the logo in the top left to switch the node.
8686
2. Activate the **Development** toggle and input either your node's domain or IP address. Remember to prefix with `wss://` and, if you're using the 443 port, append `:443` as follows:
8787
8888
```bash

infrastructure/running-a-validator/onboarding-and-offboarding/key-management.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ There are multiple ways to create the session keys. It can be done by interactin
1919

2020
=== "Polkadot.js Apps UI"
2121

22-
1. In Polkadot.js Apps, connect to your local node, navigate to the **Developer** dropdown, and select the **RPC Calls** option
22+
1. In Polkadot.js Apps, connect to your local node, navigate to the **Developer** dropdown, and select the **RPC Calls** option.
2323

24-
2. Construct an `author_rotateKeys` RPC call and execute it
24+
2. Construct an `author_rotateKeys` RPC call and execute it:
2525

26-
1. Select the **author** endpoint
27-
2. Choose the **rotateKeys()** call
28-
3. Click the **Submit RPC Call** button
29-
4. Copy the hex-encoded public key from the response
26+
1. Select the **author** endpoint.
27+
2. Choose the **rotateKeys()** call.
28+
3. Click the **Submit RPC Call** button.
29+
4. Copy the hex-encoded public key from the response.
3030

3131
![](/images/infrastructure/running-a-validator/onboarding-and-offboarding/key-management/key-management-1.webp)
3232

@@ -72,9 +72,9 @@ There are multiple ways to create the session keys. It can be done by interactin
7272

7373
Now that you have generated your session keys, you must submit them to the chain. Follow these steps:
7474

75-
1. Go to the **Network > Staking > Accounts** section on Polkadot.js Apps
76-
2. Select **Set Session Key** on the bonding account you generated earlier
77-
3. Paste the hex-encoded session key string you generated (from either the UI or CLI) into the input field and submit the transaction
75+
1. Go to the **Network > Staking > Accounts** section on Polkadot.js Apps.
76+
2. Select **Set Session Key** on the bonding account you generated earlier.
77+
3. Paste the hex-encoded session key string you generated (from either the UI or CLI) into the input field and submit the transaction.
7878

7979
![](/images/infrastructure/running-a-validator/onboarding-and-offboarding/key-management/key-management-2.webp)
8080

@@ -84,8 +84,8 @@ Once the transaction is signed and submitted, your session keys will be register
8484

8585
To verify that your session keys are properly set, you can use one of two RPC calls:
8686

87-
- **`hasKey`** - checks if the node has a specific key by public key and key type
88-
- **`hasSessionKeys`** - verifies if your node has the full session key string associated with the validator
87+
- **`hasKey`**: Checks if the node has a specific key by public key and key type.
88+
- **`hasSessionKeys`**: Verifies if your node has the full session key string associated with the validator.
8989

9090
For example, you can [check session keys on the Polkadot.js Apps](https://polkadot.js.org/apps/#/rpc){target=\_blank} interface or by running an RPC query against your node. Once this is done, your validator node is ready for its role.
9191

0 commit comments

Comments
 (0)