fixed text typos, fixed styling

This commit is contained in:
Artem
2025-02-28 14:39:20 +07:00
parent 5ea1379af9
commit b5cd5826cc
12 changed files with 24 additions and 20 deletions

View File

@@ -40,7 +40,7 @@ yarn install
### Contracts
The contracts package contains the Solidity smart contracts for the Privacy Pool protocol.
The contracts package contains the Solidity smart contracts for the Privacy Pools protocol.
```bash
cd packages/contracts

View File

@@ -51,6 +51,6 @@ The Association Set Provider is a crucial compliance layer that controls which d
- Labels can be removed from ASP set
- Removal triggers withdrawal restrictions
- Original depositors can ragequit
- Ensures compliant exit path
- Enabled complaint exit path
The ASP system enables Privacy Pool to maintain compliance requirements while preserving the core privacy features of the protocol through cryptographic proofs and controlled label management.
The ASP system enables Privacy Pools to maintain compliance requirements while preserving the core privacy features of the protocol through cryptographic proofs and controlled label management.

View File

@@ -4,7 +4,7 @@ title: Smart Contracts Layer
### Contract architecture overview
The Privacy Pool protocol is built on three core contracts:
The Privacy Pools protocol is built on three core contracts:
1. **Entrypoint**
- Central access point for deposits
@@ -37,7 +37,7 @@ The Privacy Pool protocol is built on three core contracts:
### State management basics
Each Privacy Pool maintains:
Each Privacy Pools maintains:
1. **Tree State**
- Lean Incremental Merkle Tree (LeanIMT) for commitments

View File

@@ -2,7 +2,7 @@
title: Entrypoint
---
The Entrypoint contract acts as the central coordinator for the Privacy Pool protocol, managing:
The Entrypoint contract acts as the central coordinator for the Privacy Pools protocol, managing:
1. Asset-specific privacy pools
2. Deposits and withdrawal relays
@@ -49,7 +49,7 @@ The deposit process:
1. Validates minimum deposit amount
2. Calculates and deducts protocol fees
3. Forwards remaining funds to appropriate privacy pool
3. Forwards remaining funds to appropriate privacy pools
4. Returns commitment hash for future withdrawals
### 2. Withdrawal Relay

View File

@@ -2,7 +2,7 @@
title: Privacy Pools
---
The PrivacyPool contract is an abstract contract that implements core privacy pool functionality for both native ETH and ERC20 tokens. It:
The PrivacyPool contract is an abstract contract that implements core privacy pools functionality for both native ETH and ERC20 tokens. It:
1. Manages commitments and nullifiers
2. Processes deposits and withdrawals

View File

@@ -2,7 +2,7 @@
title: Circuit Architecture Overview
---
The Privacy Pool protocol uses three main Circom circuits:
The Privacy Pools protocol uses three main Circom circuits:
1. **CommitmentHasher Circuit**
- Computes commitment hashes from inputs
@@ -21,7 +21,7 @@ The Privacy Pool protocol uses three main Circom circuits:
## Commitments
Commitments are cryptographic primitives that allow users to commit to values while keeping them private. In Privacy Pool:
Commitments are cryptographic primitives that allow users to commit to values while keeping them private. In Privacy Pools:
1. **Components**
- Value: The amount of assets being committed
@@ -38,7 +38,7 @@ Commitments are cryptographic primitives that allow users to commit to values wh
### Basic Proof Concepts
Privacy Pool uses Groth16 proofs with the following structure:
Privacy Pools uses Groth16 proofs with the following structure:
1. **Public Inputs**
- Values visible on-chain

View File

@@ -2,9 +2,9 @@
title: Core Concepts
---
### Zero-knowledge proofs in Privacy Pool
### Zero-knowledge proofs in Privacy Pools
Privacy Pool uses zero-knowledge proofs to demonstrate valid statements about private information without revealing that information. The protocol employs three proof types:
Privacy Pools uses zero-knowledge proofs to demonstrate valid statements about private information without revealing that information. The protocol employs three proof types:
- **Commitment Proofs**: Verify the ownership of a commitment
- **Withdrawal Proofs**: Verify ownership and inclusion in state of a commitment

View File

@@ -5,15 +5,15 @@ slug: /
### The challenge of private transactions
On public blockchains like Ethereum, every transaction is visible to everyone. While this transparency is a core feature, it creates significant privacy challenges and risks for users . When withdrawing funds from a deposit, the link between deposit and withdrawal addresses reveals sensitive information about user behavior and relationships.
On public blockchains like Ethereum, every transaction is visible to everyone. When all transactions are visible, every transaction reveals the full balances and transaction history of both parties. When withdrawing funds from a deposit, the link between deposit and withdrawal addresses reveals sensitive information about user behavior and relationships.
### Privacy Pools offers a solution
Privacy Pool enables private withdrawals through a combination of zero-knowledge proofs and commitment schemes. Users can deposit assets into Privacy Pools and later withdraw them, either partially or fully, without creating an on-chain link between their deposit and withdrawal addresses. The protocol uses an Association Set Provider (ASP) to maintain a set of approved deposits, ensuring regulatory compliance while preserving privacy.
Privacy Pools enables private withdrawals through a combination of zero-knowledge proofs and commitment schemes. Users can deposit assets into Privacy Pools and later withdraw them, either partially or fully, without creating an on-chain link between their deposit and withdrawal addresses. The protocol uses an Association Set Provider (ASP) to maintain a set of approved deposits, preventing potentially illicit funds from entering the system and enabling regulatory compliance.
### System architecture overview
Privacy Pool's architecture consists of three distinct layers:
Privacy Pools's architecture consists of three distinct layers:
1. **Contract Layer**
- An upgradeable Entrypoint contract that coordinates ASP-operated pools

View File

@@ -2,7 +2,7 @@
title: Deposit
---
The deposit operation is the entry point into the Privacy Pool protocol. It allows users to publicly deposit assets (ETH or ERC20 tokens) into a pool, creating a private commitment that can later be used for private withdrawals or public ragequit operations.
The deposit operation is the entry point into the Privacy Pools protocol. It allows users to publicly deposit assets (ETH or ERC20 tokens) into a pool, creating a private commitment that can later be used for private withdrawals or public ragequit operations.
## Protocol Flow

View File

@@ -2,7 +2,7 @@
title: Withdrawal
---
Privacy Pool supports two types of withdrawals:
Privacy Pools supports two types of withdrawals:
1. **Direct Withdrawals**: User directly interacts with pool contract
2. **Relayed Withdrawals**: Withdrawal processed through a relayer for additional privacy

View File

@@ -4,7 +4,7 @@ title: Contracts Interfaces
**`IPrivacyPool`**
Core interface for privacy pool smart contracts that handle deposits and withdrawals.
Core interface for privacy pools smart contracts that handle deposits and withdrawals.
```solidity
interface IPrivacyPool {

View File

@@ -81,7 +81,7 @@
}
html {
font-size: 62.5%;
font-size: 80%;
}
/* Improved code block styling */
@@ -206,4 +206,8 @@ code:not([class^="language-"]) {
.footer {
background: #1a1a1a;
}
.theme-doc-breadcrumbs .breadcrumbsContainer_Z_bl {
--ifm-breadcrumb-size-multiplier: 1.2;
}