Skip to content

Commit

Permalink
docs(protocol): reorganise protocol section (#560)
Browse files Browse the repository at this point in the history
Reorganises the docs "protocol" section, expanding it across the sidebar
and adds some sections

task: https://app.asana.com/0/0/1206696792863505/f
  • Loading branch information
idea404 authored Mar 11, 2024
1 parent 0f09c72 commit d17cce1
Show file tree
Hide file tree
Showing 34 changed files with 642 additions and 263 deletions.
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/introduction.md), [the network](./protocol/introduction.md), [developer docs](./develop/contracts.md) and [running a validator](./operate/introduction/introduction.md).
Please read on to learn [about Omni](./learn/introduction/introduction.md), [the network](./protocol/introduction/introduction.md), [developer docs](./develop/contracts.md) and [running a validator](./operate/introduction/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/introduction.md) section.
For a more detailed overview, see the [Protocol](../protocol/introduction/introduction.md) section.

## Global EVM-Compatible Application Development

Expand All @@ -27,11 +27,11 @@ The native token is integral to Omni's ecosystem, serving three primary function

This design allows Omni to manage DDoS attacks, provide "gas liquidity" for seamless transactions across rollups, and progressively decentralize governance. This approach ensures backward compatibility with local gas tokens through an abstracted gas marketplace, highlighting the native token's role in enhancing the network's functionality and security.

For detailed information on how the native token is utilized for gas abstraction and supports global application development, refer to the protocol [Fees](../protocol/architecture/fees.md) section.
For detailed information on how the native token is utilized for gas abstraction and supports global application development, refer to the protocol [Fees](../protocol/xmessages/fees.md) section.

## 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/architecture.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.

Expand Down
2 changes: 1 addition & 1 deletion docs/site/docs/learn/omni/consensus.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ Omni's Integrated Consensus represents a significant leap forward in blockchain

Omni's adoption of Integrated Consensus underscores its commitment to fostering a more connected and efficient blockchain world, where the boundaries between different chains and technologies blur, creating a unified and powerful platform for decentralized applications and services.

For a deeper dive into Omni's Integrated Consensus and its impact on blockchain interoperability, [visit the protocol section](../../protocol/introduction.md).
For a deeper dive into Omni's Integrated Consensus and its impact on blockchain interoperability, [visit the protocol section](../../protocol/introduction/introduction.md).
2 changes: 1 addition & 1 deletion docs/site/docs/learn/omni/restaking.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ In the Omni network, **validators** have the critical job of verifying the authe
Omni's staking implementation is supported by a suite of smart contracts designed to facilitate the staking process:

- **Omni Staking Contract**: Implemented on the Omni EVM, this contract tracks each validator’s stake and delegations, distributes rewards, and manages slashing events.
- **Omni AVS Contract**: Located on Ethereum L1, it registers Omni as an application with the EigenLayer protocol, enabling operators to provide validation services to the Omni blockchain.
- **Omni AVS Contract**: Located on Ethereum, it registers Omni as an application with the EigenLayer protocol, enabling operators to provide validation services to the Omni blockchain.
- **Omni Portal Contracts**: Deployed on the Omni EVM and connected rollup VMs, these contracts maintain a record of the Omni validator set’s stake, delegations, and voting power.

## Securing the Omni Chain with Restaked **\$ETH**
Expand Down
7 changes: 0 additions & 7 deletions docs/site/docs/protocol/architecture/architecture.md

This file was deleted.

88 changes: 0 additions & 88 deletions docs/site/docs/protocol/architecture/components.md

This file was deleted.

45 changes: 0 additions & 45 deletions docs/site/docs/protocol/architecture/portal.md

This file was deleted.

21 changes: 0 additions & 21 deletions docs/site/docs/protocol/architecture/relayer.md

This file was deleted.

Loading

0 comments on commit d17cce1

Please sign in to comment.