Skip to content

Commit

Permalink
docs(develop/protocol): nits and grammar (#921)
Browse files Browse the repository at this point in the history
  • Loading branch information
idea404 authored Apr 23, 2024
1 parent 8f9e361 commit 3005c38
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/site/docs/develop/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can use Omni to call a contract on another chain. We call this an `xcall`.

```solidity
omni.xcall(
destChainId, // desintation chain id
destChainId, // destination chain id
to, // contract address on the destination chain
data // abi encoded calldata, ex abi.encodeWithSignature("foo()")
)
Expand Down
4 changes: 2 additions & 2 deletions docs/site/docs/develop/xapp/fees.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Fees are determined by an `xcall`'s destination chain, calldata, and gas limit.

```solidity
uint256 fee = feeFor(
destChainId, // desintation chain id
destChainId, // destination chain id
data, // abi encoded calldata, ex abi.encodeWithSignature("foo()")
gasLimit // gas limit to enforce on execution
)
Expand All @@ -22,7 +22,7 @@ Or, using the default gas limit.
```solidity
uint256 fee = feeFor(
destChainId, // desintation chain id
destChainId, // destination chain id
data, // abi encoded calldata, ex abi.encodeWithSignature("foo()")
)
```
Expand Down
2 changes: 1 addition & 1 deletion docs/site/docs/develop/xapp/gas.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Contract calls consume gas. Omni enforces a gas limit when executing an `xcall`.

```solidity
xcall(
destChainId, // desintation chain id
destChainId, // destination chain id
to, // contract address on the destination chain
data, // abi encoded calldata, ex abi.encodeWithSignature("foo()")
gasLimit // gas limit to enforce on execution
Expand Down
4 changes: 1 addition & 3 deletions docs/site/docs/protocol/introduction/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,4 @@ The Omni protocol is composed of five primary components: **rollup networks**, *
- The **consensus** layer is implemented by the Omni consensus client, halo, and uses CometBFT for consensus on XMsgs and Omni EVM blocks.
- **EigenLayer restaking contracts** exist on Ethereum L1 and connect Omni with its restaking participants. Omni is registered with EigenLayer as an [Actively Validated Service](https://docs.eigenlayer.xyz/eigenlayer/overview/key-terms) (AVS) and Omni validators serve the [Operator](https://docs.eigenlayer.xyz/eigenlayer/overview/key-terms) for the AVS.
- **[Portal contracts](../xmessages/components/portals.md)** implement the on-chain logic of the Omni protocol and serve as the main interface for creating cross-network messages. They are deployed to all supported rollup VMs as well as the Omni EVM on the Omni network. They all have the same address and calls to and from are abstracted with the [solidity interface](https://github.com/omni-network/omni/blob/22bd4460e254eee4ebf79239897ea04ba9b2db43/contracts/src/interfaces/IOmniPortal.sol).
- **[Portal contracts](../xmessages/components/portals.md)** implement Omni’s on-chain logic on external rollup networks. Portals are deployed on each connected rollup VM and the Omni EVM. Portal contracts use the same address on every rollup. Calls to and from Portals are abstracted with the [solidity interface](https://github.com/omni-network/omni/blob/22bd4460e254eee4ebf79239897ea04ba9b2db43/contracts/src/interfaces/IOmniPortal.sol).
- **[Relayer](../xmessages/components/relayer.md)** responsible for delivering attested cross-network messages from the Omni network to destination rollup VMs. Monitors the Omni Consensus Layer until ⅔ (>66%) of the validator set attested to the “next” block on each source chain, then proceeds to forwarding the respective `XMsg` list included in the block.
- Relayers are responsible for delivering confirmed cross-network messages from Omni to destination rollups. When 2/3 (>66%) of Omni validators attest to a given XBlock, relayers forward the XBlock’s corresponding XMsg list to destination rollup networks.
- **[Relayers](../xmessages/components/relayer.md)** are responsible for delivering attested cross-network messages from the Omni network to destination rollup VMs. Monitors the Omni Consensus Layer until ⅔ (>66%) of the validator set attested to the “next” block on each source chain, then proceeds to forwarding the respective `XMsg` list included in the block.
4 changes: 2 additions & 2 deletions docs/site/docs/protocol/xmessages/xmsg.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The following steps provide a comprehensive overview of how an XMsg travels from

```solidity
omni.xcall(
uint64 destChainId, // desintation chain id
uint64 destChainId, // destination chain id
address to, // contract address on the dest rollup to execute the call on
bytes memory data // calldata for the transaction, abi encoded
)
Expand Down Expand Up @@ -90,7 +90,7 @@ The following steps provide a comprehensive overview of how an XMsg travels from

- Validators attest to `XBlock` hashes during CometBFT consensus. Each Omni consensus layer validator monitors every finalized block for all source networks in `halo`. By default, validators wait for block finalization, or some other agreed-upon finality mechanism, to ensure consistent and secure `XMsg` processing.

All validators usehalo to attest to `XBlock`s via CometBFT vote extensions. All validators in the CometBFT validator set should attest to all `XBlock`. An attestation is defined by the following `Attestation` type:
All validators use halo to attest to `XBlock`s via CometBFT vote extensions. All validators in the CometBFT validator set should attest to all `XBlock`. An attestation is defined by the following `Attestation` type:

```go
type Attestation (
Expand Down

0 comments on commit 3005c38

Please sign in to comment.