From 3005c38df1a16f782035084e21de9d21ce6d1694 Mon Sep 17 00:00:00 2001 From: Dennis Date: Tue, 23 Apr 2024 18:53:18 +0200 Subject: [PATCH] docs(develop/protocol): nits and grammar (#921) small grammar fixes task: https://app.asana.com/0/1206208509925075/1207044438856782/f --- docs/site/docs/develop/introduction.md | 2 +- docs/site/docs/develop/xapp/fees.md | 4 ++-- docs/site/docs/develop/xapp/gas.md | 2 +- docs/site/docs/protocol/introduction/components.md | 4 +--- docs/site/docs/protocol/xmessages/xmsg.md | 4 ++-- 5 files changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/site/docs/develop/introduction.md b/docs/site/docs/develop/introduction.md index 12fceef95..c0c9b290f 100644 --- a/docs/site/docs/develop/introduction.md +++ b/docs/site/docs/develop/introduction.md @@ -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()") ) diff --git a/docs/site/docs/develop/xapp/fees.md b/docs/site/docs/develop/xapp/fees.md index 83d837dde..73addae72 100644 --- a/docs/site/docs/develop/xapp/fees.md +++ b/docs/site/docs/develop/xapp/fees.md @@ -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 ) @@ -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()") ) ``` diff --git a/docs/site/docs/develop/xapp/gas.md b/docs/site/docs/develop/xapp/gas.md index 35fbc6d22..54da487ad 100644 --- a/docs/site/docs/develop/xapp/gas.md +++ b/docs/site/docs/develop/xapp/gas.md @@ -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 diff --git a/docs/site/docs/protocol/introduction/components.md b/docs/site/docs/protocol/introduction/components.md index 666b5c3ad..3150cc538 100644 --- a/docs/site/docs/protocol/introduction/components.md +++ b/docs/site/docs/protocol/introduction/components.md @@ -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. diff --git a/docs/site/docs/protocol/xmessages/xmsg.md b/docs/site/docs/protocol/xmessages/xmsg.md index 15d6083dd..1fe8367be 100644 --- a/docs/site/docs/protocol/xmessages/xmsg.md +++ b/docs/site/docs/protocol/xmessages/xmsg.md @@ -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 ) @@ -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 (