Skip to content

Commit

Permalink
Merge pull request #620 from hyperweb-io/anmol/eth-doc
Browse files Browse the repository at this point in the history
docs: add doc for eth chain setup
  • Loading branch information
Anmol1696 authored Feb 16, 2025
2 parents 3640ef4 + 9296d79 commit 7425ad0
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/pages/config/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
"index": "Introduction",
"chains": "Chains Directive Syntax",
"relayers": "Relayers Directive Syntax",
"features": "Feature Toggles"
"features": "Feature Toggles",
"ethereum": "Ethereum"
}
42 changes: 42 additions & 0 deletions docs/pages/config/ethereum.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Ethereum Chain Configuration in Starship

Ethereum support in Starship allows users to deploy Ethereum execution and consensus (beacon) nodes using simple configurations.
This section details how to configure Ethereum-based chains within Starship.

## Ethereum Execution Chain

The Ethereum Execution Chain, or Ethereum client, runs the execution layer of the Ethereum network, handling smart contract execution and maintaining state.

### Config
```yaml
chains:
- id: 1337
name: ethereum
numValidators: 1
ports:
rest: 8545
rpc: 8551
```
### Optional Configs
```yaml
chains:
- id: 1337
name: ethereum
numValidators: 1
ports:
rest: 8545
rpc: 8551
image: ghcr.io/hyperweb-io/starship/ethereum/client-go:latest
config:
beacon:
enabled: true
image: "ghcr.io/hyperweb-io/starship/prysm/beacon-chain:v5.2.0"
numValidator: 1
validator:
enabled: true
image: "ghcr.io/hyperweb-io/starship/prysm/validator:v5.2.0"
numValidator: 1
prysmctl:
image: "ghcr.io/hyperweb-io/starship/prysm/cmd/prysmctl:v5.2.0"
```

0 comments on commit 7425ad0

Please sign in to comment.