diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..20eaadf --- /dev/null +++ b/.editorconfig @@ -0,0 +1,10 @@ +```ini +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +indent_style = space +indent_size = 2 +trim_trailing_whitespace = true diff --git a/.gitignore b/.gitignore index 4192ea4..ea6d7cb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,21 @@ -node_modules -dist -.env +# dependencies +node_modules/ -# macOS system file -.DS_Store +# builds +dist/ +build/ +coverage/ + +# env files +.env +.env.local # logs -*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# editors / OS junk +.DS_Store +.vscode/ +.idea/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9f51c52 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +🀝 Contributing to Eremos + +Thanks for considering a contribution to Eremos! + +## πŸš€ Quick Guide +1. **Fork** the repo on GitHub +2. **Clone** your fork: + ```bash + git clone https://github.com/YOUR-USERNAME/Eremos.git + cd Eremos +3. **Create a branch** for your change: + ```bash + git checkout -b feat/your-change +4. **Make your edits** +5. **Commit & Push** +6. **Open a Pull Request** targeting EremosCore/Eremos:main +--- +## πŸ›  Local Setup + + npm install + cp .env.example .env.local + npm run dev + +--- +## βœ… PR Checklist +- Clear PR title & description +- Small, focused changes +- Screenshots/diagram if relevant +- No unrelated files in the commit + +We’re excited to see your contributions πŸ’‘ diff --git a/README.md b/README.md index 2cd120f..d67b8e7 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,44 @@ -# Eremos - + # 🐝 Eremos ![Eremos](docs/banner2.png) -**Autonomous swarm agents for early on-chain signal detection** - -Eremos is a lightweight framework for deploying modular agents that monitor blockchain activity - tracking wallet clusters, mint patterns, and contract anomalies. -Designed for devs who want low-noise, early signals embedded into their workflows. +![License](https://img.shields.io/badge/license-MIT-blue.svg) +![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg) +![Stars](https://img.shields.io/github/stars/EremosCore/Eremos?style=social) +[![Twitter Follow](https://img.shields.io/twitter/follow/EremosCore?style=social)](https://twitter.com/EremosCore) + +> A modular framework for deploying autonomous **swarm agents** that monitor on-chain activity across the Solana ecosystem. +> Built as a **public good**, open-source and extendable. + +## πŸ“‘ Table of Contents +1. [Quick Start](#quick-start) +2. [Features](#features) +3. [Architecture](#Architecture) +4. [Example Signal](#Example-Signal) +5. [Meet Theron Agent 000](#Meet-Theron-Agent-000) +6. [Signal Confidence](#Signal-Confidence) +7. [Tech Stack](#Tech-Stack) +8. [Key Folders](#Key-Folders) +9. [Contributing](#Contributing) +10. [License](#License) +11. [Links](#links) --- -

- Agent Theron
- Theron - Agent (000) -

+## Quick Start +```ts +Clone your fork +git clone https://github.com/YOUR-USERNAME/Eremos.git +cd Eremos -**Meet Theron - Agent-000** -*The first deployed agent in the swarm. Passive. Pattern-sensitive. -Modular and extendable by design.* +Install dependencies +npm install +Copy env file +cp .env.example .env.local -**Agent-001 Coming Soon** [Teaser #1](https://x.com/EremosCore/status/1949154939923833239), [Teaser #2](https://x.com/EremosCore/status/1954856345284567218) +Start dev mode +npm run dev +``` --- @@ -34,7 +53,14 @@ Modular and extendable by design.* - **Ghost Watcher** - Monitors long-dormant wallets that suddenly become active again. Useful for tracing old dev wallets or rug setups. - *+ More to come.* +--- +## Architecture +![Eremos](docs/arch-diagram.png) +**Eremos swarm agents follow a simple lifecycle:** +- **Observe** β€” watch Solana programs, wallets, and flows +- **Detect** β€” flag bundling behavior, deploys, funding anomalies +- **Signal** β€” emit structured alerts and insights --- ## Example Signal @@ -59,6 +85,20 @@ An example signal emitted by an agent detecting a live token deployment: } ``` +--- +## Meet Theron Agent 000 + +

+ Agent Theron
+ Theron - Agent (000) +

+ +*The first deployed agent in the swarm. Passive. Pattern-sensitive. +Modular and extendable by design.* + + +**Agent-001 Coming Soon** [Teaser](https://x.com/EremosCore/status/1949154939923833239) + --- ## Signal Confidence @@ -82,23 +122,6 @@ Confidence is computed via agent-side scoring and logged alongside the signal. --- -## Getting Started - -```bash -git clone https://github.com/EremosCore/Eremos.git -cd Eremos -npm install -``` - -Set up your environment: - -```bash -cp .env.example .env.local -npm run dev -``` - ---- - ## Key Folders - `/agents` - Agent templates + logic @@ -111,9 +134,8 @@ npm run dev ## Contributing -We’re open to contributors. -If you are experienced in TypeScript and like agent-based systems, check `example.ts` and build your own observer. -If you're a designer, artist, or just have ideas that fit the mythos - send us a DM on Twitter. [@EremosCore](https://x.com/EremosCore) +We welcome small, thoughtful contributions! +See **CONTRIBUTING.md** for full guidelines. --- @@ -130,3 +152,4 @@ MIT Β© Eremos LLC - **Whitepaper:** [v1.0 PDF](docs/whitepaper.pdf) _Maintained by the Eremos Core team πŸ’›._ + diff --git a/docs/arch-diagram.png b/docs/arch-diagram.png new file mode 100644 index 0000000..a2d807e Binary files /dev/null and b/docs/arch-diagram.png differ