Skip to content

Commit 1d3e72f

Browse files
authored
Merge pull request #99 from Moshiii/readmeupdate
update readme
2 parents b4ed4e7 + cacd911 commit 1d3e72f

3 files changed

Lines changed: 87 additions & 109 deletions

File tree

README.md

Lines changed: 76 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@
99
<a href="https://pypi.org/project/isek/"><img src="https://img.shields.io/pypi/v/isek" alt="PyPI version" /></a>
1010
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT" /></a>
1111
<a href="mailto:team@isek.xyz"><img src="https://img.shields.io/badge/contact-team@isek.xyz-blue" alt="Email" /></a>
12+
<a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.10%2B-blue.svg" alt="Python Version" /></a>
13+
<a href="https://github.com/openagents-org/openagents/actions/workflows/pytest.yml"><img src="https://github.com/openagents-org/openagents/actions/workflows/pytest.yml/badge.svg?branch=develop" alt="Tests" /></a>
14+
<a href="#-try-it-in-60-seconds"><img src="https://img.shields.io/badge/📖_tutorial-get%20started-green.svg" alt="Tutorial" /></a>
15+
<a href="https://openagents.org"><img src="https://img.shields.io/badge/📚_docs-openagents.org-blue.svg" alt="Documentation" /></a>
16+
<a href="#-try-it-in-60-seconds"><img src="https://img.shields.io/badge/🚀_examples-ready--to--run-orange.svg" alt="Examples" /></a>
17+
<a href="https://discord.gg/PRzG3MSP"><img src="https://img.shields.io/badge/Discord-Join%20Community-5865f2?logo=discord&logoColor=white" alt="Discord" /></a>
18+
<a href="https://x.com/ISEK_Official"><img src="https://img.shields.io/badge/Twitter-Follow%20Updates-1da1f2?logo=x&logoColor=white" alt="Twitter" /></a>
1219
</p>
1320

1421
<h4 align="center">
@@ -17,68 +24,93 @@
1724
</h4>
1825

1926
---
20-
**ISEK** is a decentralized agent network framework for building intelligent, collaborative agent-to-agent (A2A) systems. The Isek network integrates the Google **A2A** protocol and **ERC-8004** contracts to enable identity registration, reputation building, and cooperative task-solving. Together, these elements form a self-organizing, decentralized society of agents.
21-
> 🧪 **ISEK is under active development.** Contributions, feedback, and experiments are highly welcome.
27+
**ISEK** is a decentralized framework designed for building **AI Agent Network**. Instead of treating agents as isolated executors, it provides the missing layer of collaboration and coordination. Developers run their agents locally, and through peer-to-peer connections, these agents join the ISEK network. Once connected, they can discover other agents, form communities, and deliver services directly to users.
2228

23-
---
24-
25-
## What problem ISEK solve?
26-
27-
Our platform allows agent developers to run their agents locally. Through peer-to-peer connections, these agents join the ISEK network and can deliver services directly to users.
28-
While most frameworks treat agents as isolated agent executors, **ISEK** focuses on the missing layer: **decentralized agent collaboration and coordination**. We believe the future of intelligent systems lies in **self-organizing agent networks** capable of context sharing, team formation, and collective reasoning — all without central control.
29-
> ISEK is not just about running agents — it's about empowering them to **find each other, reason together, and act as a decentralized system.**
30-
31-
## Why ERC-8004 matters?
32-
33-
ERC-8004 provides a decentralized framework for identity, reputation, and validation registries, establishing the foundation for trustless verification and reputation management.
34-
---
35-
36-
## 🌟 Features
37-
38-
- **🧠 Decentralized Cooperation
39-
Using the ERC-8004 trustless Agent Contract as our registry, we provide decentralized identity, reputation, and validation services. Agents can discover peers and collaborate directly — with no single point of failure.
29+
At the core of the network, Google’s A2A protocol and ERC-8004 smart contracts enable identity registration, reputation building, and cooperative task-solving. This transforms agents from standalone tools into participants in a shared ecosystem.
30+
We believe in self-organizing agent networks — systems that can share context, form teams, and reason collectively without central control.
4031

41-
- **🌐 Distributed Deployment
42-
Agent owners can run their agents 100% locally, mint an Agent NFT, and use an agent wallet to claim full ownership and control.
32+
Visit our website at [isek.xyz](https://www.isek.xyz/) for more details.
4333

44-
- **🔌 MCP-Based Agent Discovery
45-
Our map server connects to the agent discovery service, making it easy for users to find agents. Configure the MCP service once, and you can access agents directly through your favorite AI chatbot.
34+
## 🌟 Star Us on GitHub and Get Exclusive Reward!
35+
Star ISEK to get notified about upcoming features, workshops and join our growing community for exploring the future of AI collaboration.
4636

47-
- **💻 Developer-Friendly CLI
48-
A streamlined CLI makes agent setup, deployment, and management fast and hassle-free.
37+
<img src="assets/star_gif.gif" alt="hippo" width="250"/>
4938

5039
---
5140

5241
## 🚀 Quick Start
5342

54-
```bash
55-
python3 -m venv isek_env && source isek_env/bin/activate
56-
```
43+
### Prerequisites
44+
- **Python 3.10+**
45+
- **Node.js 18+** (for P2P functionality)
5746

5847
### Installation
5948
```bash
49+
python3 -m venv isek_env && source isek_env/bin/activate
6050
pip install isek
6151
isek setup
6252
```
6353

64-
### Prerequisites
65-
- **Python 3.10+**
66-
- **Node.js 18+** (for P2P functionality)
54+
### Hosting your Agent:
55+
```python
56+
node = Node(host="127.0.0.1", port=9999, node_id="openai-agent")
57+
app = Node.create_server(your_agent_executor, agent_card)
58+
node.build_server(app, name="OpenAI Agent", daemon=False)
59+
```
6760

68-
> 💡 **Tip:** The `isek setup` command automatically handles both Python and JavaScript dependencies.
61+
### Query your Agent:
62+
```python
63+
node = Node(host="127.0.0.1", port=8888, node_id="a2a-client")
64+
message_content = await node.send_message("http://localhost:9999", query)
65+
```
6966

67+
### P2P Relay setup
68+
```bash
69+
isek run-realy
70+
```
71+
Expected output:
72+
Relay peer started. peerId=<your-network-peerId>
73+
Copy you peerID, this is your Agent network ID
7074

71-
### Set Up Environment
7275

73-
Create a `.env` file:
76+
### P2P Hosting your Agent:
77+
```python
78+
p2p = A2AProtocolV2(
79+
host="127.0.0.1",
80+
port=9999,
81+
p2p_enabled=True,
82+
p2p_server_port=9001,
83+
relay_ip=<your-ip>,
84+
relay_peer_id=<your-network-peerId>
85+
)
86+
p2p.start_p2p_server(wait_until_ready=True)
87+
```
7488

75-
```env
76-
OPENAI_MODEL_NAME=gpt-4o-mini
77-
OPENAI_BASE_URL=https://api.openai.com/v1
78-
OPENAI_API_KEY=your_api_key
89+
Expected output:
90+
| [p2p] server | peer_id=<your-agent-peerId>
91+
Copy you peerID, this is your Agent server ID
92+
93+
### P2P Query your Agent:
94+
95+
```python
96+
p2p = A2AProtocolV2(
97+
host="127.0.0.1",
98+
port=8888,
99+
p2p_enabled=True,
100+
p2p_server_port=9002,
101+
relay_ip=<your-ip>,
102+
relay_peer_id=<your-network-peerId>
103+
)
104+
p2p.start_p2p_server(wait_until_ready=True)
105+
106+
resp = p2p.send_message(
107+
sender_node_id="a2a-client",
108+
receiver_peer_id=<your-agent-peerId>,
109+
message=query,
110+
)
79111
```
80112

81-
### Wallet & Identity
113+
### Wallet & Identity (optional)
82114

83115
ISEK now uses a simple local wallet manager and an ERC-8004 identity flow.
84116

@@ -123,66 +155,23 @@ Notes:
123155
- If the agent is already registered, it returns the existing `agent_id` without sending a transaction.
124156

125157

126-
### Launch Agent
127-
128-
```python
129-
from isek.agent.isek_agent import IsekAgent
130-
from isek.models.openai import OpenAIModel
131-
import dotenv
132-
dotenv.load_dotenv()
133-
134-
agent = IsekAgent(
135-
name="My Agent",
136-
model=OpenAIModel(model_id="gpt-4o-mini"),
137-
description="A helpful assistant",
138-
instructions=["Be polite", "Provide accurate information"],
139-
success_criteria="User gets a helpful response"
140-
)
141-
142-
response = agent.run("hello")
143-
```
144-
145158
### Try Examples
146159

147-
In the examples folder, follow the examples from level 1 to level 10, and you should have a good understanding of ISEK
160+
[A2A Agent Server](https://www.isek.xyz/)
161+
[A2A Agent Client](https://www.isek.xyz/)
162+
[P2P Agent Server](https://www.isek.xyz/)
163+
[A2A Agent Client](https://www.isek.xyz/)
148164

149165
---
150166

151167
## 🧪 CLI Commands
152168

153169
```bash
154170
isek setup # Install Python and JavaScript dependencies
171+
isek run_relay # Start the relay
155172
isek clean # Clean temporary files
156173
isek --help # View available commands
157174
```
158-
159-
---
160-
161-
## 🧱 Project Structure
162-
163-
```
164-
isek/
165-
├── examples # Sample scripts demonstrating Isek usage
166-
├── isek # Core functionality and modules
167-
│ ├── agent # Agent logic and behavior
168-
│ ├── node # Node orchestration
169-
│ ├── protocol # Inter-Agent communication Protocol Layer
170-
│ ├── memory # Agent state and context
171-
│ ├── models # LLM backends and interfaces
172-
│ ├── team # Multi-Agent Organization Interface
173-
│ ├── tools # The toolkit library for Agents
174-
│ ├── utils # Utility functions
175-
│ ├── cli.py # CLI entry point
176-
│ └── isek_center.py # Local registry and coordinator
177-
├── docs/ # Documentation
178-
└── README.md # Project overview and documentation
179-
```
180-
---
181-
182-
## 🌟 Star Us 😉
183-
184-
<img src="assets/star_gif.gif" alt="hippo" width="250"/>
185-
186175
---
187176

188177
## 🤝 Contributing
@@ -195,18 +184,6 @@ We welcome collaborators, researchers, and early adopters!
195184

196185
---
197186

198-
## 📜 License
199-
200-
Licensed under the [MIT License](LICENSE).
201-
202-
---
203-
## ⚠️ Legal Notice
204-
205-
ISEK is an open-source, permissionless framework for building decentralized agent coordination systems.
206-
The contributors do not operate, control, or monitor any deployed agents or their behavior.
207-
By using this project, you accept full responsibility for your actions. See [LEGAL.md](./LEGAL.md) for more details.
208-
209-
---
210187
<p align="center">
211188
Made with ❤️ by the <strong>Isek Team</strong><br />
212189
<em>Autonomy is not isolation. It's cooperation, at scale.</em>

examples/Agent_servers/Pydantic/openai_agent_a2a_p2p.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def main():
5858
p2p_enabled=True,
5959
p2p_server_port=9001,
6060
relay_ip="155.138.145.190",
61-
relay_peer_id="12D3KooWShd5s1ziziZNkiqN56XVpWH3chZHeq7EeSzHKMzR12vf"
61+
relay_peer_id="12D3KooWAom1Up6ZmpWgCSZGU5miehN5j2fczRNaiPUU4ZqmSCJq"
6262
)
6363
# Run blocking wait so we can print the peer address before starting the agent server
6464
p2p.start_p2p_server(wait_until_ready=True)

isek/cli.py

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,6 @@ def clean():
6060
click.secho("✓ Cleanup completed", fg="green")
6161

6262

63-
@cli.command()
64-
def registry():
65-
"""Start local development registry"""
66-
from isek.isek_center import main
67-
68-
main()
69-
70-
7163
@cli.command()
7264
def setup():
7365
"""Install ISEK Python and JavaScript dependencies"""
@@ -144,7 +136,16 @@ def is_development_environment():
144136
click.secho(" P2P functionality may not work correctly", fg="yellow")
145137

146138
click.secho("🎉 ISEK setup completed successfully!", fg="green")
147-
click.secho(" You can now run examples with 'isek example run <name>'", fg="blue")
139+
click.secho(" You can now run relay with 'isek run_relay'", fg="blue")
140+
141+
142+
@cli.command()
143+
def run_relay():
144+
"""Run relay"""
145+
subprocess.run(
146+
["node", "isek/protocol/p2p/relay.js"], check=True, capture_output=True
147+
)
148+
click.secho("✓ Relay started", fg="green")
148149

149150

150151
@cli.group()

0 commit comments

Comments
 (0)