feat: connect to external network docs #73
Conversation
WalkthroughThe changes introduce new documentation for connecting the SettleMint platform to external networks, specifically Hyperledger Besu and Quorum. A new guide details prerequisites, steps for joining networks, and procedures for managing nodes and validators. Additionally, minor textual modifications enhance clarity in an existing document about connecting to external nodes, including a title change and updates to function references. Changes
TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Reviewer's Guide by SourceryThis pull request adds documentation for connecting to an external network in Hyperledger Besu or Quorum OBFT, and updates the existing guide for connecting to an external node. The changes provide detailed instructions on joining an external network, adding nodes, and managing validators within the SettleMint platform. File-Level Changes
Tips
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @snigdha920 - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Review instructions: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 3 issues found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md
Outdated
Show resolved
Hide resolved
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-network.md
Outdated
Show resolved
Hide resolved
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-network.md
Outdated
Show resolved
Hide resolved
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (3)
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-network.md (3)
11-20: LGTM, but consider rephrasing for conciseness.The "Join a network" section provides clear and easy-to-follow instructions for joining a network.
However, consider rephrasing the following sentence for conciseness:
- Choose Hyperledger Besu or Quorum depending on the network you want to join
-3. Choose **Hyperledger Besu** or **Quorum** depending on the network you want to join +3. Choose **Hyperledger Besu** or **Quorum** based on your networkTools
LanguageTool
[style] ~15-~15: Consider using an alternative to strengthen your wording.
Context: ...Quorum depending on the network you want to join 4. Enter a name for the network...(WANT_KEEN)
23-32: LGTM, but consider rephrasing for conciseness.The "Adding nodes" section provides important information on adding nodes to the network and explains the concept of a majority of validators.
However, consider rephrasing the following sentences for conciseness:
You can have a majority of validators running on the platform by first, creating the nodes as non-validators, and then sending votes on the externally running validator nodes to add the platform node as a validator.
Deploying a new node as a validator will fail if a majority of validators are not running on the platform.
Once there is a majority of validators running on the platform, deploying new nodes as validators is possible without having to vote on externally running nodes. We recommend you to have a majority of validators running on the platform to be able to seamlessly add and remove validators from the network.
-You can have a majority of validators running on the platform by first, creating the nodes as non-validators, and then sending votes on the externally running validator nodes to add the platform node as a validator. +You can achieve a validator majority on the platform by first creating non-validator nodes, then voting from external validator nodes to add the platform node as a validator. -Deploying a new node as a validator will fail if a majority of validators are not running on the platform. +Deploying a new validator node will fail without a validator majority on the platform. -Once there is a majority of validators running on the platform, deploying new nodes as validators is possible without having to vote on externally running nodes. We recommend you to have a majority of validators running on the platform to be able to seamlessly add and remove validators from the network. +With a validator majority on the platform, you can deploy new validator nodes without external votes. We recommend maintaining a validator majority on the platform for seamless validator management.Tools
LanguageTool
[style] ~25-~25: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...s as validators, you first need to have a majority of validators running on the platform. A m...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~25-~25: ‘A majority of’ might be wordy. Consider a shorter alternative.
Context: ... of validators running on the platform. A majority of validators is defined as 66% of the tot...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~27-~27: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...alidators on the network. You can have a majority of validators running on the platform by f...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~29-~29: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ... a new node as a validator will fail if a majority of validators are not running on the platf...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~31-~31: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...running on the platform. Once there is a majority of validators running on the platform, dep...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~31-~31: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...running nodes. We recommend you to have a majority of validators running on the platform to b...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
33-40: LGTM, but consider rephrasing for conciseness.The "Adding a validator in the platform" section provides clear and easy-to-follow instructions for adding a validator in the platform.
However, consider rephrasing the following sentence for conciseness:
Unless there are a majority of validators running on the platform, you need to send votes on the externally running validator nodes to add the platform node as a validator.
-Unless there are a majority of validators running on the platform, you need to send votes on the externally running validator nodes to add the platform node as a validator. +Without a validator majority on the platform, you must vote from external validator nodes to add the platform node as a validator.Tools
LanguageTool
[style] ~35-~35: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...dator in the platform Unless there are a majority of validators running on the platform, you...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-network.md (1 hunks)
- docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md (2 hunks)
Files skipped from review due to trivial changes (1)
- docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md
Additional context used
LanguageTool
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-network.md
[style] ~15-~15: Consider using an alternative to strengthen your wording.
Context: ...Quorum depending on the network you want to join 4. Enter a name for the network...(WANT_KEEN)
[style] ~25-~25: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...s as validators, you first need to have a majority of validators running on the platform. A m...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~25-~25: ‘A majority of’ might be wordy. Consider a shorter alternative.
Context: ... of validators running on the platform. A majority of validators is defined as 66% of the tot...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~27-~27: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...alidators on the network. You can have a majority of validators running on the platform by f...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~29-~29: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ... a new node as a validator will fail if a majority of validators are not running on the platf...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~31-~31: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...running on the platform. Once there is a majority of validators running on the platform, dep...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~31-~31: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...running nodes. We recommend you to have a majority of validators running on the platform to b...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~35-~35: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...dator in the platform Unless there are a majority of validators running on the platform, you...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
Additional comments not posted (3)
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-network.md (3)
5-10: LGTM!The "Prerequisites" section is well-written and provides clear and concise information for the user to get started.
41-46: LGTM!The "Removing a validator in the platform" section provides clear and easy-to-follow instructions for removing a validator in the platform.
47-56: LGTM!The "Node type conflict warning" section provides a clear explanation of the node type conflict warning and its causes, along with instructions for resolving the warning.
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-network.md
Outdated
Show resolved
Hide resolved
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-network.md
Outdated
Show resolved
Hide resolved
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-network.md
Outdated
Show resolved
Hide resolved
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-network.md
Outdated
Show resolved
Hide resolved
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (2)
docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md (1)
33-42: LGTM, but add a comma after "Similarly".The section provides clear instructions for adding a validator in the platform.
Add a comma after "Similarly" in line 46:
-Similarily you can make a platform validator a non-validator by executing: +Similarly, you can make a platform validator a non-validator by executing:Tools
LanguageTool
[style] ~35-~35: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...dator in the platform Unless there are a majority of validators running on the platform, you...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md (1)
136-138: LGTM, but add a comma after "Similarly".The update to use
qbft_proposeValidatorVoteinstead ofibft_proposeValidatorVoteis correct.Add a comma after "Similarly" in line 138:
-Similarily you can make a platform validator a regular node by executing [qbft_proposeValidatorVote](https://besu.hyperledger.org/stable/private-networks/reference/api#qbft_proposeValidatorVote) with proposal "false" on every validator node. +Similarly, you can make a platform validator a regular node by executing [qbft_proposeValidatorVote](https://besu.hyperledger.org/stable/private-networks/reference/api#qbft_proposeValidatorVote) with proposal "false" on every validator node.Tools
LanguageTool
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...etworks/reference/api#admin_nodeinfo). Similarily you can make a platform validator a reg...(AI_HYDRA_LEO_MISSING_COMMA)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md (2 hunks)
- docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md (1 hunks)
Additional context used
LanguageTool
docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md
[style] ~15-~15: Consider using an alternative to strengthen your wording.
Context: ...Quorum depending on the network you want to join 4. Enter a name for the network...(WANT_KEEN)
[style] ~25-~25: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...s as validators, you first need to have a majority of validators running on the platform. A m...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~25-~25: ‘A majority of’ might be wordy. Consider a shorter alternative.
Context: ... of validators running on the platform. A majority of validators is defined as 66% of the tot...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~27-~27: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...alidators on the network. You can have a majority of validators running on the platform by f...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[uncategorized] ~27-~27: The preposition ‘to’ seems more likely in this position.
Context: ... non-validators, and then sending votes on the externally running validator nodes ...(AI_HYDRA_LEO_REPLACE_ON_TO)
[style] ~29-~29: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ... a new node as a validator will fail if a majority of validators are not running on the platf...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~31-~31: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...running on the platform. Once there is a majority of validators running on the platform, dep...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~31-~31: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...running nodes. We recommend you to have a majority of validators running on the platform to b...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~35-~35: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...dator in the platform Unless there are a majority of validators running on the platform, you...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...# Removing a validator in the platform Similarily you can make a platform validator a non...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~61-~61: Possible missing comma found.
Context: ...ing as a non-validator on the network. Here you can choose to update the node type ...(AI_HYDRA_LEO_MISSING_COMMA)
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...etworks/reference/api#admin_nodeinfo). Similarily you can make a platform validator a reg...(AI_HYDRA_LEO_MISSING_COMMA)
Additional comments not posted (4)
docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md (4)
5-9: LGTM!The prerequisites are clearly listed and are relevant for the guide.
11-20: LGTM!The "Join a network" section provides clear and easy-to-follow instructions.
Tools
LanguageTool
[style] ~15-~15: Consider using an alternative to strengthen your wording.
Context: ...Quorum depending on the network you want to join 4. Enter a name for the network...(WANT_KEEN)
23-31: LGTM!The "Adding nodes" section provides important information about adding nodes as validators or non-validators and the requirement of having a majority of validators running on the platform.
The use of "a majority of" is appropriate in this context and does not need to be changed.
Tools
LanguageTool
[style] ~25-~25: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...s as validators, you first need to have a majority of validators running on the platform. A m...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~25-~25: ‘A majority of’ might be wordy. Consider a shorter alternative.
Context: ... of validators running on the platform. A majority of validators is defined as 66% of the tot...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~27-~27: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...alidators on the network. You can have a majority of validators running on the platform by f...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[uncategorized] ~27-~27: The preposition ‘to’ seems more likely in this position.
Context: ... non-validators, and then sending votes on the externally running validator nodes ...(AI_HYDRA_LEO_REPLACE_ON_TO)
[style] ~29-~29: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ... a new node as a validator will fail if a majority of validators are not running on the platf...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~31-~31: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...running on the platform. Once there is a majority of validators running on the platform, dep...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~31-~31: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...running nodes. We recommend you to have a majority of validators running on the platform to b...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
44-51: LGTM!The "Removing a validator in the platform" section provides clear instructions.
Tools
LanguageTool
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...# Removing a validator in the platform Similarily you can make a platform validator a non...(AI_HYDRA_LEO_MISSING_COMMA)
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md (1)
23-32: LGTM, with additional guidance.The "Adding nodes" section provides valuable information for adding nodes to the network as validators or non-validators. The explanation of the majority of validators requirement is clear and helpful, and the recommendation to have a majority of validators on the platform is sound advice.
To further clarify the majority of validators requirement, consider adding a note that this is a security measure to prevent a single entity from controlling the network. Having a majority of validators on the platform ensures that the platform operator cannot unilaterally make changes to the network without the consent of the other validators.
Tools
LanguageTool
[style] ~25-~25: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...s as validators, you first need to have a majority of validators running on the platform. A m...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~25-~25: ‘A majority of’ might be wordy. Consider a shorter alternative.
Context: ... of validators running on the platform. A majority of validators is defined as 66% of the tot...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~27-~27: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...alidators on the network. You can have a majority of validators running on the platform by f...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~29-~29: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ... a new node as a validator will fail if a majority of validators are not running on the platf...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~31-~31: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...running on the platform. Once there is a majority of validators running on the platform, dep...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~31-~31: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...running nodes. We recommend you to have a majority of validators running on the platform to b...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md (2 hunks)
- docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md
Additional context used
LanguageTool
docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md
[style] ~15-~15: Consider using an alternative to strengthen your wording.
Context: ...Quorum depending on the network you want to join 4. Enter a name for the network...(WANT_KEEN)
[style] ~25-~25: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...s as validators, you first need to have a majority of validators running on the platform. A m...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~25-~25: ‘A majority of’ might be wordy. Consider a shorter alternative.
Context: ... of validators running on the platform. A majority of validators is defined as 66% of the tot...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~27-~27: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...alidators on the network. You can have a majority of validators running on the platform by f...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~29-~29: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ... a new node as a validator will fail if a majority of validators are not running on the platf...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~31-~31: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...running on the platform. Once there is a majority of validators running on the platform, dep...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~31-~31: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...running nodes. We recommend you to have a majority of validators running on the platform to b...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~35-~35: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...dator in the platform Unless there are a majority of validators running on the platform, you...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
Additional comments not posted (4)
docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md (4)
5-10: LGTM!The "Prerequisites" section is clear and concise, providing the necessary information for connecting to an external network.
11-21: LGTM!The "Join a network" section provides clear and easy-to-follow step-by-step instructions for joining an external network. The references to other relevant guides are helpful for users who need more information.
Tools
LanguageTool
[style] ~15-~15: Consider using an alternative to strengthen your wording.
Context: ...Quorum depending on the network you want to join 4. Enter a name for the network...(WANT_KEEN)
33-43: LGTM!The "Adding a validator in the platform" section provides clear and specific instructions for adding a validator when there is no majority of validators on the platform. The inclusion of instructions for both Hyperledger Besu and Quorum networks is helpful for users working with different networks.
Tools
LanguageTool
[style] ~35-~35: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...dator in the platform Unless there are a majority of validators running on the platform, you...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
44-62: LGTM!The "Removing a validator in the platform" section provides clear and specific instructions for removing a validator, similar to the "Adding a validator in the platform" section. The inclusion of instructions for both Hyperledger Besu and Quorum networks is consistent and helpful.
The "Node type conflict warning" section provides useful information for troubleshooting node type conflicts and offers guidance on how to resolve them. This section will help users understand and address any node type conflict warnings they may encounter.
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (2)
docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md (2)
23-33: LGTM, but consider a minor improvement.The "Adding Nodes" section provides clear instructions for adding more nodes to the network, including navigating to the create node form, choosing the node type, and deploying nodes as validators when a majority of validators are running on the platform.
However, the phrase "a majority of" is used twice in this section and might be slightly wordy. Consider using a shorter alternative, such as "most," to improve readability.
Tools
LanguageTool
[style] ~32-~32: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...alidator) to make it a validator. Once a majority of validators are running on the platform,...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~32-~32: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...xternal validators. We recommend having a majority of validators running on the platform for ...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
34-44: LGTM, but consider a minor improvement.The "Add a Validator" section provides clear instructions for adding a platform node as a validator, including the conditions, the necessary API methods for Hyperledger Besu and Quorum, and the steps to follow, such as finding the enode URL and restarting the node once the vote is reflected in the network.
However, the phrase "a majority of" is used once in this section and might be slightly wordy. Consider using a shorter alternative, such as "most," to improve readability.
Tools
LanguageTool
[style] ~36-~36: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...he network. ## Add a Validator Unless a majority of validators are running on the platform,...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md (2 hunks)
- docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md (1 hunks)
Additional context used
LanguageTool
docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md
[style] ~32-~32: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...alidator) to make it a validator. Once a majority of validators are running on the platform,...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~32-~32: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...xternal validators. We recommend having a majority of validators running on the platform for ...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~36-~36: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...he network. ## Add a Validator Unless a majority of validators are running on the platform,...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md
[uncategorized] ~137-~137: A comma may be missing after the conjunctive/linking adverb ‘Similarly’.
Context: ...etworks/reference/api#admin_nodeinfo). Similarly you can make a platform validator a reg...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Additional comments not posted (6)
docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md (4)
5-10: LGTM!The "Prerequisites" section clearly lists the requirements for connecting to an external network, including the supported network types, the necessary genesis file, and the enode URL of an existing node.
11-22: LGTM!The "Joining a Network" section provides clear and detailed step-by-step instructions for joining an external network, including navigating to the create network form, selecting the network type, entering necessary information, uploading the genesis file, adding an enode URL, and choosing a deployment plan.
45-53: LGTM!The "Remove a Validator" section provides clear instructions for removing a platform validator and making it a non-validator, including the necessary API methods for Hyperledger Besu and Quorum, setting the proposal to "false", and restarting the node in the platform once the vote is reflected in the network.
54-68: LGTM!The "Node Type Conflict Warning" section clearly explains the node type conflict warning displayed by the platform when there's a discrepancy between the node type in the platform and the node type on the network. The section lists the scenarios that can cause this warning and provides two ways to resolve it: updating the node type in the platform or adding/removing the node as a validator on the network.
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md (2)
1-1: LGTM!The title change from "Connect an external node" to "Connect to an external node" is approved. The new title is grammatically correct and improves clarity by better reflecting the action described in the guide.
136-136: LGTM!The updated references from
ibft_proposeValidatorVotetoqbft_proposeValidatorVoteare approved. The changes consistently use the correct function name and 'stable' URL for the documentation, indicating the shift to QBFT protocol for managing validators. This aligns with the planned QBFT support mentioned in the existing comments.Also applies to: 138-138
| Execute [qbft_proposeValidatorVote](https://besu.hyperledger.org/stable/private-networks/reference/api#qbft_proposevalidatorvote) on all your validator nodes. You can find the enode address of your new node in the logs of the container or by executing [admin_nodeInfo](https://besu.hyperledger.org/stable/public-networks/reference/api#admin_nodeinfo). | ||
|
|
||
| Similarily you can make a platform validator a regular node by executing [ibft_proposeValidatorVote](https://besu.hyperledger.org/stable/private-networks/reference/api#ibft_proposevalidatorvote) with proposal "false" on every validator node. Note however that the platform will not reflect this change. | ||
| Similarly you can make a platform validator a regular node by executing [qbft_proposeValidatorVote](https://besu.hyperledger.org/stable/private-networks/reference/api#qbft_proposevalidatorvote) with proposal "false" on every validator node. |
There was a problem hiding this comment.
Add a comma after 'Similarly' to improve readability.
LanguageTool correctly suggests adding a comma after the conjunctive/linking adverb 'Similarly' to follow the English punctuation rules.
Apply this fix:
-Similarly you can make a platform validator a regular node by executing [qbft_proposeValidatorVote](https://besu.hyperledger.org/stable/private-networks/reference/api#qbft_proposevalidatorvote) with proposal "false" on every validator node.
+Similarly, you can make a platform validator a regular node by executing [qbft_proposeValidatorVote](https://besu.hyperledger.org/stable/private-networks/reference/api#qbft_proposevalidatorvote) with proposal "false" on every validator node.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Similarly you can make a platform validator a regular node by executing [qbft_proposeValidatorVote](https://besu.hyperledger.org/stable/private-networks/reference/api#qbft_proposevalidatorvote) with proposal "false" on every validator node. | |
| Similarly, you can make a platform validator a regular node by executing [qbft_proposeValidatorVote](https://besu.hyperledger.org/stable/private-networks/reference/api#qbft_proposevalidatorvote) with proposal "false" on every validator node. |
Branches from: #73 <!-- Generated by sourcery-ai[bot]: start summary --> ## Summary by Sourcery Revise and expand the documentation for adding networks to applications, joining networks by invitation code, and connecting to external networks and nodes. Introduce a new guide for integrating with external networks using the SettleMint platform, and update existing guides with clearer instructions and updated API references. Documentation: - Updated the documentation to include instructions for joining a permissioned blockchain network using an invitation code and clarified the process for adding a network to an application. - Added a new guide on connecting to an external network using the SettleMint platform, detailing prerequisites, joining a network, adding nodes, and managing validators. - Revised the guide on connecting to an external node, including updates to the API method references for proposing validator votes. <!-- Generated by sourcery-ai[bot]: end summary --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Summary by CodeRabbit - **Documentation** - Enhanced clarity in instructions for joining a blockchain network via invitation code, improving user experience. - Updated guides for connecting external nodes to Hyperledger Besu, including terminology changes and updated references. - Introduced a new document detailing the process for connecting the SettleMint platform to external networks. - Revised instructions for adding a blockchain network to an application, broadening user options and improving readability. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Summary by Sourcery
Introduce a comprehensive guide for connecting to external networks on the SettleMint platform, including instructions for deploying nodes, managing validators, and handling node type conflicts. Update an existing guide's title for clarity.
Documentation:
Summary by CodeRabbit