Skip to content

docs: 📚 Add comprehensive node setup documentation for DataHaven and StorageHub nodes#322

Open
stiiifff wants to merge 6 commits intomainfrom
sde/storagehub-docs
Open

docs: 📚 Add comprehensive node setup documentation for DataHaven and StorageHub nodes#322
stiiifff wants to merge 6 commits intomainfrom
sde/storagehub-docs

Conversation

@stiiifff
Copy link
Copy Markdown
Contributor

@stiiifff stiiifff commented Nov 25, 2025

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 navigation
  • DataHaven Nodes:
    • docs/datahaven-bootnode.md - Bootnode configuration for peer discovery
    • docs/datahaven-validator.md - Validator setup with 4 session keys
    • docs/datahaven-fullnode.md - Full/RPC node configuration
  • StorageHub Nodes:
    • docs/storagehub-msp.md - Main Storage Provider setup
    • docs/storagehub-bsp.md - Backup Storage Provider setup
    • docs/storagehub-indexer.md - PostgreSQL-backed indexer setup
    • docs/storagehub-fisherman.md - Storage provider monitor setup

Key Features

Each document includes:

  • ✅ CLI flags with descriptions and default values
  • ✅ Key injection requirements (session keys, BCSV keys)
  • ✅ Wallet creation and funding requirements
  • ✅ On-chain registration extrinsics with code examples
  • ✅ Docker Compose deployment examples
  • ✅ Kubernetes StatefulSet configurations
  • ✅ Monitoring and health check guides
  • ✅ Troubleshooting sections

MSP/BSP Registration

The documentation uses the non-privileged 2-step registration process:

  1. request_msp_sign_up / request_bsp_sign_up - Initiates registration and reserves deposit
  2. confirm_sign_up - Completes registration after randomness verification

The sudo-based force_*_sign_up extrinsics are documented separately for development/testing environments.

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>
@stiiifff stiiifff changed the title docs: Add comprehensive node setup documentation for DataHaven and StorageHub docs: 📚 Add comprehensive node setup documentation for DataHaven and StorageHub Nov 25, 2025
@stiiifff stiiifff added B0-silent Changes should not be mentioned in any release notes D2-notlive PR doesn't change runtime code (so can't be audited) not-breaking Does not need to be mentioned in breaking changes labels Nov 25, 2025
@stiiifff stiiifff marked this pull request as ready for review December 1, 2025 11:29
@stiiifff stiiifff requested review from a team as code owners December 1, 2025 11:29
@stiiifff
Copy link
Copy Markdown
Contributor Author

stiiifff commented Dec 1, 2025

@ffarall can you review the docs for the StorageHub nodes ? 🙏

@stiiifff stiiifff changed the title docs: 📚 Add comprehensive node setup documentation for DataHaven and StorageHub docs: 📚 Add comprehensive node setup documentation for DataHaven and StorageHub nodes Dec 1, 2025
@stiiifff
Copy link
Copy Markdown
Contributor Author

stiiifff commented Dec 2, 2025

TODO: update SH node docs following the upgrade to StorageHub v0.2.0 release.

@gonzamontiel
Copy link
Copy Markdown
Contributor

Hey what about this PR ? There's a TODO still missing? The rest is up to date? cc @stiiifff

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

B0-silent Changes should not be mentioned in any release notes D2-notlive PR doesn't change runtime code (so can't be audited) not-breaking Does not need to be mentioned in breaking changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants