Skip to content

Latest commit

 

History

History
71 lines (52 loc) · 4.09 KB

README.md

File metadata and controls

71 lines (52 loc) · 4.09 KB
Raw

Omni Monorepo

Tests

Logo

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

├── contracts: Solidity contracts and related software.
│ ├── core/: Core protocol smart contracts.
│ ├── avs/: Eigen AVS smart contracts.
│ ├── bindings/: Go smart contract bindings.
│ └── allocs/: Predeploy allocations.
├── docs: Documentation resources, including images and diagrams.
├── halo: The Halo instance, including application logic and attestation mechanisms.
│ ├── app: Application logic for Halo.
│ └── cmd: Command-line tools and utilities.
├── lib: Core libraries for various protocol functionalities.
│ ├── cchain: Consensus chain interaction utilities.
│ └── xchain: Cross-chain messaging and utilities.
├── octane: Octane is a modular framework for the EVM.
│ └── evmengine: The EVMEngine cosmos module.
├── relayer: Relayer service for cross-chain messages and transactions.
│ └── app: Application logic for the relayer service.
├── scripts: Utility scripts for development and operational tasks.
└── test: Testing suite for end-to-end, smoke, and utility testing.

Contributing

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

Follow these steps to set up a functional development environment:

  1. Install Docker Desktop.
  2. Create a PGP key pair and add the public key to Github.
  3. Run make setup to initialize your dev environment. See Makefile for details.

Security

Please refer to SECURITY.md.