Skip to content

docs: 📚 Add Snowbridge relay documentation#325

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

docs: 📚 Add Snowbridge relay documentation#325
stiiifff wants to merge 6 commits intomainfrom
sde/snowbridge-relay-docs

Conversation

@stiiifff
Copy link
Copy Markdown
Contributor

@stiiifff stiiifff commented Dec 1, 2025

Summary

Adds comprehensive documentation for running Snowbridge relays to bridge DataHaven and Ethereum.

New Documentation

  • Beacon Relay (snowbridge-beacon-relay.md) - Ethereum consensus layer sync to DataHaven
  • BEEFY Relay (snowbridge-beefy-relay.md) - DataHaven finality proofs to Ethereum
  • Execution Relay (snowbridge-execution-relay.md) - Ethereum messages to DataHaven
  • Solochain Relay (snowbridge-solochain-relay.md) - DataHaven messages and rewards to Ethereum
  • Relay Operating Costs (snowbridge-relay-costs.md) - Centralized cost guidance for all relays

Key Sections Added

Hardware Requirements

  • 4 cores, 8 GB RAM minimum for all relays
  • Storage requirements per relay type (5-20 GB SSD)

RPC Endpoint Requirements

  • Ethereum execution layer (WebSocket) requirements
  • Beacon node API requirements
  • Recommended providers (Dwellir, Chainstack, QuickNode, Alchemy)

Relay Redundancy

  • Multi-instance deployment configuration
  • Schedule parameters (id, totalRelayerCount, sleepInterval) documentation
  • Best practices for fault tolerance with different RPC providers

Fork Versions

  • Ethereum Mainnet (Deneb, Electra, Fulu)
  • Hoodi Testnet configuration
  • Local development configuration

Account Funding & Cost Forecasts

  • Initial funding requirements (ETH and HAVE)
  • Annual operating cost estimates by activity level
  • Cost optimization strategies
  • Balance monitoring thresholds

Beacon Checkpoint Initialization

  • Generate checkpoint command with file output
  • Polkadot.js Apps method with decode prefix (0x24003c00)
  • TypeScript/Polkadot-API method

stiiifff and others added 6 commits November 25, 2025 14:15
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>
Add comprehensive documentation for the 4 Snowbridge relays:

- Beacon Relay: Syncs Ethereum beacon chain finality to DataHaven
- BEEFY Relay: Submits DataHaven BEEFY proofs to Ethereum
- Execution Relay: Delivers Ethereum messages to DataHaven
- Solochain Relay: Sends DataHaven messages to Ethereum

Each document includes:
- CLI flags and configuration file structure
- Key requirements (Ethereum/Substrate private keys)
- Docker and Kubernetes deployment examples
- Multi-instance deployment for high availability
- Monitoring and troubleshooting guides

Also updates README.md with Snowbridge section and relay overview table.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@stiiifff stiiifff requested review from a team as code owners December 1, 2025 15:01
@stiiifff stiiifff changed the title docs: Add Snowbridge relay documentation docs: 📚 Add Snowbridge relay documentation Dec 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant