mirror of
https://github.com/0xbow-io/privacy-pools-core.git
synced 2026-01-09 17:37:58 -05:00
36 lines
1.2 KiB
Markdown
36 lines
1.2 KiB
Markdown
# Privacy Pool Protocol
|
|
|
|
Privacy Pool is a blockchain protocol that enables private asset transfers. Users can deposit funds publicly and partially withdraw them privately, provided they can prove membership in an approved set of addresses.
|
|
|
|
## Overview
|
|
|
|
The protocol implements a system of smart contracts and zero-knowledge proofs to enable privacy-preserving transfers while maintaining compliance through approved address sets. It supports both native assets and ERC20 token transfers.
|
|
|
|
## Repository Structure
|
|
|
|
This is a Yarn workspaces monorepo containing four packages:
|
|
|
|
```
|
|
├── packages/
|
|
│ ├── circuits/ # Zero-knowledge circuits
|
|
│ └── contracts/ # Smart contract implementations
|
|
│ └── relayer/ # Minimal relayer implementation
|
|
│ └── sdk/ # Typescript toolkit
|
|
```
|
|
|
|
See the README in each package for detailed information about their specific implementations:
|
|
|
|
- [Circuits Package](./packages/circuits/README.md)
|
|
- [Contracts Package](./packages/contracts/README.md)
|
|
- [Relayer Package](./packages/relayer/README.md)
|
|
- [SDK Package](./packages/sdk/README.md)
|
|
|
|
## Development
|
|
|
|
To set up the development environment:
|
|
|
|
```bash
|
|
# Install dependencies
|
|
yarn
|
|
```
|