# opendotfund/openfund architecture

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

- Interactive diagram: https://gitdiagram.com/opendotfund/openfund
- Repository: https://github.com/opendotfund/openfund

## Overview

##### Project Type and Purpose
- This is a set of on-chain smart contracts (programs) for a Solana-based decentralized exchange (DEX) built in Rust using the Anchor framework.
- The repository contains five modular Anchor programs: the core AMM DEX, fee management, oracle integration, settlement, and token management contracts.

##### File Structure
- Top-level files (no nested directories) correspond one-to-one with Anchor programs:
- solana-dex-core.rs → Core AMM DEX (openfund_dex)
- fee-program.rs → Fee Management (openfund_fee_management)
- oracle-integration.rs → Oracle Integration (openfund_oracle)
- settlement-contract.rs → Settlement (openfund_settlement)
- token-management.rs → Token Management (openfund_token_management)
- There is also a LICENSE and README.md. No frontend or off-chain code is in this repo.

##### README for Additional Insights
- Confirms modular breakdown and lists dependencies on native Solana programs:
SPL Token Program, Token-2022 Program, Associated Token Account Program.
- Mentions integration points with Pyth and Switchboard oracles.
- Off-chain tools: Solana CLI, Anchor CLI, Node.js (for tests), wallets.

##### Main Components
a. On-Chain Programs (Smart Contracts)
- Core AMM DEX
- Fee Management
- Oracle Integration
- Settlement System
- Token Management
b. External On-Chain Programs (Native Solana)
- SPL Token Program
- Token-2022 Program
- Associated Token Account Program
c. Oracles / Price Feeds
- Pyth Network
- Switchboard
d. Off-Chain Tools & Users
- Users’ Wallets (e.g., Phantom)
- Anchor CLI (build/deploy)
- Solana CLI (network config, keygen)
- (Optional) Test Runner / Node.js scripts

##### Relationships & Data Flows
- User → Wallet → Anchor-backed client calls → on-chain DEX instructions
- Core AMM DEX program calls Token Management program to mint or check token metadata.
- During swaps, Core AMM DEX invokes Fee Management to calculate and collect fees.
- Core AMM queries Oracle Integration program to fetch price data from Pyth / Switchboard.
- Settlement program manages escrow accounts for orders, interacts with Core AMM and Token programs.
- All token transfers, minting, and account setups route through the SPL/Token-2022 native programs.
- Off-chain deployments and tests use Anchor CLI and Solana CLI to push these programs to Devnet.

##### Architectural Patterns & Principles
- Modular Micro-Program Architecture: each concern (AMM logic, fees, oracles, settlement, tokens) lives in its own Anchor program.
- Clear separation of concerns – single responsibility per program.
- On-chain composability: programs invoke/authorize each other via Cross-Program Invocations (CPIs).
- Reliance on Solana’s high‐throughput parallel execution and account model.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Off-Chain Layer
    subgraph "Off-Chain Infrastructure"
        direction TB
        UserWallet["User Wallet (e.g., Phantom)"]:::offchain
        AnchorCLI["Anchor CLI"]:::offchain
        SolanaCLI["Solana CLI"]:::offchain
        TestRunner["Test Runner (Node.js)"]:::offchain
    end

    %% On-Chain Layer
    subgraph "On-Chain Smart Contracts"
        direction TB
        subgraph "OpenFund Smart Contracts"
            direction TB
            openfund_dex["Core AMM DEX"]:::onchain
            openfund_fee_management["Fee Management"]:::onchain
            openfund_oracle["Oracle Integration"]:::onchain
            openfund_settlement["Settlement System"]:::onchain
            openfund_token_management["Token Management"]:::onchain
        end
        subgraph "Native Solana Programs"
            direction TB
            SPLToken["SPL Token Program"]:::external
            Token2022["Token-2022 Program"]:::external
            ATAP["Associated Token Account Program"]:::external
        end
        subgraph "Oracles / Price Feeds"
            direction TB
            Pyth["Pyth Network"]:::external
            Switchboard["Switchboard"]:::external
        end
    end

    %% Off-Chain to On-Chain Interactions
    UserWallet -->|"send tx via client"| openfund_dex
    AnchorCLI -->|"deploy programs"| openfund_dex
    AnchorCLI --> openfund_fee_management
    AnchorCLI --> openfund_oracle
    AnchorCLI --> openfund_settlement
    AnchorCLI --> openfund_token_management
    SolanaCLI --> AnchorCLI
    TestRunner -->|"run Anchor tests"| openfund_dex

    %% On-Chain Interactions (CPIs)
    openfund_dex -->|"fee calculation CPI"| openfund_fee_management
    openfund_dex -->|"price feed CPI"| openfund_oracle
    openfund_dex -->|"token CPI"| openfund_token_management
    openfund_settlement -->|"escrow CPI"| openfund_token_management

    %% Token Program Integrations
    openfund_token_management -->|"mint/token transfer"| SPLToken
    openfund_token_management -->|"mint/token transfer"| Token2022
    openfund_token_management -->|"account setup"| ATAP

    %% Direct token transfers by AMM
    openfund_dex -->|"token transfer"| SPLToken

    %% Oracles to Integration
    Pyth -->|"price feed data"| openfund_oracle
    Switchboard -->|"price feed data"| openfund_oracle

    %% Click Events
    click openfund_dex "https://github.com/opendotfund/openfund/blob/main/solana-dex-core.rs"
    click openfund_fee_management "https://github.com/opendotfund/openfund/blob/main/fee-program (2).rs"
    click openfund_oracle "https://github.com/opendotfund/openfund/blob/main/oracle-integration.rs"
    click openfund_settlement "https://github.com/opendotfund/openfund/blob/main/settlement-contract.rs"
    click openfund_token_management "https://github.com/opendotfund/openfund/blob/main/token-management.rs"

    %% Styles
    classDef onchain fill:#cce5ff,stroke:#004085,color:#004085;
    classDef external fill:#e2e3e5,stroke:#6c757d,color:#6c757d;
    classDef offchain fill:#d4edda,stroke:#155724,color:#155724;
```
