Skip to content
This repository has been archived by the owner on Jun 9, 2024. It is now read-only.

Latest commit

 

History

History
103 lines (76 loc) · 4.63 KB

README.md

File metadata and controls

103 lines (76 loc) · 4.63 KB
Raw

🚧 WARNING: THIS PROJECT IS DEPRECATED 🚧

This project is deprecated. If you are interested in maintaining it, please contact itsdevbear on GitHub or Twitter.

Polaris Monorepo ❄️🔭

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

What is Polaris?

Introducing Polaris, the revolutionary framework designed to simplify the integration of an Ethereum Virtual Machine (EVM) into your application. Polaris is built with a clean, easy-to-integrate API that eliminates the need for developers to spend time hacking together their own EVM integration solutions. Our framework is highly modular, allowing you to choose the components that best fit your needs and integrate an EVM environment into virtually any application.

Polaris is built with several core principles in mind:

  1. Modularity: Each component is developed as a distinct package, complete with thorough testing, documentation, and benchmarking. You can use these components individually or combine them to create innovative EVM integrations.
  2. Configurability: We want Polaris to be accessible to as many teams and use cases as possible. To support this, our framework is highly configurable, allowing you to tailor it to your specific needs.
  3. Performance: In today's competitive crypto landscape, performance is key. Polaris is optimized to deliver the highest levels of performance and efficiency.
  4. Contributor Friendliness: We believe that open collaboration is key to driving innovation in blockchain development. While Polaris is currently licensed under BUSL-1.1, we plan to adjust our licensing to support contributor-based schemes as we approach production readiness.
  5. Memes: If ur PR doesn't have a meme in it like idk sry bro, gg wp glhf.

Documentation

If you want to build on top of Polaris, take a look at our documentation. If you want to help contribute to the framework, check out the Framework Specs.

Directory Structure

Polaris utilizes go workspaces to break up the repository into logical sections, helping to reduce cognitive overhead.

🔭 Polaris 🔭
├── build: Build scripts and developer tooling.
├── contracts: Contracts and bindings for Polaris (and hosts).
├── cosmos: Polaris integrated into a Cosmos-SDK based chain.
├── e2e: End-to-end testing utilities.
├── eth: The Core of the Polaris Ethereum Framework.
├── lib: A collection of libraries used throughout the repo.
├── proto: Protobuf definitions.

Build & Test

Golang 1.20+ and Foundry are required for Polaris.

  1. Install go 1.21+ 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 jq -y
export PATH=$PATH:/usr/local/go/bin
export PATH=$PATH:$(go env GOPATH)/bin

    For Mac:

    cd $HOME
brew install go jq
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
make test-unit

  4. Start a local development network:

    make start