feat: provide default consensus rpc (#91)
This commit is contained in:
parent
cbb96abd65
commit
b56dfbb5a7
|
@ -17,11 +17,13 @@ To install Helios, run `heliosup`.
|
||||||
## Usage
|
## Usage
|
||||||
To run Helios, run the below command, replacing `$ETH_RPC_URL` with an RPC provider URL such as Alchemy or Infura:
|
To run Helios, run the below command, replacing `$ETH_RPC_URL` with an RPC provider URL such as Alchemy or Infura:
|
||||||
```
|
```
|
||||||
helios --consensus-rpc https://www.lightclientdata.org --execution-rpc $ETH_RPC_URL
|
helios --execution-rpc $ETH_RPC_URL
|
||||||
```
|
```
|
||||||
Helios will now run a local RPC server at `http://127.0.0.1:8545`.
|
Helios will now run a local RPC server at `http://127.0.0.1:8545`.
|
||||||
|
|
||||||
### Additional Options
|
### Additional Options
|
||||||
|
`--consensus-rpc` or `-c` can be used to set a custom consensus layer rpc endpoint. This must be a consenus node that supports the light client beaconchain api. We recomment using Nimbus for this. If no consensus rpc is supplied, it defaults to `https://www.lightclientdata.org` which is run by us.
|
||||||
|
|
||||||
`--checkpoint` or `-w` can be used to set a custom weak subjectivity checkpoint. This must be equal the first beacon blockhash of an epoch. Weak subjectivity checkpoints are the root of trust in the system. If this is set to a malicious value, an attacker can cause the client to sync to the wrong chain. Helios sets a default value initially, then caches the most recent finalized block it has seen for later use.
|
`--checkpoint` or `-w` can be used to set a custom weak subjectivity checkpoint. This must be equal the first beacon blockhash of an epoch. Weak subjectivity checkpoints are the root of trust in the system. If this is set to a malicious value, an attacker can cause the client to sync to the wrong chain. Helios sets a default value initially, then caches the most recent finalized block it has seen for later use.
|
||||||
|
|
||||||
`--network` or `-n` sets the network to sync to. Current valid option are `mainnet` and `goerli`, however users can add custom networks in their configurationf files.
|
`--network` or `-n` sets the network to sync to. Current valid option are `mainnet` and `goerli`, however users can add custom networks in their configurationf files.
|
||||||
|
|
|
@ -89,6 +89,7 @@ impl Config {
|
||||||
pub fn to_base_config(&self) -> BaseConfig {
|
pub fn to_base_config(&self) -> BaseConfig {
|
||||||
BaseConfig {
|
BaseConfig {
|
||||||
rpc_port: self.rpc_port.unwrap_or(8545),
|
rpc_port: self.rpc_port.unwrap_or(8545),
|
||||||
|
consensus_rpc: Some(self.consensus_rpc.clone()),
|
||||||
checkpoint: self.checkpoint.clone(),
|
checkpoint: self.checkpoint.clone(),
|
||||||
chain: self.chain.clone(),
|
chain: self.chain.clone(),
|
||||||
forks: self.forks.clone(),
|
forks: self.forks.clone(),
|
||||||
|
|
|
@ -20,6 +20,7 @@ impl Network {
|
||||||
#[derive(Serialize, Default)]
|
#[derive(Serialize, Default)]
|
||||||
pub struct BaseConfig {
|
pub struct BaseConfig {
|
||||||
pub rpc_port: u16,
|
pub rpc_port: u16,
|
||||||
|
pub consensus_rpc: Option<String>,
|
||||||
#[serde(
|
#[serde(
|
||||||
deserialize_with = "bytes_deserialize",
|
deserialize_with = "bytes_deserialize",
|
||||||
serialize_with = "bytes_serialize"
|
serialize_with = "bytes_serialize"
|
||||||
|
@ -36,6 +37,7 @@ pub fn mainnet() -> BaseConfig {
|
||||||
)
|
)
|
||||||
.unwrap(),
|
.unwrap(),
|
||||||
rpc_port: 8545,
|
rpc_port: 8545,
|
||||||
|
consensus_rpc: Some("https://www.lightclientdata.org".to_string()),
|
||||||
chain: ChainConfig {
|
chain: ChainConfig {
|
||||||
chain_id: 1,
|
chain_id: 1,
|
||||||
genesis_time: 1606824023,
|
genesis_time: 1606824023,
|
||||||
|
@ -68,6 +70,7 @@ pub fn goerli() -> BaseConfig {
|
||||||
)
|
)
|
||||||
.unwrap(),
|
.unwrap(),
|
||||||
rpc_port: 8545,
|
rpc_port: 8545,
|
||||||
|
consensus_rpc: None,
|
||||||
chain: ChainConfig {
|
chain: ChainConfig {
|
||||||
chain_id: 5,
|
chain_id: 5,
|
||||||
genesis_time: 1616508000,
|
genesis_time: 1616508000,
|
||||||
|
|
Loading…
Reference in New Issue