Skip to content

Commit

Permalink
chore(docs): add operator info (#446)
Browse files Browse the repository at this point in the history
- use "introduction" subsection for each section to standardize the
intro page
- use xapp rather than both xapp and xdapp (not finalized, but for
consistency)
- add some operator info
- use bold for token ids

task: none
  • Loading branch information
ttarsi authored Feb 29, 2024
1 parent 6ffa6c7 commit 9e740de
Show file tree
Hide file tree
Showing 13 changed files with 75 additions and 36 deletions.
2 changes: 1 addition & 1 deletion docs/site/archive/programmability.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Below I will enumerate some simple examples of what becomes possible in this new

This is the boring use case. A majority of readers are likely familiar with this as it does not require programmability and is the functionality offered by simple interoperability protocols like LayerZero.

Example: Alice is on Arbitrum where she has 1 \$ETH. She sends that \$ETH to Optimism using a simple message passing protocol. Now Alice has 1 \$ETH on Optimism.
Example: Alice is on Arbitrum where she has 1 **\$ETH**. She sends that **\$ETH** to Optimism using a simple message passing protocol. Now Alice has 1 **\$ETH** on Optimism.

This is important functionality -- however, it is largely commoditized and uninteresting for modern application development. Our perspective is that users should never have to think about low level operations like this. Developers should build applications that abstract away this complexity from end users. This lowers friction for users and gives developers a greater addressable market as their apps will be default accessible everywhere.

Expand Down
12 changes: 6 additions & 6 deletions docs/site/archive/restaking.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,24 @@ id: restaking

Omni provides a missing, yet essential, infrastructure layer for Ethereum's rollup centric future. This is why, when designing the Omni Network, we asked ourselves "What would be the best way to empower developers to build applications across all rollups if it was part of the core Ethereum protocol?" The answer to this question is to utilize restaking, creating an auxiliary network consisting of existing Ethereum validators who assume additional responsibilities to facilitate this functionality.

Omni sources a global worldview of all rollup state through the coordination of restakers who participate in a set of consensus rules. In order to be eligible to participate in consensus of the network, the validators must stake \$ETH so that they have capital at stake that can be slashed in the event that they misbehave and do not follow the agreed upon consensus rules of the network.
Omni sources a global worldview of all rollup state through the coordination of restakers who participate in a set of consensus rules. In order to be eligible to participate in consensus of the network, the validators must stake **\$ETH** so that they have capital at stake that can be slashed in the event that they misbehave and do not follow the agreed upon consensus rules of the network.

## Restaking as a concept

The Omni validators actually "restake" their \$ETH -- meaning that they can simultaneously participate in consensus both for the core Ethereum network alongside the Omni network. This concept was invented by the team at EigenLayer and it is a mechanism that allows validators to increase their rewards, while simultaneously opening up an entirely new class of networks like Omni to be formed that further expand functionality of Ethereum network in a way that could not be achieved just through the deployment of smart contracts.
The Omni validators actually "restake" their **\$ETH** -- meaning that they can simultaneously participate in consensus both for the core Ethereum network alongside the Omni network. This concept was invented by the team at EigenLayer and it is a mechanism that allows validators to increase their rewards, while simultaneously opening up an entirely new class of networks like Omni to be formed that further expand functionality of Ethereum network in a way that could not be achieved just through the deployment of smart contracts.

The creation of auxiliary networks that expand the functionality of Ethereum clearly presents great value to the ecosystem of Ethereum developers, but it also empowers the creators of these auxiliary networks with an opportunity to use a credibly neutral, difficult to manipulate and large market cap token as a form of pure collateral to bootstrap new networks.

## How Omni uses restaking

Omni Validators restake \$ETH in order to join the list of nodes that participate in the operation of the network. Upon restaking their capital, it is in their best interest to follow the outlined rules of consensus. If they do not, their \$ETH will be slashed and they will lose money. If they participate as expected, they will earn rewards through transaction fees submitted to the network. Therefore, through leveraging restaking we have a way to coordinate entities across the world who do not need to know or trust one another to all operate software in a way that provides a net societal benefit. Let's walk through a simple example.
Omni Validators restake **\$ETH** in order to join the list of nodes that participate in the operation of the network. Upon restaking their capital, it is in their best interest to follow the outlined rules of consensus. If they do not, their **\$ETH** will be slashed and they will lose money. If they participate as expected, they will earn rewards through transaction fees submitted to the network. Therefore, through leveraging restaking we have a way to coordinate entities across the world who do not need to know or trust one another to all operate software in a way that provides a net societal benefit. Let's walk through a simple example.

Alice has $100 worth of \$ETH on Arbitrum and would like to borrow some $USDC against that position to buy a token for a new project that just launched on Optimism. Using Omni, she could escrow her funds on Arbitrum, have that confirmation relayed to Optimism, and borrow $50 on Optimism while using her $100 of \$ETH on Arbitrum as collateral. Alice can now use that $50 to invest in the new project that she is excited about.
Alice has $100 worth of **\$ETH** on Arbitrum and would like to borrow some $USDC against that position to buy a token for a new project that just launched on Optimism. Using Omni, she could escrow her funds on Arbitrum, have that confirmation relayed to Optimism, and borrow $50 on Optimism while using her $100 of **\$ETH** on Arbitrum as collateral. Alice can now use that $50 to invest in the new project that she is excited about.

This is a simple, yet illustrative example of the power of Omni -- especially because this can be abstracted away from Alice. She might not care about which rollup her money is on, she might just want to participate in the decentralized web and Omni allows application developers to abstract all this away from end users to give them the best experiences the crypto industry has to offer without burdening them with technical requirements.

The way that the Omni Network secures this transition of data from Arbitrum to Optimism is restaking. The validators in the network would be monitoring Arbitrum and see Alice's transaction. It is in all of their interest to truthfully report the data of this transaction and they will do this by signing a statement declaring their view on this transaction that can be associated with their address that has restaked \$ETH. If they lie, ultimately Arbitrum will post this data to layer 1 Ethereum and then anybody will be able to take the false, yet signed statement by a dishonest validator, submit it to the restaking contract and slash the dishonest validator.
The way that the Omni Network secures this transition of data from Arbitrum to Optimism is restaking. The validators in the network would be monitoring Arbitrum and see Alice's transaction. It is in all of their interest to truthfully report the data of this transaction and they will do this by signing a statement declaring their view on this transaction that can be associated with their address that has restaked **\$ETH**. If they lie, ultimately Arbitrum will post this data to layer 1 Ethereum and then anybody will be able to take the false, yet signed statement by a dishonest validator, submit it to the restaking contract and slash the dishonest validator.

Validators restake \$ETH and attest to state updates that happen in rollups. They are incentivized to participate in this network through rewards that manifest from transaction fees. They are disincentivized from lying because ultimately the truth of all data will be posted down from rollups to layer 1 Ethereum where the validator will have their restaked \$ETH slashed. It is simple, elegant, and scalable.
Validators restake **\$ETH** and attest to state updates that happen in rollups. They are incentivized to participate in this network through rewards that manifest from transaction fees. They are disincentivized from lying because ultimately the truth of all data will be posted down from rollups to layer 1 Ethereum where the validator will have their restaked **\$ETH** slashed. It is simple, elegant, and scalable.

This is how the Omni Network is secured. The simplicity is intentional. We are building a network to secure the future of the crypto industry. There is no space for convoluted data structures, complex multi-agent interactions or third party dependencies. This is the only model that can keep pace as we onboard hundreds of millions of people across the world into an open, permissionless economy.
2 changes: 1 addition & 1 deletion docs/site/docs/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ slug: /

_Welcome to the documentation portal for all things Omni!_

Please read on to learn [about Omni](./learn/introduction.md), [the network](./protocol/overview.md), [developer docs](./develop/contracts.md) and [running a validator](./operate/run.md).
Please read on to learn [about Omni](./learn/introduction.md), [the network](./protocol/introduction.md), [developer docs](./develop/contracts.md) and [running a validator](./operate/introduction.md).
14 changes: 11 additions & 3 deletions docs/site/docs/learn/blockchains.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ sidebar_position: 2
id: blockchains
---

# Modular Blockchains
# Blockchain Background

The concept of modular blockchains is a mental model for building blockchains that has grown in popularity over the past few years in the crypto industry.
The concept of modular blockchains is a mental model for building blockchains that has grown in popularity over the past few years in the crypto industry. Let's discuss the history of the idea, and how it's relevant to Omni.

## Monolithic Blockchains

Historically, blockchains were built in a monolithic fashion. Most Layer 1 blockchains were built as an "end to end" service – taking responsibility for all services that a blockchain must provide. Layer 1 solutions like Bitcoin and Ethereum were built in this fashion.

As we learned more, new Layer 1s were developed that optimized their stacks to make different trade-offs in terms of security, scalability, and speed. Many of these new Layer 1s adopted the monolithic approach – optimizing the full chain stack to provide the optimal desired experience. Examples of these newer monolithic Layer 1s include [Solana](https://solana.com/), [Aptos](https://aptosfoundation.org/), and [Sui](https://sui.io/).
As the industry evolved, new Layer 1s were developed that optimized their stacks to make different trade-offs in terms of security, scalability, and speed. Many of these new Layer 1s adopted the monolithic approach – optimizing the full chain stack to provide the optimal desired experience. Examples of these newer monolithic Layer 1s include [Solana](https://solana.com/), [Aptos](https://aptosfoundation.org/), and [Sui](https://sui.io/).

## Modular Blockchains

Expand All @@ -36,3 +36,11 @@ Hence, the [rollup-centric roadmap](https://ethereum-magicians.org/t/a-rollup-ce
Today, Ethereum Layer 1 handles Data Availability, Execution, and Consensus. But over time, Ethereum will primarily become a Data Availability layer. Rollups will handle execution off-chain, and utilize either Ethereum's smart contract layer, or their own sovereign settlement layer, for consensus. This allows rollups (Layer 2s) to borrow Ethereum security while scaling throughput and decreasing cost. Upgrades like [EIP-4844](https://www.eip4844.com/) will even further improve Ethereum as a Data Availability layer by providing the service at lower cost.

You can view the growth of rollup ecosystems at [L2Beat.com](https://l2beat.com/), a great resource for understanding the security trade-offs, current state of development, and adoption levels for rollups.

## Omni

The modular stack is relevant to Omni in several ways.

Omni is a solution to the vast proliferation of rollups that has resulted in user and liquidity fragmentation. It offers a platform for developers to *aggregate* their users and liquidity across rollups, rather than *fragment* it.

In addition so solving problems introduced by the modular stack, Omni's architecture is inspired by the it. In particular, the Omni chain is defined by a Consensus Layer and an Execution Layer, that communicate through the Engine API – the same one as Ethereum Layer 1. Read more about this in our [architecture docs](../protocol/introduction.md).
6 changes: 3 additions & 3 deletions docs/site/docs/learn/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ id: building

Omni is only possible because of a series of recent innovations in blockchain infrastructure. This section provides a high level overview of the "How It Works" and the components that work together to establish the final product.

For a more detailed overview, see the [Protocol](../protocol/overview.md) section.
For a more detailed overview, see the [Protocol](../protocol/introduction.md) section.

## Global EVM-Compatible Application Development

Expand All @@ -31,8 +31,8 @@ For detailed information on how the native token is utilized for gas abstraction

## Restaking ETH

The Omni Network consists of validators who restake \$ETH and monitor the state of rollups. These validators relay state updates from one domain to others and provide crypto-economic assurance of validity. Read more about economic security in the [Omni Security Model section](../protocol/restaking/model.md).
The Omni Network consists of validators who restake **\$ETH** and monitor the state of rollups. These validators relay state updates from one domain to others and provide crypto-economic assurance of validity. Read more about economic security in the [Omni Security Model section](../protocol/restaking/model.md).

This means that the Omni Network is going to be the first platform that provides developers with a global view of state from all rollups, making cross-rollup application development extremely simple. All of this is made possible through the unique insight to use Ethereum's validator set to aggregate a global perspective of Ethereum's L2 ecosystem.

Read on how to delegate restaked \$ETH to Omni with EigenLayer in the [Delegating ETH](./delegate.md) section and read more on how Omni handles restaking in the [Restaking](../protocol/restaking/restaking.md) protocol section.
Read on how to delegate restaked **\$ETH** to Omni with EigenLayer in the [Delegating ETH](./delegate.md) section and read more on how Omni handles restaking in the [Restaking](../protocol/restaking/restaking.md) protocol section.
2 changes: 1 addition & 1 deletion docs/site/docs/learn/delegate.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 4

Make sure to follow the [EigenLayer Restaking User Guide](https://docs.eigenlayer.xyz/eigenlayer/restaking-guides/restaking-user-guide/) to restake **$ETH** through the EigenLayer app.

Select the **Omni Strategy Manager** from the options shown in the dashboard.
Select an operator that is registered with Omni from the options shown in the dashboard.

In case of any doubts feel free to reach out to the community on [Discord](https://discord.gg/bKNXmaX9VD).

Expand Down
33 changes: 33 additions & 0 deletions docs/site/docs/operate/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
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.

## Registering as an Operator

To register with Omni, operators must:

1. Register as an operator in Eigenlayer

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).

2. Register as an operator in the Omni AVS smart contracts.

This step 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.

3. Run the Omni client software

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.

## How do I become an operator?

If you'd like to become an Omni operator, please reach out to the team.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 1
sidebar_position: 2
---

# Run a Validator
Expand Down Expand Up @@ -28,7 +28,3 @@ 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)

## Register as a Validator

Initially, we will have a whitelist. Ultimately, operators will be ranked based on their delegated TVL. Reach out to us to get on the whitelist.
2 changes: 1 addition & 1 deletion docs/site/docs/protocol/architecture/xmsg.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The following steps provide a comprehensive overview of how an XMsg travels from

### 1. User Call

1. A user calls an xdApp smart contract function on a rollup VM.
1. A user calls an xapp smart contract function on a rollup VM.

### 2. Smart Contract Logic

Expand Down
Loading

0 comments on commit 9e740de

Please sign in to comment.