Merge pull request #1 from privacy-scaling-explorations/chore/init-repo

chore: init zk-kit.solidity repo

.commitlintrc.js

@@ -0,0 +1,20 @@
+const fs = require("node:fs")
+const path = require("node:path")
+
+const packages = fs.readdirSync(path.resolve(__dirname, "packages"))
+
+module.exports = {
+    extends: ["@commitlint/config-conventional"],
+    prompt: {
+        scopes: [...packages],
+        markBreakingChangeMode: true,
+        allowCustomIssuePrefix: false,
+        allowEmptyIssuePrefix: false,
+        issuePrefixes: [
+            {
+                value: "re",
+                name: "re: ISSUES related"
+            }
+        ]
+    }
+}

.editorconfig

@@ -0,0 +1,13 @@
+#root = true
+
+[*]
+indent_style = space
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 120
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false

.github/ISSUE_TEMPLATE/---bug.md

@@ -0,0 +1,34 @@
+---
+name: "\U0001F41E Bug"
+about: Create a report to help us improve
+title: ''
+labels: "bug \U0001F41B"
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Technologies (please complete the following information):**
+
+-   Node.js version
+-   NPM version
+-   Solidity version
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/---feature.md

@@ -0,0 +1,20 @@
+---
+name: "\U0001F680 Feature"
+about: Suggest an idea for ZK-Kit
+title: ''
+labels: 'feature :rocket:'
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/---package.md

@@ -0,0 +1,14 @@
+---
+name: "\U0001F4E6 Package"
+about: Propose a new ZK-Kit Solidity package
+title: ''
+labels: 'feature :rocket:'
+assignees: ''
+
+---
+
+**Describe the package you'd like**
+A clear and concise description of the type of package you have in mind.
+
+**Additional context**
+Add any other context about the package here.

.github/ISSUE_TEMPLATE/---refactoring.md

@@ -0,0 +1,17 @@
+---
+name: "\u267B Refactoring"
+about: Suggest any improvements for this project
+title: ''
+labels: 'refactoring :recycle:'
+assignees: ''
+
+---
+
+**Describe the improvement you're thinking about**
+A clear and concise description of what you think could improve the code.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions you've considered.
+
+**Additional context**
+Add any other context or screenshots about the improvement request here.

.github/pull_request_template.md

@@ -0,0 +1,38 @@
+<!-- Please refer to our CONTRIBUTING documentation for any questions on submitting a pull request. -->
+<!-- Provide a general summary of your changes in the Title above. -->
+
+## Description
+
+<!-- Describe your changes in detail. -->
+<!-- You may want to answer some of the following questions: -->
+<!-- What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) -->
+<!-- What is the current behavior?** (You can also link to an open issue here) -->
+<!-- What is the new behavior (if this is a feature change)? -->
+<!-- Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?) -->
+
+## Related Issue(s)
+
+<!-- This project accepts pull requests related to open issues. -->
+<!-- If suggesting a new feature or change, please discuss it in an issue first. -->
+<!-- If fixing a bug, there should be an issue describing it with steps to reproduce. -->
+<!-- Please link to the issue(s) here -->
+
+<!-- Closes # -->
+<!-- Fixes # -->
+
+## Other information
+
+<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->
+<!-- Feel free to remove this section if you will not use it. -->
+
+## Checklist
+
+<!-- Please check if the PR fulfills these requirements. -->
+
+-   [ ] My code follows the style guidelines of this project
+-   [ ] I have performed a self-review of my code
+-   [ ] I have commented my code, particularly in hard-to-understand areas
+-   [ ] My changes generate no new warnings
+-   [ ] I have run `yarn format` and `yarn compile` without getting any errors
+-   [ ] I have added tests that prove my fix is effective or that my feature works
+-   [ ] New and existing unit tests pass locally with my changes

.github/workflows/main.yml

@@ -0,0 +1,67 @@
+name: main
+
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+    cancel-in-progress: true
+
+jobs:
+    style:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+
+            - name: Setup Node
+              uses: actions/setup-node@v4
+              with:
+                  node-version: "20"
+                  cache: yarn
+
+            - name: Install dependencies
+              run: yarn
+
+            - name: Format code
+              run: yarn format
+    tests:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+
+            - name: Setup Node
+              uses: actions/setup-node@v4
+              with:
+                  node-version: "20"
+                  cache: yarn
+
+            - name: Install dependencies
+              run: yarn
+
+            - name: Get changed files
+              id: changed-files
+              uses: tj-actions/changed-files@v44
+              with:
+                  files: |
+                      packages/**/*.{sol,json,ts}
+
+            - if: steps.changed-files.outputs.any_changed == 'true'
+              name: Compile contracts
+              run: yarn compile
+
+            - if: steps.changed-files.outputs.any_changed == 'true'
+              name: Test contracts
+              run: yarn test
+
+            - if: steps.changed-files.outputs.any_changed == 'true' && github.event_name == 'push' && github.ref == 'refs/heads/main'
+              name: Coveralls
+              uses: coverallsapp/github-action@v2
+              with:
+                  github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,43 @@
+name: release
+
+permissions:
+    contents: write
+
+on:
+    push:
+        tags:
+            - "*"
+
+jobs:
+    release:
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+
+            - name: Install Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 20
+                  cache: yarn
+                  registry-url: "https://registry.npmjs.org"
+
+            - name: Authentication
+              run: |
+                  echo npmAuthToken: "$NODE_AUTH_TOKEN" >> ./.yarnrc.yml
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+            - name: Install dependencies
+              run: yarn
+
+            - name: Publish packages
+              run: yarn version:publish
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+            - run: yarn version:release
+              env:
+                  GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -0,0 +1,82 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# IDE
+.vscode
+.idea
+
+# Cargo
+target
+
+# Testing
+coverage
+coverage.json
+*.lcov
+
+# Dependency directories
+node_modules/
+
+# Parcel cache
+.parcel-cache
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Output of 'npm pack'
+*.tgz
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Yarn Integrity file
+.yarn-integrity
+
+# Generate output
+dist
+build
+
+# Hardhat
+artifacts
+cache
+typechain-types
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# Optional npm cache directory
+.npm
+.DS_Store
+
+# yarn v3
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+.envrc
+.tool-versions

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.husky/prepare-commit-msg

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+if [ "$NO_HOOK" != "1" ]; then
+  exec < /dev/tty && npx czg --hook || true
+fi

.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+    "**/*.{js,ts,md,json,sol,yml,yaml}": "prettier --write"
+}