Merge branch 'readme-updates' into main

.eslintrc

@@ -0,0 +1,12 @@
+{
+  "extends": ["@matterlabs/eslint-config-typescript"],
+  "rules": {
+    "no-multiple-empty-lines": ["error", { "max": 1 }],
+    "@typescript-eslint/no-namespace": "off",
+    "@typescript-eslint/ban-ts-comment": "off",
+    "import/no-named-as-default-member": "off",
+    "import/namespace": "off",
+    "import/no-unresolved": "off",
+    "import/order": "off"
+  }
+}

.githooks/pre-commit

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+CYAN='\033[0;36m'
+NC='\033[0m' # No Color
+RED='\033[0;31m'
+
+# Check that the code is formatted in the given directory provided in the first argument
+function check_prettier {
+    if ! yarn prettier:check; then
+        echo "${RED}Commit error! Cannot commit unformatted code!${NC}"
+        echo "Prettier errors found. Please format the code via ${CYAN}yarn prettier:fix${NC}!"
+        exit 1
+    fi
+}
+
+check_prettier

.githooks/pre-push

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+CYAN='\033[0;36m'
+NC='\033[0m' # No Color
+RED='\033[0;31m'
+
+# Checking that the code is linted and formatted in the given directory provided in the first argument
+function check_lint {
+    if ! yarn lint:check; then
+        echo "${RED}Push error! Cannot push unlinted code!${NC}"
+        echo "Lint errors found. Please lint the code via ${CYAN}yarn lint:fix${NC} and/or fix the errors manually!"
+        exit 1
+    fi
+}
+
+check_lint

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,9 +1,9 @@
 ---
 name: Scripts-Related Bug Report
 about: Use this template for reporting script related bugs. For contract bugs, see our security policy.
-title: ''
+title: ""
 labels: bug
-assignees: ''
+assignees: ""
 ---
 
 ### 🐛 Script Bug Report

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,9 +1,9 @@
 ---
 name: Feature request
 about: Use this template for requesting features
-title: ''
+title: ""
 labels: feat
-assignees: ''
+assignees: ""
 ---
 
 ### 🌟 Feature Request

.github/pull_request_template.md

@@ -17,4 +17,3 @@
 - [ ] PR title corresponds to the body of PR (we generate changelog entries from PRs).
 - [ ] Tests for the changes have been added / updated.
 - [ ] Documentation comments have been added / updated.
-- [ ] Code has been formatted via `zk fmt` and `zk lint`.

.github/workflows/ci.yaml

@@ -0,0 +1,163 @@
+name: "CI"
+
+on:
+  pull_request:
+  push:
+    branches:
+      - dev
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.18.0
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Build artifacts
+        run: yarn build
+
+      - name: Create cache
+        uses: actions/cache/save@v3
+        with:
+          key: artifacts-${{ github.sha }}
+          path: |
+            artifacts-zk
+            cache-zk
+            typechain-types
+            contracts/artifacts
+            contracts/precompiles/artifacts
+            bootloader/build
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.18.0
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Run lint
+        run: yarn lint:check
+
+  check_hashes:
+    needs: [build]
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.18.0
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Restore artifacts cache
+        uses: actions/cache/restore@v3
+        with:
+          fail-on-cache-miss: true
+          key: artifacts-${{ github.sha }}
+          path: |
+            artifacts-zk
+            cache-zk
+            typechain-types
+            contracts/artifacts
+            contracts/precompiles/artifacts
+            bootloader/build
+
+      - name: Check hashes
+        run: yarn calculate-hashes:check
+
+  test:
+    needs: [build, lint]
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.18.0
+          cache: yarn
+
+      - name: Use era-test-node for testing
+        uses: dutterbutter/era-test-node-action@v0.1.3
+        with:
+          releaseTag: v0.0.1-alpha.boojum
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Restore artifacts cache
+        uses: actions/cache/restore@v3
+        with:
+          fail-on-cache-miss: true
+          key: artifacts-${{ github.sha }}
+          path: |
+            artifacts-zk
+            cache-zk
+            typechain-types
+            contracts/artifacts
+            contracts/precompiles/artifacts
+            bootloader/build
+
+      - name: Run tests
+        run: yarn test
+
+      - name: Print output logs of era_test_node
+        if: always()
+        run: cat era_test_node.log
+
+  test_bootloader:
+    needs: [build, lint]
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+
+      - name: Install rust
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: nightly-2023-04-17
+
+      - name: Restore artifacts cache
+        uses: actions/cache/restore@v3
+        with:
+          fail-on-cache-miss: true
+          key: artifacts-${{ github.sha }}
+          path: |
+            artifacts-zk
+            cache-zk
+            typechain-types
+            contracts/artifacts
+            contracts/precompiles/artifacts
+            bootloader/build
+
+      - name: Run bootloader tests
+        run: "cd bootloader/test_infra && cargo run"

.github/workflows/nodejs-license.yaml

@@ -49,7 +49,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 16.15.1
+          node-version: 18.18.0
 
       - name: Install yarn
         run: npm install -g yarn license-checker

.gitignore

@@ -8,3 +8,10 @@ typechain
 build
 yarn-debug.log*
 yarn-error.log*
+
+# Yarn files
+.yarn/
+.yarnrc.yml
+
+.vscode
+target/

.markdownlintignore

@@ -0,0 +1 @@
+node_modules

.markdownlintrc

@@ -0,0 +1,9 @@
+{
+  "default": true,
+  "header-increment": false,
+  "no-duplicate-header": false,
+  "no-inline-html": false,
+  "line-length": false,
+  "fenced-code-language": false,
+  "no-multiple-blanks": false
+}

.nvmrc

@@ -0,0 +1 @@
+v18.18.0

.prettierignore

@@ -0,0 +1 @@
+contracts/openzeppelin

.prettierrc.js

@@ -0,0 +1,16 @@
+module.exports = {
+  ...require("@matterlabs/prettier-config"),
+  plugins: ["prettier-plugin-solidity"],
+  overrides: [
+    {
+      files: "*.sol",
+      options: {
+        bracketSpacing: false,
+        printWidth: 120,
+        singleQuote: false,
+        tabWidth: 4,
+        useTabs: false,
+      },
+    },
+  ],
+};

.solhint.json

@@ -0,0 +1,20 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "state-visibility": "off",
+    "func-visibility": ["warn", { "ignoreConstructors": true }],
+    "var-name-mixedcase": "off",
+    "avoid-call-value": "off",
+    "no-empty-blocks": "off",
+    "not-rely-on-time": "off",
+    "avoid-low-level-calls": "off",
+    "no-inline-assembly": "off",
+    "const-name-snakecase": "off",
+    "no-complex-fallback": "off",
+    "reason-string": "off",
+    "func-name-mixedcase": "off",
+    "no-unused-vars": "off",
+    "max-states-count": "off",
+    "compiler-version": ["warn", "^0.8.0"]
+  }
+}

.solhintignore

@@ -0,0 +1 @@
+contracts/openzeppelin