🎉 Basic structure

onlydustxyz · Sep 20, 2022 · 85f8771 · 85f8771
commit 85f8771
Show file tree

Hide file tree

Showing 8 changed files with 121 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,13 @@
+# Node
+node_modules
+
+target
+build
+artifacts
+env
+venv
+.idea
+logs.json
+
+# vscode
+.vscode
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,5 @@
+[submodule "cairo_contracts"]
+	url = https://github.com/OpenZeppelin/cairo-contracts
+	path = lib/cairo_contracts
+	branch = refs/heads/v0.4.0b
+
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 OnlyDust
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,64 @@
+<p align="center">
+    <img src="resources/img/logo.png" height="200">
+</p>
+<div align="center">
+  <h1 align="center">Zk-EVM</h1>
+  <p align="center">
+    <a href="https://discord.gg/onlydust">
+        <img src="https://img.shields.io/badge/Discord-6666FF?style=for-the-badge&logo=discord&logoColor=white">
+    </a>
+    <a href="https://twitter.com/intent/follow?screen_name=onlydust_xyz">
+        <img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white">
+    </a>
+    <a href="https://app.onlydust.xyz/projects/523762227">
+        <img src="https://img.shields.io/badge/Contribute-6A1B9A?style=for-the-badge&logo=notion&logoColor=white">
+    </a>
+  </p>
+
+  <h3 align="center">Starknet implementation of the EVM</h3>
+</div>
+
+> ## ⚠️ WARNING! ⚠️
+>
+> This repo contains highly experimental code.
+> Expect rapid iteration.
+
+## 🎟️ Description
+
+Implementing the EVM in Cairo is both a fun technical challenge and an actual way to port Solidity smart contracts to Starknet.
+
+It leads the way to more complex usecases, such as a full-fledged EVM-compatible layer 3.
+
+## 🎗️ Prerequisites
+
+Install [Protostar](https://docs.swmansion.com/protostar/) version 0.4.2 or above.
+
+```
+curl -L https://raw.githubusercontent.com/software-mansion/protostar/master/install.sh | bash
+```
+
+## 📦 Installation
+
+```
+protostar install
+```
+
+## 🔬 Usage
+
+```
+protostar build
+```
+
+## 🌡️ Testing
+
+```
+protostar test
+```
+
+## 🫶 Contributing
+
+Please visit the [project page](https://app.onlydust.xyz/projects/523762227) on the OnlyDust platform to find contributions.
+
+## 📄 License
+
+**Zk-EVM** is released under the [MIT](LICENSE).
diff --git a/lib/.gitkeep b/lib/.gitkeep
diff --git a/protostar.toml b/protostar.toml
@@ -0,0 +1,17 @@
+["protostar.config"]
+protostar_version = "0.4.2"
+
+["protostar.project"]
+libs_path = "lib"
+
+["protostar.shared_command_configs"]
+cairo_path = ["src"]
+
+[profile.ci.protostar.shared_command_configs]
+no_color = true
+target = "src/onlydust/zk-evm/tests"
+
+["protostar.contracts"]
+evm = [
+  "./src/onlydust/zk-evm/evm.cairo",
+]
diff --git a/resources/img/logo.png b/resources/img/logo.png
diff --git a/src/onlydust/zk-evm/evm.cairo b/src/onlydust/zk-evm/evm.cairo
@@ -0,0 +1 @@
+%lang starknet