Skip to content

Commit 81cac68

Browse files
mikirovmikirov
committed
Create ElizaPolkadotPlugin.md
1 parent 07c25db commit 81cac68

File tree

2 files changed

+427
-0
lines changed

2 files changed

+427
-0
lines changed

‎applications/ElizaPolkadotPlugin.md

+191
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
# Polkadot ElizaOS Plugin
2+
3+
- **Team Name:** Esscrypt Ltd.
4+
- **Payment Details:**
5+
- **DOT**: 15JRT5GjLAZkuvmpwmjCUp1RRLr7Y6Gnusz37ia37h2Xn5Rz
6+
- **Payment**: 15JRT5GjLAZkuvmpwmjCUp1RRLr7Y6Gnusz37ia37h2Xn5Rz (USDC)
7+
- **[Level](https://grants.web3.foundation/docs/Introduction/levels):** 2
8+
9+
## Project Overview :page_facing_up:
10+
11+
### Overview
12+
13+
**Empowering decentralized AI with Polkadot on-chain integration.**
14+
The Polkadot ElizaOS Plugin is an open-source integration module designed to connect ElizaOS—a decentralized AI operating system—with the Polkadot ecosystem. The plugin provides a set of actions and providers for AI agents to access real-time on-chain data, query governance information, and interact with common parachain smart contracts, opening up the possibility for agentic interactions on Polkadot networks.
15+
Our plugin leverages the polkadot-js API for data feeds, utilizes Polkadot’s XCMP for cross-chain communication, and provides standardized interfaces for smart contract interactions on parachains. This tight integration enables seamless interaction between AI systems and the Polkadot network.
16+
Our team is driven by a passion for decentralized innovation. With extensive experience in blockchain integration and decentralized AI, we aim to reduce technical complexity and accelerate innovation by creating a standardized tool that benefits developers and researchers in the Polkadot ecosystem.
17+
18+
### Project Details
19+
20+
- **UI/UX Designs:**
21+
Initial mockups for administrative dashboards and API usage examples are available as part of our internal design documents.
22+
- **Data Models / API Specifications:**
23+
The plugin API will cover endpoints for:
24+
- Retrieving on-chain data (balances, block information, event logs).
25+
- Querying governance proposals and voting results.
26+
- Interacting with parachain smart contracts.
27+
28+
Detailed API specifications and data models will be documented using OpenAPI standards.
29+
- **Technology Stack:**
30+
- **Integration Layer** TypeScript with polkadot-js.
31+
- **Framework:** ElizaOS Monorepo set up with all necessary prerequisites for a fully functional local testing environment.
32+
- **Testing & Documentation:** Comprehensive unit tests (>95%); detailed inline documentation and user guides. Screenshots of end-to-end deep testing using a test AI Agent
33+
- **Core Documentation:**
34+
We will provide full technical documentation including architecture diagrams, integration guides, and API tutorials.
35+
- **Prior Work:**
36+
Our team has successfully delivered integration plugins for other blockchain ecosystems, such as the [ElizaOS TON Plugin](https://github.com/elizaos-plugins/plugin-ton/pull/18), which demonstrates our ability to build robust, community-driven, open-source projects.
37+
- **Scope Limitations:**
38+
This project focuses solely on software integration for ElizaOS with Polkadot and does not include any token issuance, financial instruments, or business-oriented services.
39+
40+
### Ecosystem Fit
41+
42+
- **Ecosystem Positioning:**
43+
The Polkadot ElizaOS Plugin acts as a bridge between decentralized AI and Polkadot’s data-rich environment, enabling developers to harness on-chain data, participate in governance, and utilize parachain smart contracts.
44+
- **Target Audience:**
45+
Developers and researchers building decentralized AI applications, dApp developers, and blockchain enthusiasts seeking simplified integration with Polkadot.
46+
- **Needs Addressed:**
47+
It streamlines agentic access to on-chain data and governance information, reducing the complexity of integrating blockchain functionalities into AI systems.
48+
- **Need Identification:**
49+
Our requirements are based on extensive community discussions and experience from other ecosystems.
50+
- **Competitive Landscape:**
51+
While several projects exist for blockchain integrations, none specifically target the intersection of ElizaOS as one of the most widely used Agentic frameworks and Polkadot’s unique capabilities. Our plugin’s focus distinguishes it from existing solutions.
52+
- **Related Projects:**
53+
Similar integrations exist in the Ethereum ecosystem, but our solution is tailored for Polkadot’s architecture and its cross-chain interoperability features.
54+
55+
## Team :busts_in_silhouette:
56+
57+
### Team members
58+
59+
- **Mihail Kirov:**
60+
Lead Developer with 5+ years of experience in distributed systems and blockchain integration. Specializes in connecting AI systems with decentralized networks and has a strong track record in open-source contributions.
61+
Mentored at the [Polkadot Prodigy](https://www.linkedin.com/posts/polkadotprodigy_lets-welcome-mihail-kirov-who-is-joining-activity-7191345617330192384-DJbv?utm_source=social_share_send&utm_medium=member_desktop_web&rcm=ACoAAC27-YYBCPf5vbQMBXvlthYYXnOflSOp-9A) Hackathon
62+
[GitHub: mikirov](https://github.com/mikirov) | [LinkedIn](https://www.linkedin.com/in/mihail-kirov/)
63+
64+
- **Tyler Ellis McWilliams:**
65+
Blockchain Developer with 5+ years of experience in decentralized applications, tokenomics, and smart contracts. Expert in multi-language development and AI integration, with extensive contributions to open-source projects.
66+
[GitHub: tylermcwilliams](https://github.com/tylermcwilliams) | [LinkedIn](https://www.linkedin.com/in/tyler-mcwilliams-85256a117)
67+
68+
69+
### Contact
70+
71+
- **Contact Name:** Mihail Kirov
72+
- **Contact Email:** [email protected]
73+
- **Website:** Your website
74+
75+
### Legal Structure
76+
77+
- **Registered Address:** Mladost 3, bl. 313, ent. 3, fl. 10, ap. 66, 1799, Sofia, Bulgaria.
78+
- **Registered Legal Entity:** Escrypt Ltd.
79+
80+
### Team's experience
81+
82+
### Team Code Repos
83+
84+
- [Mihail Kirov](https://github.com/mikirov)
85+
- [Tyler Ellis McWilliams](https://github.com/tylermcwilliams)
86+
87+
### Team LinkedIn Profiles
88+
89+
- [Mihail Kirov](https://www.linkedin.com/in/mihail-kirov/)
90+
- [Tyler Ellis McWilliams](https://www.linkedin.com/in/tyler-mcwilliams-85256a117)
91+
92+
## Development Status :open_book:
93+
94+
We have conducted preliminary research and have established a solid architectural design for the Polkadot ElizaOS Plugin.
95+
Initial prototypes and integration experiments with the polkadot-js API have been performed,
96+
and design documents outlining core functionalities, data models, and API specifications are available.
97+
Our prior work on similar projects (TON, IOTA and Ocean integrations) further validates our technical approach.
98+
Detailed documentation and research findings will be maintained in our repositories and published blog posts.
99+
100+
## Development Roadmap :nut_and_bolt:
101+
### Overview
102+
103+
- **Total Estimated Duration:** 180 person-days
104+
- **Full-Time Equivalent (FTE):** 2 FTE
105+
- **Total Costs:** 30,000 USD
106+
- **DOT %:** 50% of total costs
107+
108+
### Milestone 1 — Basic Integration and Data Feed
109+
110+
- **Estimated Duration:** 1 month
111+
- **FTE:** 2FTE, the listed members would contribute to different deliverables based on their skill-set.
112+
- **Costs:** 10,000 USD
113+
114+
| Number | Deliverable | Specification |
115+
| ------ | --------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
116+
| **0a.** | License | Apache 2.0 |
117+
| **0b.** | Documentation | Inline code documentation and a tutorial on how to set up the plugin and perform test queries using polkadot-js |
118+
| **0c.** | Testing and Testing Guide | Comprehensive unit tests covering core functions with instructions on running these tests |
119+
| 1. | Wallet Integration | Create actions to create a wallet, eject wallet, utilizing end-to-end encryption of the private key |
120+
| 2. | On-Chain Data Feed Module | Create actions to retrieve on-chain data (balances, block numbers, event logs) using polkadot-js API |
121+
| 3. | Governance Query Module | Develop actions to query and parse governance proposals, referenda, and voting results from Polkadot |
122+
123+
**Plugin Actions:**
124+
- **Polkadot Wallet Creation:**
125+
- Allows the user to create a new wallet, with both a user-provided secret and agent-generated one.
126+
- **Polkadot Wallet Eject:**
127+
- Allows the user to export their wallet using their passkey.
128+
- **Retrieve On-Chain Data:**
129+
- Action to fetch and filter on-chain data such as account balances, block information, and event logs.
130+
- Retrieves live data from Polkadot nodes via the polkadot-js API.
131+
- **View Governance Data:**
132+
- Action to display current governance proposals and voting results from Polkadot’s governance modules.
133+
134+
**Providers:**
135+
- **Polkadot Wallet Provider:**
136+
- Authenticate users by signing messages or transactions. Requires a created wallet, or secrets set up in env.
137+
- **Polkadot Data Provider:**
138+
- Integrates with the polkadot-js API to fetch on-chain data and governance information.
139+
- Manages API authentication, connection to Polkadot nodes, and error handling.
140+
141+
**Developer Tasks:**
142+
- Establish the plugin framework within ElizaOS.
143+
- Set up integration and unit tests targeting ≥95% coverage.
144+
- Define common interfaces for future actions and providers.
145+
146+
### Milestone 2 — Advanced Governance and Smart Contract Interaction
147+
148+
- **Estimated Duration:** 1 month
149+
- **FTE:** 2FTE, the listed members would contribute to different deliverables based on their skill-set.
150+
- **Costs:** 10,000 USD
151+
152+
| Number | Deliverable | Specification |
153+
| ------ | --------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
154+
| **0a.** | License | Apache 2.0 |
155+
| **0b.** | Documentation | Detailed documentation of governance query actions and smart contract interaction modules |
156+
| **0c.** | Testing and Testing Guide | Unit tests covering governance and contract interactions with testing instructions |
157+
| 4. | Transfers & Transactions | Execute token transfers between accounts, multisigs, or across parachains (XCMP transfers).
158+
| 5. | Parachain Crowdloans | Participate programmatically in parachain crowdloans by contributing DOT or KSM tokens. |
159+
| 6. | NFT Minting and Trading: | Mint, transfer, and trade NFTs on parachains like Unique Network.
160+
161+
### Milestone 3 — DeFi (Decentralized Finance) Use Cases
162+
- **Estimated Duration:** 1 month
163+
- **FTE:** 2FTE, the listed members would contribute to different deliverables based on their skill-set.
164+
- **Costs:** 10,000 USD
165+
166+
| Number | Deliverable | Specification |
167+
| ------ | --------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
168+
| **0a.** | License | Apache 2.0 |
169+
| **0b.** | Documentation | Detailed documentation of governance query actions and smart contract interaction modules |
170+
| **0c.** | Testing and Testing Guide | Unit tests covering governance and contract interactions with testing instructions |
171+
| 7. | Swapping Tokens | Swap assets on decentralized exchanges (DEXes) like HydraDX, Mangata, Zenlink, or Acala DEX. |
172+
| 8. | Liquidity Pools | Deposit, withdraw, and monitor liquidity pools or yield farms on parachains like Moonbeam, Acala, or Parallel Finance. |
173+
| 9. | Collateralized Lending | Interact with lending protocols (e.g., Acala or Parallel Finance), to deposit collateral, borrow tokens, or repay loans. |
174+
175+
## Future Plans
176+
177+
- **Long-Term Maintenance:**
178+
We plan to sustain the project through continuous community contributions and by exploring partnerships that provide service-based revenue streams. Our open-source approach ensures that the community can extend and improve the plugin over time.
179+
- **Short-Term Enhancements:**
180+
We will introduce advanced analytics tools for real-time monitoring, support additional parachain networks, and implement custom runtime modules based on community feedback.
181+
- **Long-Term Vision:**
182+
Our roadmap includes the development of easy-to-extend and intuitive interfaces, allowing contributors to easily extend and build on top of the plugin.
183+
184+
## Additional Information :heavy_plus_sign:
185+
186+
**How did you hear about the Grants Program?**
187+
- Research over missing ElizaOS ecosystems.
188+
- **Additional Work:**
189+
Our team has previously delivered successful integrations for the TON network. This is our first grant application for a Polkadot-specific project, marking our commitment to advancing decentralized AI technologies within the Polkadot ecosystem.
190+
- **Previous Grants:**
191+
None.

0 commit comments

Comments
 (0)