itsdevbear/polaris

Polaris is a modular implementation of the Ethereum Virtual Machine (EVM). It can be easily integrated into any consensus engine or application, including the Cosmos-SDK.

Polaris ❄️🔭

The project is still work in progress, see the disclaimer below.

Welcome to Polaris

Polaris introduces the new standard for EVM integrations. With improvements to speed, security, reliability, and an extended set of features, Polaris will be able to support the next generation of decentralized applications while offering a compelling alternative to existing implementations.

This meant that we had to built Polaris with serveral core principles in mind:

1. Modular: Every component is built out as a distinct, logical package, with thorough testing, documentation, and benchmarking. The goal is for developers to use these components as individual pieces and combine them creatively to integrate an EVM environment into almost any application.
2. Configurable: We want as many different application frameworks, consensus engines and teams using Polaris as possible. In order to support a wide variety of use cases, Polaris has to be highly configurable.
3. Performant: Polaris must perform at the highest level to remain competitive in today's fast-paced and demanding crypto space.
4. Contributor Friendly: Depsite currently being BUSL-1.1 licensed, the goal for Polaris is to attract high quality contributors in order to build adoption. We are going to adjust licensing to a contributor based scheme as we work with teams / approach production readiness.
5. Have Memes: If ur PR doesn't have a meme in it like idk sry bro, gg wp.

Repository Layout

Polaris utilizes go workspaces to break up the repository into sections to help reduce cognitive overhead.

.
├── build                   # Build scripts and utils
├── docs                    # Documentation files
├── eth                     # The core Polaris Ethereum implementation
├── lib                     # Library files usable throughout the repo
├── host                     
│   ├── cosmos              # A Cosmos integration of Polaris
│   │     ├── ....
│   │     ├── ....
│   │     └── x/evm         # Cosmos `x/evm` module
│   └── playground          # We love the playground
├── testutil                # Various testing utilities
├── LICENSE                 # Licensing information
└── README.md               # This README

Build & Test

Golang 1.20+ and Foundry are required for Polaris.

1. Install Go 1.20+ from the official site or the method of your choice. Ensure that your GOPATH and GOBIN environment variables are properly set up by using the following commands:

   For Ubuntu:

   cd $HOME
   sudo apt-get install golang -y
   export PATH=$PATH:/usr/local/go/bin
   export PATH=$PATH:$(go env GOPATH)/bin

   For Mac:

   cd $HOME
   brew install go
   export PATH=$PATH:/opt/homebrew/bin/go
   export PATH=$PATH:$(go env GOPATH)/bin
   

2. Install Foundry:

   curl -L https://foundry.paradigm.xyz | bash

3. Clone, Setup and Test:

cd $HOME
git clone https://github.com/berachain/polaris
cd polaris
git checkout main
go run build/setup.go
mage test

🚧 WARNING: UNDER CONSTRUCTION 🚧

This project is work in progress and subject to frequent changes as we are still working on wiring up the final system. It has not been audited for security purposes and should not be used in production yet.

The network will have an Ethereum JSON-RPC server running at http://localhost:1317/eth/rpc and a Tendermint RPC server running at http://localhost:26657.