Skip to content

Commit

Permalink
Omni Octane EVM tut
Browse files Browse the repository at this point in the history
  • Loading branch information
yarikbratashchuk committed Jun 28, 2024
1 parent 4f8b4b5 commit 857fe1f
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 0 deletions.
1 change: 1 addition & 0 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,7 @@ function sidebarHome() {
collapsed: true,
items: [
{ text: "CosmWasm rollup", link: "/tutorials/cosmwasm" },
{ text: "Omni Octane EMV rollup", link: "/tutorials/octane-evm" },
{ text: "Polaris EVM rollup", link: "/tutorials/polaris-evm" },
],
},
Expand Down
65 changes: 65 additions & 0 deletions tutorials/octane-evm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Quick start guide for Omni Octane with Rollkit

<script setup>
import constants from '../.vitepress/constants/constants.js'
</script>

This guide will help you quickly set up and run an Omni node using Rollkit and local-DA.

## 📦 Clone the Omni repository

To get started, clone the Omni repository with the Rollkit branch:

```bash
git clone -b rollkit https://github.com/rollkit/omni.git
cd omni
```

## 🏗️ Build Docker images

Before running Omni, you need to build the Docker images. This step requires GoReleaser to be installed on your system. If you don't have GoReleaser, you'll need to install it first:

- On macOS with Homebrew:
```bash
brew install goreleaser
```
- On Linux or Windows with Go installed:
```bash
go install github.com/goreleaser/goreleaser@latest
```

Make sure GoReleaser is in your PATH after installation.

Once GoReleaser is installed, run the following command to build the Docker images:

```bash
make build-docker
```

This command will build all the necessary Docker images for running Omni with Rollkit.

If you encounter any issues with GoReleaser or the build process, make sure you have sufficient free space on your machine. You can check your available disk space using the `df -h` command on Linux/macOS or `powershell -command "Get-PSDrive -PSProvider 'FileSystem'"` on Windows.

## 🚀 Deploy Omni with Rollkit and local-DA

To start your Omni node with Rollkit and local-DA, execute:

```bash
make devnet-zero-deploy
```

Upon execution, the command will set up and start your Omni node. You should see output indicating the progress and status of your node.

## 🛑 Stopping the node

When you're done and want to stop the Omni node, use the following command:

```bash
make devnet-zero-clean
```

This will stop all running containers and clean up the environment.

## 🎉 Conclusion

That's it! You've successfully set up and run an Omni node with Rollkit and local-DA. This setup allows you to experiment with Omni's capabilities integrated with Rollkit.

0 comments on commit 857fe1f

Please sign in to comment.