Skip to content

Commit

Permalink
chore(docs): fix tools page (#1639)
Browse files Browse the repository at this point in the history
fix broken link and add operator init-nodes command

issue: none
  • Loading branch information
ttarsi authored Aug 5, 2024
1 parent 622ca75 commit a5467ff
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 2 deletions.
41 changes: 41 additions & 0 deletions docs/site/docs/develop/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
sidebar_position: 6
---

# FAQ

## Developing Smart Contracts

**How fast is a message delivered?**

Rollup to rollup messages are roughly 5-10s for "latest" messages and 12 minutes for "finalized" messages.

**How should I use finalized vs. latest?**

It depends on the use case, but we generally recommend using `finalized` for high value transactions where exactly once delivery semantics is critical. `latest` can be used for smaller magnitude transactions where delivery guarantees can be loosened.

**How much does an xcall cost?**

The cost of an `xcall` is a function of:

- destination chain: since an xcall is actually a function execution on a remote chain, we must consider the gas prices on that chain.
- calldata size: impacts gas fee on the destination
- gas limit: max gas you're willing to spend on the destination

**If xcall is successfully sent on the source chain but the tx on the destination fails, what will happen?**

An xcall will only revert on the destination if there is logic in your smart contract on the destination that reverts. Generally, we recommend not reverting when receiving an xcall, rather reverting on the source before sending the xcall if possible.

**What happens if a rollup reorgs?**

Reorgs have no impact on a `finalized` stream, as these streams wait for the rollup to be finalized on Ethereum before validating an XMsg.

**What chains does Omni support?**

Mainnet v1 launch: Ethereum, Omni, Arbitrum, Optimism, Base

Omega Testnet: Ethereum Holesky, Omni Omega, Arbitrum Sepolia, Optimism Sepolia, Base Sepolia

**Why doesn’t Omni wait for the 7-day challenge period for rollups?**

Rollups are actually finalized once transaction calldata is posted to L1. The 7 Day period is only from the perspective of L1 – because it takes smart contracts on L1 7 Days to confirm the state of a rollup. But anyone can compute what the current state of the rollup is before the 7 Day window by running an node for that rollup. Omni's validators each run L2 nodes for integrated rollups, and attest to the state of the rollup once txn calldata is posted.
8 changes: 8 additions & 0 deletions docs/site/docs/tools/cli/operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ sidebar_position: 3

# Operator Commands

## Start a full node

```bash
omni operator init-nodes --network=omega --moniker=foo --clean
cd ~/.omni/omega
docker compose up
```

## Registering as an Operator

Registers EigenLayer operator to Omni using the `operator.yml` file.
Expand Down
4 changes: 2 additions & 2 deletions docs/site/docs/tools/contracts/contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ sidebar_position: 1
Omni includes the following Solidity helpers to help you develop your Omni projects:

- [`XApp`](../../develop/xapp/installation.md) - A base contract that provides a set of common functions and variables for your contracts.
- [`XGreeter`](../../develop/xapp/example.md) - A simple contract that demonstrates how to use the `XApp` contract.
- [`XGreeter Template`](https://github.com/omni/hello-world-template) - A template that you can use to scaffold a new project with a `Greeter` and `GreetingBook` contract. Used by the Omni CLI `developer new` command.
- [`Hello World Template`](https://github.com/omni-network/hello-world-template) - A template that you can use to scaffold a new project with a `Greeter` and `GreetingBook` contract. Used by the Omni CLI `developer new` command.
- [`Hello World Walkthrough`](../../develop/xapp/example.md) - A simple contract that demonstrates how to use the `XApp` contract.

## Awesome Omni Examples and Templates

Expand Down
1 change: 1 addition & 0 deletions docs/site/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@ const sidebars: SidebarsConfig = {
value: "<div class='sidebar-separator'></div>",
},
"develop/contracts",
"develop/faq",
],
operateSidebar: [
{
Expand Down

0 comments on commit a5467ff

Please sign in to comment.