# maxikaros/foundry-ethernaut architecture

> Architecture diagram of the GitHub repository maxikaros/foundry-ethernaut, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/maxikaros/foundry-ethernaut
- Repository: https://github.com/maxikaros/foundry-ethernaut

## Overview

This repository is a Foundry-based Ethernaut learning game: users work through vulnerable Solidity level contracts by writing and running exploit tests. The documented workflow registers a level, creates an instance, runs setup and exploit callbacks, then checks success. The tree shows separate level and factory contracts, while the README describes the test harness workflow. Source excerpts were not provided, so edges rely on those documented relationships; the level catalog is represented as a subsystem rather than enumerated challenge by challenge.

Main entry points: [`test/utils/BaseTest.sol`](https://github.com/maxikaros/foundry-ethernaut/blob/main/test/utils/BaseTest.sol) (Test Harness), [`test`](https://github.com/maxikaros/foundry-ethernaut/tree/main/test) (Solution Callbacks), [`src/levels`](https://github.com/maxikaros/foundry-ethernaut/tree/main/src/levels) (Vulnerable Levels), [`src/Ethernaut.sol`](https://github.com/maxikaros/foundry-ethernaut/blob/main/src/Ethernaut.sol) (Ethernaut)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_framework["Game Framework"]
  node_ethernaut["Ethernaut<br/>[Ethernaut.sol]"]
  node_base["Level Base"]
end

subgraph group_challenges["Challenge Catalog"]
  node_factories["Level Factories"]
  node_levels["Vulnerable Levels"]
end

subgraph group_solutions["Exploit Tests"]
  node_harness["Test Harness<br/>[BaseTest.sol]"]
  node_callbacks["Solution Callbacks"]
end

node_player(("Learner"))

node_player -->|"runs tests"| node_harness
node_harness -->|"sets up"| node_ethernaut
node_harness -->|"registers level"| node_factories
node_harness -->|"runs callbacks"| node_callbacks
node_callbacks -->|"creates instance"| node_factories
node_callbacks -->|"sets up and exploits"| node_levels
node_harness -->|"checks success"| node_callbacks
node_levels -.->|"inherits level behavior"| node_base

click node_ethernaut "https://github.com/maxikaros/foundry-ethernaut/blob/main/src/Ethernaut.sol"
click node_base "https://github.com/maxikaros/foundry-ethernaut/tree/main/src/levels/base"
click node_factories "https://github.com/maxikaros/foundry-ethernaut/tree/main/src/levels"
click node_levels "https://github.com/maxikaros/foundry-ethernaut/tree/main/src/levels"
click node_harness "https://github.com/maxikaros/foundry-ethernaut/blob/main/test/utils/BaseTest.sol"
click node_callbacks "https://github.com/maxikaros/foundry-ethernaut/tree/main/test"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_ethernaut,node_base toneBlue
class node_factories,node_levels toneAmber
class node_harness,node_callbacks toneMint
class node_player toneIndigo
```

## Components

### Game Framework

- [Ethernaut](https://github.com/maxikaros/foundry-ethernaut/blob/main/src/Ethernaut.sol): `src/Ethernaut.sol`
- [Level Base](https://github.com/maxikaros/foundry-ethernaut/tree/main/src/levels/base): `src/levels/base`

### Challenge Catalog

- [Level Factories](https://github.com/maxikaros/foundry-ethernaut/tree/main/src/levels): `src/levels`
- [Vulnerable Levels](https://github.com/maxikaros/foundry-ethernaut/tree/main/src/levels): `src/levels`

### Exploit Tests

- [Test Harness](https://github.com/maxikaros/foundry-ethernaut/blob/main/test/utils/BaseTest.sol): `test/utils/BaseTest.sol`
- [Solution Callbacks](https://github.com/maxikaros/foundry-ethernaut/tree/main/test): `test`

### Other components

- **Learner**

## Connections

- Learner → Test Harness: runs tests (evidence: `README.md`)
- Test Harness → Ethernaut: sets up (evidence: `README.md`)
- Test Harness → Level Factories: registers level (evidence: `README.md`)
- Test Harness → Solution Callbacks: runs callbacks (evidence: `README.md`)
- Solution Callbacks → Level Factories: creates instance (evidence: `README.md`)
- Solution Callbacks → Vulnerable Levels: sets up and exploits (evidence: `README.md`)
- Test Harness → Solution Callbacks: checks success (evidence: `README.md`)
- Vulnerable Levels → Level Base: inherits level behavior