# pycckuu/ecc-rust architecture

> Architecture diagram of the GitHub repository pycckuu/ecc-rust, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/pycckuu/ecc-rust
- Repository: https://github.com/pycckuu/ecc-rust

## Overview

##### Component Relationships

**[Finite Field Operations]**
- ↓
**[Elliptic Curve Operations] ← [Weierstrass Curve]**
- ↓
**[Point Operations] → [Group Operations]**
- ↓
**[Curve-Specific Implementations] → [secp256k1]**
- ↓
**[Cryptographic Protocols]**

##### Detailed Component Breakdown

- Core Mathematical Components (Rectangles):
- FiniteField (ff.rs)
- Point (point.rs)
- (group.rs)

- Curve Implementations (Hexagons):
- WeierstrassCurve (ec/weierstrass.rs)
- Secp256k1 (curves/secp256k1.rs)

- Cryptographic Protocols (Rounded Rectangles):
- ECDSA (ecdsa.rs)
- Chaum-Pedersen ZK Proof (zk/chaum_pedersen.rs)

##### Specific Implementation Details

**[FiniteField]**
- Addition
- Multiplication
- Inversion
**↓**
**[EllipticCurve]**
- Point Addition
- Point Doubling
- Scalar Multiplication
**↓**
**[Cryptographic Protocols]**
- ECDSA Operations
- ZK Proof Operations

##### Additional Elements

Include:
- Version information
- Security warning about non-production status
- Key mathematical relationships (e.g., Weierstrass equation: y² = x³ + ax + b)

##### Implementation Notes

Callouts highlighting:
- Test coverage for each component
- Critical security considerations
- Performance characteristics
- Memory usage patterns

Remember to include bidirectional relationships where appropriate, as many components interact with each other in complex ways (e.g., Point operations depending on both FiniteField and EllipticCurve implementations).

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef core fill:#a8d1f0,stroke:#333
    classDef curve fill:#90EE90,stroke:#333
    classDef crypto fill:#FFB347,stroke:#333
    classDef module fill:#D3D3D3,stroke:#333
    classDef interface fill:#E6E6FA,stroke:#333

    %% Public Interface Layer
    subgraph Interface
        LIB["Library Interface (lib.rs)"]
    end

    %% Core Mathematical Components
    subgraph CoreMath
        FF["Finite Field Operations"]
        POINT["Point Operations"]
        GROUP["Group Operations"]
    end

    %% Elliptic Curve Layer
    subgraph ECLayer
        EC_MOD["EC Base Module"]
        WEIER["Weierstrass Curve"]
    end

    %% Curve Implementations
    subgraph Curves
        CURVES_MOD["Curves Module"]
        SECP["secp256k1"]
    end

    %% Cryptographic Protocols
    subgraph Protocols
        ZK_MOD["Zero-Knowledge Module"]
        ECDSA["ECDSA"]
        CP["Chaum-Pedersen ZK Proof"]
    end

    %% Relationships
    LIB --> FF
    LIB --> POINT
    LIB --> GROUP
    FF --> POINT
    POINT --> GROUP
    GROUP --> WEIER
    WEIER --> SECP
    EC_MOD --> WEIER
    CURVES_MOD --> SECP
    SECP --> ECDSA
    SECP --> CP
    ZK_MOD --> CP

    %% Click Events
    click LIB "https://github.com/pycckuu/ecc-rust/blob/main/src/lib.rs"
    click FF "https://github.com/pycckuu/ecc-rust/blob/main/src/ff.rs"
    click POINT "https://github.com/pycckuu/ecc-rust/blob/main/src/point.rs"
    click GROUP "https://github.com/pycckuu/ecc-rust/blob/main/src/group.rs"
    click WEIER "https://github.com/pycckuu/ecc-rust/blob/main/src/ec/weierstrass.rs"
    click SECP "https://github.com/pycckuu/ecc-rust/blob/main/src/curves/secp256k1.rs"
    click ECDSA "https://github.com/pycckuu/ecc-rust/blob/main/src/ecdsa.rs"
    click CP "https://github.com/pycckuu/ecc-rust/blob/main/src/zk/chaum_pedersen.rs"
    click EC_MOD "https://github.com/pycckuu/ecc-rust/blob/main/src/ec/mod.rs"
    click CURVES_MOD "https://github.com/pycckuu/ecc-rust/blob/main/src/curves/mod.rs"
    click ZK_MOD "https://github.com/pycckuu/ecc-rust/blob/main/src/zk/mod.rs"

    %% Style Applications
    class LIB interface
    class FF,POINT,GROUP core
    class WEIER,SECP curve
    class ECDSA,CP crypto
    class EC_MOD,CURVES_MOD,ZK_MOD module

    %% Legend
    subgraph Legend
        L1["Core Mathematical Components"]:::core
        L2["Curve Implementations"]:::curve
        L3["Cryptographic Protocols"]:::crypto
        L4["Modules"]:::module
        L5["Interface"]:::interface
    end
```
