README
¶
On-Chain Access Control
A proof-of-concept for SSI-oriented, on-chain access control. Smart contract managed roles, based on anonymous credentials that combine verifiable credentials and zero-knowledge proof systems.
Getting Started
Prerequisites
-
Install jq
Ubuntu
sudo apt-get install jqBrew (Mac)
brew install jqChoco (Windows)
choco install jq -y
Installation
-
Build the Bazel targets.
make build -
Install the Node.js dependencies.
pnpm install -
Create your .env file for each service in ./usecase/:
cp .env.example .env -
Spin up the required instances for ./usecase/:
cd ./usecase && docker compose up -d -
Run the usecase services.
make run-accreditation_body make run-verification_body make run-project_operator
Zokrates
Usage via Docker
A sample policy supplier_agreement.zok with verification function is already created.
From root dir, start a docker container for zokrates cli
./dev/zokrates/run_docker.sh
Generate required sample zk artifacts
./app/setup.sh <path_to_code_file> <path_to_out_dir> <witness_args>
For example for the provided component supplier
./app/setup.sh /app/usecase/component_supplier/code/supplier_agreement.zok /app/usecase/component_supplier/gen 2 4
Commit Guidelines
This repo is set up to use AngularJS's commit message convention.
Commit Message Format
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
Type
Must be one of the following:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug nor adds a feature
- perf: A code change that improves performance
- test: Adding missing or correcting existing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
For more information, head over to AngularJS's Commit Guidelines
Directories