Omni Monorepo

About Omni

This monorepo contains all source code for the Omni protocol. Omni's goal is to make it easy for smart contract developers to source liquidity and users from anywhere. The protocol consists of various components including an EVM and cross-chain messaging.

The Omni Docs are the best place to get started learning about Omni.

Quickstart

Ensure go, goreleaser and docker are installed.

# Build local docker containers
make build-docker

# Run the end-to-end tests on a local devnet
MANIFEST=devnet1 make e2e-run

# Start a local devnet
make devnet-deploy

# Stop the local devnet
make devnet-clean

If any of above commands fail, see the troubleshooting section.

Directory Structure

├── cli: Omni command line interface.
├── contracts: Solidity contracts and related software.
├── docs: Resources and website for https://docs.omni.network.
├── e2e: Deployments, testing, and live network management.
├── halo: Omni consensus client.
├── lib: Core libraries used across the Omni stack.
├── monitor: Monitoring service for the network.
├── octane: Cosmos SDK module for the EVM.
├── relayer: Relayer service for cross-chain messages and transactions.
├── scripts: Utility scripts for development and operational tasks.
├── sdk: SDK for building applications with Omni.
├── solver: Reference implementation for SolverNet.

Contributing

We are open to contributions, but don't currently have a formal process for contributors. If you are interested, browse through open issues or reach out to chat with the team.

Follow these steps to set up a functional development environment:

1. Install Docker Desktop.
2. Setup commit signing: 2a. Create a PGP key pair 2b. Add the public key to Github. 2c. Enabled commit signing 2d. Troubleshoot any issues
3. Run make setup to initialize your dev environment. See Makefile for details.

Security

Omni has a bug bounty program via Immunefi. You can find more information here.