docs: 📚 Add comprehensive node setup documentation for DataHaven and StorageHub nodes#322
Open
docs: 📚 Add comprehensive node setup documentation for DataHaven and StorageHub nodes#322
Conversation
Add documentation for DataHaven and StorageHub node setup and operations: DataHaven nodes: - Bootnode: Peer discovery configuration - Validator: 4 session keys (BABE, GRANDPA, ImOnline, BEEFY) - Full Node: RPC endpoint setup StorageHub nodes: - MSP: Main Storage Provider with 2-step registration - BSP: Backup Storage Provider with 2-step registration - Indexer: PostgreSQL-backed blockchain indexer - Fisherman: Storage provider monitor Each document includes: - CLI flags with descriptions - Key injection requirements - Wallet/funding requirements - On-chain registration extrinsics (using non-privileged 2-step process for MSP/BSP) - Docker and Kubernetes deployment examples - Monitoring and troubleshooting guides 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
Author
|
@ffarall can you review the docs for the StorageHub nodes ? 🙏 |
Contributor
Author
|
TODO: update SH node docs following the upgrade to StorageHub v0.2.0 release. |
Contributor
|
Hey what about this PR ? There's a TODO still missing? The rest is up to date? cc @stiiifff |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR adds comprehensive documentation for setting up and operating DataHaven and StorageHub nodes. The documentation covers all node types with detailed information about CLI flags, key management, wallet requirements, and on-chain registration processes.
Documentation Structure
docs/README.md- Overview with quick reference tables and navigationdocs/datahaven-bootnode.md- Bootnode configuration for peer discoverydocs/datahaven-validator.md- Validator setup with 4 session keysdocs/datahaven-fullnode.md- Full/RPC node configurationdocs/storagehub-msp.md- Main Storage Provider setupdocs/storagehub-bsp.md- Backup Storage Provider setupdocs/storagehub-indexer.md- PostgreSQL-backed indexer setupdocs/storagehub-fisherman.md- Storage provider monitor setupKey Features
Each document includes:
MSP/BSP Registration
The documentation uses the non-privileged 2-step registration process:
request_msp_sign_up/request_bsp_sign_up- Initiates registration and reserves depositconfirm_sign_up- Completes registration after randomness verificationThe sudo-based
force_*_sign_upextrinsics are documented separately for development/testing environments.