feat: (#39) Add evm contracts

.github/workflows/build.yaml

@@ -7,12 +7,16 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+        with:
+          submodules: 'recursive'
       - name: Set up JDK 1.8
         uses: actions/setup-java@v2
         with:
           distribution: temurin
           java-version: '8'
           cache: 'gradle'
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
       - name: Unit Tests
-        run: ./gradlew --info --warning-mode=all clean test
+        run: ./gradlew --info --warning-mode=all clean test

.gitignore

@@ -176,4 +176,10 @@ gradle.properties
 .java-version
 
 *.deploy.properties
-!dev.deploy.properties
+!dev.deploy.properties
+
+node_modules/
+artifacts/
+typechain-types/
+cache/
+cache_hardhat/

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/openzeppelin-contracts"]
+	path = lib/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts
+[submodule "lib/openzeppelin-contracts-upgradeable"]
+	path = lib/openzeppelin-contracts-upgradeable
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable

README.md

@@ -18,20 +18,34 @@ Clone this repo:
 git clone https://github.com/AxLabs/grantshares-contracts.git
 ```
 
+### Neo N3 contracts
 The GrantShares contracts use the [neow3j](https://neow3j.io) devpack and compiler which in turn uses Gradle as the 
 build tool. The contracts are located in the `main` source set.
 
-Test can be executed with the following command. Note, that you need a running Docker deamon for the tests to work.
+### Solidity contracts
+Since this project also has solidity code, we need to install the foundry toolchain by running the following commands:
+```shell
+curl -L https://foundry.paradigm.xyz | bash 
+source ~/.bashrc #this might differ if using a different shell
+foundryup
+```
+
+### Testing
+After installing these, the tests can be executed with the following command (Note that you need a running Docker daemon for the tests to work):
 
 ```shell
 ./gradlew test
 ```
 
 ## Deployment
 
-The scripts and configurations to deploy the contracts are in the `deploy` source set.  
+### Neo N3 contracts
+The scripts and configurations to deploy the neoN3 contracts are in the `deploy` source set.  
 Some basic scripts for invoking the contracts via the neow3j SDK are also located there.
 
+### Solidity contracts
+//TODO: Add deployment instructions for solidity contracts
+
 ## Security Audit
 
 The smart contracts have been audited by [Red4Sec](https://red4sec.com/en). The audit report can be found [here](https://bit.ly/3wZ14uI).

build.gradle

@@ -1,6 +1,7 @@
 plugins {
     id 'java'
     id 'io.neow3j.gradle-plugin' version '3.21.1'
+    id "com.github.node-gradle.node" version "7.1.0"
 }
 
 sourceCompatibility = JavaVersion.VERSION_1_8
@@ -38,6 +39,22 @@ tasks.withType(Test) {
     useJUnitPlatform()
 }
 
+node {
+    version = '20.18.1'
+    download = true
+}
+
+task compileSolidity(type : Exec) {
+    dependsOn('npmInstall')
+    commandLine 'forge', 'compile'
+}
+
+task testSolidity(type: Exec) {
+    dependsOn('compileSolidity')
+    commandLine 'forge', 'test'
+}
+test.dependsOn('testSolidity')
+
 neow3jCompile {
     className = "com.axlabs.neo.grantshares.GrantSharesTreasury"
-}
+}

foundry.toml

@@ -0,0 +1,7 @@
+[profile.default]
+src = 'src/main/solidity'
+test = 'src/test/solidity'
+out = 'artifacts'
+libs = ['lib']
+
+# See more config options https://github.com/foundry-rs/foundry/tree/master/config

hardhat.config.ts

@@ -0,0 +1,51 @@
+import fs from "fs";
+import "@typechain/hardhat";
+import "hardhat-preprocessor";
+import { HardhatUserConfig, task } from "hardhat/config";
+
+import example from "./src/deploy/typescript/example";
+
+function getRemappings() {
+  return fs
+    .readFileSync("remappings.txt", "utf8")
+    .split("\n")
+    .filter(Boolean)
+    .map((line) => line.trim().split("="));
+}
+
+task("example", "Example task").setAction(example);
+
+const config: HardhatUserConfig = {
+  solidity: {
+    version: "0.8.20",
+    settings: {
+      optimizer: {
+        enabled: true,
+        runs: 200,
+      },
+    },
+  },
+  paths: {
+    sources: "./src/main/solidity", // Use ./src rather than ./contracts as Hardhat expects
+    cache: "./cache_hardhat", // Use a different cache for Hardhat than Foundry
+  },
+  // This fully resolves paths for imports in the ./lib directory for Hardhat
+  //@ts-ignore
+  preprocess: {
+    //@ts-ignore
+    eachLine: (hre) => ({
+      transform: (line: string) => {
+        if (line.match(/^\s*import /i)) {
+          getRemappings().forEach(([find, replace]) => {
+            if (line.match(find)) {
+              line = line.replace(find, replace);
+            }
+          });
+        }
+        return line;
+      },
+    }),
+  },
+};
+
+export default config;