Skip to main content

3-Minute Cross-Chain dApp

This QuickStart guide will run through how to start an Omni cross chain dApp in less than three minutes.

In this guide you will:

  • Install the Omni CLI, scaffold a new project and run a local devnet
  • Deploy contracts using foundry to the local devnet and test their functionality

Steps​

Step 1: Install the Omni CLI​

First, install the Omni CLI by running the following command:

curl -sSfL https://raw.githubusercontent.com/omni-network/omni/main/scripts/install_omni_cli.sh | sh -s

You may otherwise install from source by following the steps shown in the Omni CLI Tools section.

Step 2: Scaffold a new project​

Next, create a new directory for your project and scaffold a new project using the Omni CLI:

mkdir my-omni-dapp
cd my-omni-dapp
omni developer new

Note: this requires foundry to be installed on your machine.

Test the Contracts with Forge

You can test the contracts with Forge by running the following command:

forge test

Step 3: Run a local devnet​

Start a local devnet by running the following command:

omni devnet start

Note: this requires Docker to be installed on your machine.

Step 4: Deploy contracts​

Deploy the contracts to the local devnet using foundry:

Obtaining Parameter Values

You can obtain RPC URL values and portal addresses for the running devnet chains by running the following command:

omni devnet info

And the private key value is the second listed anvil private key, found by running:

anvil

These values are found in ./script/bash/.env.example and are used to deploy the contracts. You can rename the file to .env and fill in the values for other networks. You don't have to run any of these commands or update the .env file if you are following the tutorial steps.

This .env file is used by the bash deploy.sh script to deploy the contracts. You can otherwise choose to deploy the contracts using only forge on your terminal as shown in this tutorial.

export PORTAL_ADDRESS=0xb835dc695c6bfc8373c0d56973b5d9e9b083e97b
export GLOBAL_GREETER_ADDRESS=0x8464135c8F25Da09e49BC8782676a84730C318bC
forge script DeployGlobalGreeter --broadcast --rpc-url http://localhost:8000 --private-key 0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d
forge script DeployRollupGreeter --broadcast --rpc-url http://localhost:8001 --private-key 0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d
forge script DeployRollupGreeter --broadcast --rpc-url http://localhost:8002 --private-key 0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d

Note: we know the address the GlobalGreeter will be deployed to as a new network is started and the nonce for the account used to deploy is always the same (0). The RollupGreeter contract is deployed to the same address on both the mock chains, since these are also new networks and the account has no actions on that account.

Step 5: Perform a Cross-Chain Greet​

You can now perform a cross-rollup greet by running the following command:

Obtaining Deployment Addresses

You can obtain the XGreeter deployment addresses from the output of the previous forge script deployment.

Because the devnet has just been started, the addresses will be the same as the ones shown below:

omni_evm: 0x8464135c8F25Da09e49BC8782676a84730C318bC
mock_op: 0x8464135c8F25Da09e49BC8782676a84730C318bC
mock_arb: 0x8464135c8F25Da09e49BC8782676a84730C318bC
cast send 0x8464135c8F25Da09e49BC8782676a84730C318bC 'greet(string)' 'Yay in 3 minutes!' --private-key 0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d --rpc-url http://localhost:8001 --value 1ether

Step 6: Check the Greet​

You can check the greet has been saved on the Omni EVM global state by running the following command:

cast call 0x8464135c8F25Da09e49BC8782676a84730C318bC "lastGreet():(uint64,uint256,uint256,address,address,string)" --rpc-url http://localhost:8000

🎉 Done 🎉​

You have successfully deployed and interacted with an Omni cross-chain dApp in less than three minutes!

gg wp