Skip to content

Commit

Permalink
chore(docs): run an omega full node (#1638)
Browse files Browse the repository at this point in the history
update operator docs to run an omega full node

issue: none
  • Loading branch information
ttarsi authored Aug 5, 2024
1 parent def7064 commit 622ca75
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 132 deletions.
6 changes: 2 additions & 4 deletions docs/site/docs/operate/introduction/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ sidebar_position: 1

Operators run Omni node software and play an active role in validating the Omni network.

In all other blockchains, validators can only stake the native token of that chain. With Omni, validators can stake **\$OMNI**, but they can also restake **\$ETH**, via Eigenlayer. Operators can also receive **\$ETH** delegations from other users.
Validators must run the Omni client in addition to nodes for all supported chains, since validators attest to xchain blocks. Full nodes don't need to run nodes for supported chains.

## How Do I Become an Operator?

If you'd like to become an Omni operator, please reach out to the team.
Validators stake **\$OMNI**, and can optionally stake **\$ETH** or receive **\$ETH** delegations via Eigenlayer. Many staking features including validator withdrawals, **\$OMNI** delegation, **\$ETH** delegation, and more will be released in the staking network upgrade.
8 changes: 7 additions & 1 deletion docs/site/docs/operate/introduction/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 2

Omniʼs operator needs to run the consensus client and the execution client:

- EVM client for execution (`geth`, `erigon`, etc)
- EVM client for execution (`geth`)
- Omniʼs consensus client (`halo`)

## Hardware Requirements
Expand All @@ -28,3 +28,9 @@ Omniʼs operator needs to run the consensus client and the execution client:
### Ports

Inbound ports will be enabled for cometBFT (tcp://266567) and Geth (tcp://30303, udp://30303)

## Supported Chains

Validators must also run full nodes for supported chains. Mainnet v1 supports: Ethereum, Arbitrum, Optimism, and Base.

Omni full nodes do not need to run full nodes for supported chains.
53 changes: 0 additions & 53 deletions docs/site/docs/operate/onboarding/client.md

This file was deleted.

36 changes: 32 additions & 4 deletions docs/site/docs/operate/onboarding/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,38 @@
sidebar_position: 1
---

# EigenLayer Registration
# Becoming an Omni Operator

## Registering as an Operator for Testnet & Mainnet
## Running a full node

To register with Omni, operators must first register as an operator on the Eigenlayer smart contracts on Holesky testnet or Mainnet.
Currently, anyone can run a node on Omni Omega Testnet.

This registers your Ethereum public key with the Eigenlayer smart contracts. You can follow Eigenlayer's instructions [here](https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation).
The simplest way to run a full node is with the following commands:

```bash
# Install the Omni CLI (alternate instructions here: https://docs.omni.network/tools/cli/)
curl -sSfL https://raw.githubusercontent.com/omni-network/omni/main/scripts/install_omni_cli.sh | sh -s

# init geth and halo
omni operator init-nodes --network=omega --moniker=foo --clean

# start geth and helo
cd ~/.omni/omega
docker compose up
```

Congrats, you're running a full node!

## AVS Registration

## Registering as an Operator

Operators can currently register with Omni's Eigenlayer AVS contract. Please note that **\$ETH** delegation will only be enable in the mainnet staking upgrade alongside other features like **\$OMNI** delegation, validator withdrawals, and more.

You can follow Eigenlayer's instructions [here](https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation) to register your operator key with their contracts.

Then you can run the following command to register within the Omni AVS contract:

```bash
omni operator register --config-file ~/path/to/operator.yaml
```
70 changes: 0 additions & 70 deletions docs/site/docs/operate/onboarding/register.md

This file was deleted.

0 comments on commit 622ca75

Please sign in to comment.