{"id":24054625,"url":"https://github.com/cardinal-cryptography/zkos-monorepo","last_synced_at":"2025-04-22T20:45:49.438Z","repository":{"id":268397471,"uuid":"895202138","full_name":"Cardinal-Cryptography/zkOS-monorepo","owner":"Cardinal-Cryptography","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-15T12:34:07.000Z","size":14813,"stargazers_count":12,"open_issues_count":2,"forks_count":4,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-15T12:41:19.433Z","etag":null,"topics":["alephzero","snarks","zero-knowledge"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cardinal-Cryptography.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-11-27T18:42:40.000Z","updated_at":"2025-04-15T11:41:06.000Z","dependencies_parsed_at":"2024-12-16T14:38:43.062Z","dependency_job_id":"6be86453-e5e3-4d4b-a599-8f1c0eb77323","html_url":"https://github.com/Cardinal-Cryptography/zkOS-monorepo","commit_stats":null,"previous_names":["cardinal-cryptography/zkos-monorepo"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cardinal-Cryptography%2FzkOS-monorepo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cardinal-Cryptography%2FzkOS-monorepo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cardinal-Cryptography%2FzkOS-monorepo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cardinal-Cryptography%2FzkOS-monorepo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cardinal-Cryptography","download_url":"https://codeload.github.com/Cardinal-Cryptography/zkOS-monorepo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250322043,"owners_count":21411693,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alephzero","snarks","zero-knowledge"],"created_at":"2025-01-09T03:49:04.282Z","updated_at":"2025-04-22T20:45:49.419Z","avatar_url":"https://github.com/Cardinal-Cryptography.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![LOGO][logo]][aleph-homepage]\n\n[![Nightly Testnet E2E tests][nightly-tests-badge]][nightly-tests]\n[![Contracts deployment][contracts-deployment-badge]][contracts-deployment]\n[![Relayer deployment][relayer-deployment-badge]][relayer-deployment]\n\n# Shielder: A First Iteration of zkOS\n\nWelcome to Shielder, the first iteration of zkOS by Aleph Zero.\nShielder is designed to provide a seamless integration of zero-knowledge (ZK) privacy into Ethereum Virtual Machine (EVM) compatible environments with subsecond proving times.\n\n## Table of Contents\n\n- [Introduction](#introduction)\n- [Features](#features)\n- [Architecture](#architecture)\n- [Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Usage](#usage)\n- [License](#license)\n\n## Introduction\n\nShielder 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.\n\n## Features\n\n- **EVM Compatibility**: Easily integrate with existing Ethereum-based applications.\n- **Subsecond Proving**: Achieve zero-knowledge proofs in 600-800 ms on standard hardware.\n- **High Performance**: Supports up to 250ms block time and processes thousands of transactions per second.\n- **Developer-Friendly**: Comprehensive tooling and frameworks to simplify integration.\n- **Privacy-Enhanced**: Build and deploy privacy-enhanced applications effortlessly.\n\n# Architecture\n\nShielder is built utilizing the following components:\n\n- **EVM Layer 2 Rollup**: Leverages Arbitrum Anytrust DAC technology for fast and secure execution.\n- **Developer Tooling**: Includes Gelato’s web3 services, account abstraction, functions, VRF, oracles, block explorers, indexers, and multisig support.\n\n## Getting Started\n\n### Prerequisites\n\nBefore you begin, ensure you have the following:\n\n- Node.js and npm installed\n- Docker (optional, for containerized deployment)\n- An Ethereum wallet\n\n### Usage\n\nClone the repository and install the dependencies:\n\n```bash\ngit clone git@github.com:Cardinal-Cryptography/zkOS-monorepo.git\ncd zkOS-monorepo\nmake deps\n```\n\nBoot a local node:\n\n```bash\nmake anvil\n```\n\nGenerate additional contract sources:\n\n```bash\nmake generate-contracts\n```\n\nCompile \u0026 deploy the smart contract suite:\n\n```bash\nmake deploy-contracts\n```\n\n### Running e2e tests\n\nInstall dependencies and generate additional contract sources:\n\n```bash\nmake deps\nmake generate-contracts\n```\n\nRun:\n\n```bash\nrun tooling-e2e-tests/full_scenario.sh\n```\n\n(or another `.sh` file from that directory). For maximum compatibility `export BUILD=docker` - this will be slower but\nwill build the relayer image inside docker. Otherwise the binary is built on your machine and then copied into the image\nwhich might not work, depending on the exact configuration of the host.\n\n### Deploying to anvil\n\nThe command below will use `0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266` as a deployer:\n\n```bash\nNETWORK=anvil make deploy-contracts\n```\n\n## License\n\nShielder is licensed under the Apache-2.0 License. See the LICENSE file for more details.\n\n## Private components and future open sourcing plan\nWhile this repository represents the majority of our work, there are still some components that are kept in private repositories.\nThese include halo2 circuits and Poseidon2 hashing function.\n\nThe 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.\nThis step is essential to ensure that when we open source these parts, they adhere to our community's expectations for transparency, security, and usability.\n\nWe 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!\n\n[aleph-homepage]: https://alephzero.org\n[logo]: logo.png\n[contracts-deployment]: https://github.com/Cardinal-Cryptography/zkOS-monorepo/actions/workflows/manual-deploy-contract.yml\n[contracts-deployment-badge]: https://github.com/Cardinal-Cryptography/zkOS-monorepo/actions/workflows/manual-deploy-contract.yml/badge.svg\n[relayer-deployment]: https://github.com/Cardinal-Cryptography/zkOS-monorepo/actions/workflows/testnet-stage-build-and-deploy-shielder-relayer.yml\n[relayer-deployment-badge]: https://github.com/Cardinal-Cryptography/zkOS-monorepo/actions/workflows/testnet-stage-build-and-deploy-shielder-relayer.yml/badge.svg\n[nightly-tests]: https://github.com/Cardinal-Cryptography/zkOS-monorepo/actions/workflows/testnet-nightly-e2e.yml\n[nightly-tests-badge]: https://github.com/Cardinal-Cryptography/zkOS-monorepo/actions/workflows/testnet-nightly-e2e.yml/badge.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcardinal-cryptography%2Fzkos-monorepo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcardinal-cryptography%2Fzkos-monorepo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcardinal-cryptography%2Fzkos-monorepo/lists"}