https://github.com/cardinal-cryptography/zkos-monorepo
https://github.com/cardinal-cryptography/zkos-monorepo
alephzero snarks zero-knowledge
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cardinal-cryptography/zkos-monorepo
- Owner: Cardinal-Cryptography
- License: apache-2.0
- Created: 2024-11-27T18:42:40.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-04-15T12:34:07.000Z (2 months ago)
- Last Synced: 2025-04-15T12:41:19.433Z (2 months ago)
- Topics: alephzero, snarks, zero-knowledge
- Language: Rust
- Homepage:
- Size: 14.1 MB
- Stars: 12
- Watchers: 5
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[![LOGO][logo]][aleph-homepage]
[![Nightly Testnet E2E tests][nightly-tests-badge]][nightly-tests]
[![Contracts deployment][contracts-deployment-badge]][contracts-deployment]
[![Relayer deployment][relayer-deployment-badge]][relayer-deployment]
# Shielder: A First Iteration of zkOS
Welcome to Shielder, the first iteration of zkOS by Aleph Zero.
Shielder is designed to provide a seamless integration of zero-knowledge (ZK) privacy into Ethereum Virtual Machine (EVM) compatible environments with subsecond proving times.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Architecture](#architecture)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [License](#license)
## Introduction
Shielder is part of the Aleph Zero zkOS initiative, aimed at delivering Privacy-as-a-Service for Web3. With zkOS, developers can integrate ZK-based privacy into their applications without deep cryptographic knowledge.
## Features
- **EVM Compatibility**: Easily integrate with existing Ethereum-based applications.
- **Subsecond Proving**: Achieve zero-knowledge proofs in 600-800 ms on standard hardware.
- **High Performance**: Supports up to 250ms block time and processes thousands of transactions per second.
- **Developer-Friendly**: Comprehensive tooling and frameworks to simplify integration.
- **Privacy-Enhanced**: Build and deploy privacy-enhanced applications effortlessly.
# Architecture
Shielder is built utilizing the following components:
- **EVM Layer 2 Rollup**: Leverages Arbitrum Anytrust DAC technology for fast and secure execution.
- **Developer Tooling**: Includes Gelato’s web3 services, account abstraction, functions, VRF, oracles, block explorers, indexers, and multisig support.
## Getting Started
### Prerequisites
Before you begin, ensure you have the following:
- Node.js and npm installed
- Docker (optional, for containerized deployment)
- An Ethereum wallet
### Usage
Clone the repository and install the dependencies:
```bash
git clone [email protected]:Cardinal-Cryptography/zkOS-monorepo.git
cd zkOS-monorepo
make deps
```
Boot a local node:
```bash
make anvil
```
Generate additional contract sources:
```bash
make generate-contracts
```
Compile & deploy the smart contract suite:
```bash
make deploy-contracts
```
### Running e2e tests
Install dependencies and generate additional contract sources:
```bash
make deps
make generate-contracts
```
Run:
```bash
run tooling-e2e-tests/full_scenario.sh
```
(or another `.sh` file from that directory). For maximum compatibility `export BUILD=docker` - this will be slower but
will build the relayer image inside docker. Otherwise the binary is built on your machine and then copied into the image
which might not work, depending on the exact configuration of the host.
### Deploying to anvil
The command below will use `0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266` as a deployer:
```bash
NETWORK=anvil make deploy-contracts
```
## License
Shielder is licensed under the Apache-2.0 License. See the LICENSE file for more details.
## Private components and future open sourcing plan
While this repository represents the majority of our work, there are still some components that are kept in private repositories.
These include halo2 circuits and Poseidon2 hashing function.
The main reason for keeping these components private at this time is that they are waiting for an external audit to ensure they meet all compliance, security, and quality standards.
This step is essential to ensure that when we open source these parts, they adhere to our community's expectations for transparency, security, and usability.
We are fully committed to open-sourcing these remaining components as soon as the audit is complete. Stay tuned for updates, and feel free to reach out with any questions or feedback in the meantime!
[aleph-homepage]: https://alephzero.org
[logo]: logo.png
[contracts-deployment]: https://github.com/Cardinal-Cryptography/zkOS-monorepo/actions/workflows/manual-deploy-contract.yml
[contracts-deployment-badge]: https://github.com/Cardinal-Cryptography/zkOS-monorepo/actions/workflows/manual-deploy-contract.yml/badge.svg
[relayer-deployment]: https://github.com/Cardinal-Cryptography/zkOS-monorepo/actions/workflows/testnet-stage-build-and-deploy-shielder-relayer.yml
[relayer-deployment-badge]: https://github.com/Cardinal-Cryptography/zkOS-monorepo/actions/workflows/testnet-stage-build-and-deploy-shielder-relayer.yml/badge.svg
[nightly-tests]: https://github.com/Cardinal-Cryptography/zkOS-monorepo/actions/workflows/testnet-nightly-e2e.yml
[nightly-tests-badge]: https://github.com/Cardinal-Cryptography/zkOS-monorepo/actions/workflows/testnet-nightly-e2e.yml/badge.svg