Skip to content

Commit 70fcf71

Browse files
authored
Create README.md
1 parent 6ce11a3 commit 70fcf71

1 file changed

Lines changed: 71 additions & 0 deletions

File tree

README.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
<div align="center">
2+
<h1>no_JIT: A Game-Theoretic Defense for Uniswap v4 LPs</h1>
3+
4+
<p>
5+
<strong>基于微分博弈论的 Uniswap v4 流动性保护钩子</strong>
6+
<br/>
7+
<em>Uniswap V4のLPを守る、微分ゲーム理論に基づくフック</em>
8+
</p>
9+
10+
<!-- Shields/Badges -->
11+
<p>
12+
<a href="https://github.com/imbue-bit/no_JIT/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>
13+
<a href="https://soliditylang.org/"><img src="https://img.shields.io/badge/Solidity-^0.8.26-E91E63.svg?style=for-the-badge&logo=solidity" alt="Solidity"></a>
14+
<a href="https://uniswap.org/"><img src="https://img.shields.io/badge/Uniswap-v4-ff007a?style=for-the-badge&logo=uniswap" alt="Uniswap v4"></a>
15+
<a href="https://github.com/imbue-bit/no_JIT/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/imbue-bit/no_JIT/ci.yml?branch=main&style=for-the-badge&logo=githubactions&logoColor=white" alt="CI Status"></a>
16+
</p>
17+
</div>
18+
19+
---
20+
21+
**`no_JIT`** is not just another MEV mitigation tool; it's an academically-grounded defense mechanism that transforms passive Liquidity Providers into strategic, active defenders. By implementing the Nash Equilibrium strategy derived from our **Hamilton-Jacobi-Isaacs (HJI) framework**, this Uniswap v4 Hook makes JIT attacks economically non-viable, ex-ante.
22+
23+
> **Read the full academic paper:** [*Defense in Predatory Markets: A Differential Game Framework...*](https://link-to-your-paper.pdf)
24+
25+
## 🚀 Key Innovations
26+
27+
| Feature | Description |
28+
| --------------------------- | ------------------------------------------------------------------------------------------------------- |
29+
| **🧠 Game-Theoretic Core** | Moves beyond simple heuristics to a provably optimal defense strategy derived from differential games. |
30+
| **⚡️ Atomic Deterrence** | Detects and punishes JIT liquidity within a single block, before the predatory swap executes. |
31+
| **🔒 Oracle-Free Design** | Operates entirely on-chain using pool state variables, eliminating external data dependencies and risks.|
32+
| **⛽️ Gas-Efficient Logic** | Minimal overhead on swaps, ensuring it doesn't compromise the core user experience of the DEX. |
33+
34+
## 📖 Dive Deeper
35+
36+
Ready to explore? We've structured our documentation to guide you from high-level concepts to deep technical implementation.
37+
38+
| Document | Audience | Description |
39+
| ------------------------------------------------- | --------------------------- | --------------------------------------------------- |
40+
| **[📚 A Gentle Introduction](./docs/a_gentle_introduction.md)** | Everyone | Understand JIT attacks and our core idea. |
41+
| **[🛠️ Technical Deep Dive](./docs/technical_deep_dive.md)** | Developers & Researchers | Explore the math, code, and design decisions. |
42+
| **[🌍 Deployment Guide](./docs/deployment_guide.md)** | Protocol Integrators | Learn how to deploy and configure the hook. |
43+
| **[🛡️ Security](./docs/security.md)** | Security Auditors | Review our security considerations and best practices.|
44+
45+
## ⚡ Quick Start
46+
47+
### Prerequisites
48+
- [Foundry](https://book.getfoundry.sh/)
49+
- [Git](https://git-scm.com/)
50+
51+
### Installation & Testing
52+
53+
```bash
54+
# Clone the repository
55+
git clone https://github.com/imbue-bit/no_JIT.git
56+
cd no_JIT
57+
58+
# Install dependencies
59+
forge install
60+
61+
# Run the test suite
62+
forge test
63+
```
64+
65+
## 🤝 Contributing
66+
67+
We welcome contributions from the community! Whether it's a bug report, a feature request, or a pull request, your input is valuable. Please check out our [**Contribution Guidelines**](./CONTRIBUTING.md) to get started.
68+
69+
## 📄 License
70+
71+
This project is licensed under the **Apache 2.0 License**. See the [LICENSE](./LICENSE) file for details.

0 commit comments

Comments
 (0)