-
Notifications
You must be signed in to change notification settings - Fork 0
feat: connect to external network docs #73
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
f358c84
initial docs
snigdha920 568e6e4
more cleanup
snigdha920 e99a736
remove references to images
snigdha920 f192b18
remove note that platform doesn't reflect node type changes
snigdha920 1750ec3
fix page number, json rpc method name, grammar
snigdha920 fab9c6e
fix link to qbft_proposeValidatorVote
snigdha920 7b94aa5
cursor ai improvements
snigdha920 d541875
use stable link
snigdha920 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
...ain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # Connect to an External Network | ||
|
|
||
| The SettleMint platform seamlessly integrates with existing external networks. You can deploy nodes on your external network within the SettleMint platform, enabling you to leverage the platform's robust features, including monitoring, resource scaling, an intuitive JSON-RPC UI, and reliable uptime management. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - A Hyperledger Besu or Quorum OBFT network | ||
| - The genesis file of the network | ||
| - At least one enode URL of an existing running node on the network (required to sync the platform node with the existing network) | ||
|
|
||
| ## Joining a Network | ||
|
|
||
| 1. Navigate to the create network form (see [how to do this here](../../using-platform/1_add-a-network-to-an-application.md)). | ||
| 2. Select **Join permissioned network**. | ||
| 3. Choose **Hyperledger Besu** or **Quorum** depending on the network you want to join. | ||
| 4. Enter names for the network and the node. | ||
| 5. Upload the network's genesis file. Bootnodes specified in the genesis file will be automatically identified and added as external nodes. | ||
| 6. Add at least one enode URL of an existing running node on the network. Note: If a bootnode is specified in the genesis file, it will be added automatically as an external node, allowing you to skip this step. | ||
| 7. Choose the deployment plan for the node. For more information about deployment plans, [see here](../../using-platform/22_deployment-plans.md). | ||
|
|
||
| This process will create a new non-validator node in your existing network. | ||
|
|
||
| ## Adding Nodes | ||
|
|
||
| To add more nodes to your network: | ||
|
|
||
| 1. Navigate to the create node form (see [Adding a Node to a Network](../../using-platform/2_add-a-node-to-a-network.md) for detailed instructions). | ||
| 2. Choose between creating the node as a validator or non-validator. | ||
| 3. Note: To deploy nodes as validators, a majority (66%) of validators must be running on the SettleMint platform. | ||
| 4. If you don't have a majority, create the node as a non-validator first, then follow the process in [Add a Validator](#add-a-validator) to make it a validator. | ||
|
|
||
| Once a majority of validators are running on the platform, deploying new nodes as validators becomes possible without voting on external validators. We recommend having a majority of validators running on the platform for seamless addition and removal of validators from the network. | ||
|
|
||
| ## Add a Validator | ||
|
|
||
| Unless a majority of validators are running on the platform, you need to send votes on the externally running validators to add the platform node as a validator. | ||
|
|
||
| Execute the following on all your validator nodes: | ||
|
|
||
| - For Hyperledger Besu: [qbft_proposeValidatorVote](https://besu.hyperledger.org/stable/private-networks/reference/api#qbft_proposevalidatorvote) | ||
| - For Quorum: [istanbul_propose](https://docs.goquorum.consensys.io/reference/api-methods#istanbul_propose) | ||
|
|
||
| Find the enode URL of the platform node in the 'Details' tab of the node under the 'Node Identity' section. Once the vote is reflected in the network, restart the node in the platform. The node will be added as a validator and will start proposing blocks. | ||
|
|
||
| ## Remove a Validator | ||
|
|
||
| To make a platform validator a non-validator, execute the following on every validator node: | ||
|
|
||
| - For Hyperledger Besu: [qbft_proposeValidatorVote](https://besu.hyperledger.org/stable/private-networks/reference/api#qbft_proposevalidatorvote) with proposal "false" | ||
| - For Quorum: [istanbul_propose](https://docs.goquorum.consensys.io/reference/api-methods#istanbul_propose) with proposal "false" | ||
|
|
||
| Once the vote is reflected in the network, restart the node in the platform. The node will be removed as a validator and will stop proposing blocks. | ||
|
|
||
| ## Node Type Conflict Warning | ||
|
|
||
| The platform displays a node type conflict warning when there's a discrepancy between the node type in the platform and the node type on the network. | ||
|
|
||
| This can occur when: | ||
|
|
||
| - The node is added as a non-validator on the platform but runs as a validator on the network. | ||
| - The node is added as a validator on the platform but runs as a non-validator on the network. | ||
|
|
||
| To resolve this, you can either: | ||
|
|
||
| 1. Update the node type in the platform to match the node type on the network, or | ||
| 2. Add or remove the node as a validator on the network using the steps mentioned above. | ||
|
|
||
| The platform will automatically resolve the node type conflict warning shortly after the necessary changes are made. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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:
Committable suggestion