-
Notifications
You must be signed in to change notification settings - Fork 88
chore(docs): operator registration #495
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
af996ea
chore(docs): add testnet operate file
idea404 a9af0b0
chore(docs): operate docs
idea404 92d5776
chore(docs): fix link
idea404 a87b98d
chore(docs): uncollapse folder
idea404 f02f3f4
chore(docs): expand sidebars
idea404 ad44066
chore(docs): CLI install commands
idea404 f66df3d
chore(docs): CLI install commands
idea404 e5b64ee
chore(docs): CLI install commands
idea404 282b2be
chore(scripts): add binary install line
idea404 57d0de3
chore(scripts): install cli section
idea404 7642f05
chore(docs): register cli flags fix
idea404 29daa2c
chore(docs): avs address as var
idea404 5a23300
chore(docs): review comments
idea404 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Introduction | ||
|
||
## What Is a Node Operator in Omni? | ||
|
||
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. | ||
|
||
## How Do I Become an Operator? | ||
|
||
If you'd like to become an Omni operator, please reach out to the team. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
sidebar_position: 4 | ||
--- | ||
|
||
# Run the Client | ||
|
||
This is the component that participates in network validation. Our consensus clients track delegations and stake from our AVS contracts. | ||
|
||
Similar to Ethereum, Omni validators run 2 components: our consensus client, `halo`, and an EVM execution client `geth`, `erigon`, `nethermind`, etc. | ||
|
||
:::info | ||
|
||
This feature is not yet enabled. Please do not attempt to run it. | ||
|
||
::: | ||
|
||
<!-- TODO(dennis): include run commands, preferably with CLI --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Installing the Omni CLI | ||
|
||
The Omni CLI will allow you to interact with the Omni network and simplifies the process of performing actions as an operator. | ||
|
||
## Install from Binary | ||
|
||
The easiest way to install the Omni CLI is to download the latest release from the [GitHub releases page](https://github.com/omni-network/omni/releases). Once downloaded, you can extract the binary and move it to a location in your PATH. | ||
|
||
## Install from Script | ||
|
||
You can also install the Omni CLI using the following script: | ||
|
||
```bash | ||
curl -sSfL https://raw.githubusercontent.com/omni-network/omni/main/scripts/install_omni_cli.sh | sh -s | ||
``` | ||
|
||
## Install from Source | ||
|
||
import Tabs from '@theme/Tabs'; | ||
import TabItem from '@theme/TabItem'; | ||
|
||
<Tabs> | ||
<TabItem value="source" label="src with make"> | ||
```bash | ||
git clone https://github.com/omni-network/omni.git | ||
cd omni | ||
make install-cli | ||
``` | ||
</TabItem> | ||
<TabItem value="go" label="src with go"> | ||
```bash | ||
git clone https://github.com/omni-network/omni.git | ||
cd omni | ||
go install ./cli/cmd/omni | ||
``` | ||
</TabItem> | ||
</Tabs> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# EigenLayer Registration | ||
|
||
## Registering as an Operator for Testnet | ||
|
||
To register with Omni, operators must first register as an operator in Eigenlayer testnet | ||
|
||
This registers your Ethereum public key with the Eigenlayer. You can follow Eigenlayer's instructions [here](https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
sidebar_position: 3 | ||
--- | ||
|
||
# Omni AVS Contract Registration | ||
|
||
This tells EigenLayer that you'd like to be an operator specifically for the Omni AVS. Thus, the **\$ETH** that you, and your delegators restaked, will be used to secure Omni. Omni provides a CLI for this. | ||
|
||
You will need to have an `operator.yml` file to perform this registration. This file is created as part of [registering as an operator with the EigenLayer CLI](https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation). | ||
|
||
<details> | ||
<summary>`operator.yml` Reference</summary> | ||
|
||
For further information on this reference, please refer to the [EigenLayer reference example](https://github.com/Layr-Labs/eigenlayer-cli/blob/master/pkg/operator/config/operator-config-example.yaml). | ||
|
||
```yaml | ||
operator: | ||
address: 0xfd23f7f705344bce1582fcf9bc6a0dc8e33b3b61 # Your operator address | ||
earnings_receiver_address: 0xfd23f7f705344bce1582fcf9bc6a0dc8e33b3b61 # Your operator payout address, may be the same as above | ||
delegation_approver_address: "0x0000000000000000000000000000000000000000" # Your delegation approver address, may be left as shown | ||
staker_opt_out_window_blocks: 0 # may be left as shown, and can be updated later using EigenLayer CLI | ||
metadata_url: "https://raw.githubusercontent.com/idea404/resources/main/eigenlayer/metadata.json" # Your metadata URL | ||
el_delegation_manager_address: 0x8ce361602B935680E8DeC218b820ff5056BeB7af # The address of the EigenLayer delegation manager on the Omni Network | ||
eth_rpc_url: http://127.0.0.1:8002 # Your node Ethereum RPC URL | ||
private_key_store_path: /Users/idea404/.eigenlayer/operator_keys/OpKeys1.ecdsa.key.json # Your private key store path generated or imported by EigenLayer CLI | ||
signer_type: local_keystore # Your signer type, may be left as shown | ||
chain_id: 100 # The chain ID of the Omni Network | ||
``` | ||
|
||
</details> | ||
|
||
## Register as an Operator | ||
|
||
1. Ensure that your node address has been added to the allowed list of operators. | ||
2. Run the following command to register as an operator: | ||
|
||
```bash | ||
omni operator register --config-file ~/path/to/operator.yml --avs-address <AVS_CONTRACT_ADDRESS> | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.