Skip to content

Commit 9cb35f5

Browse files
authored
Update swush-dex-aggregator.md (#2502)
* Update swush-dex-aggregator.md * Update swush-dex-aggregator.md
1 parent 5af1f5a commit 9cb35f5

File tree

1 file changed

+46
-40
lines changed

1 file changed

+46
-40
lines changed

applications/swush-dex-aggregator.md

Lines changed: 46 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -173,18 +173,19 @@ https://github.com/swush-labs/
173173
We have added all our research work at [Ecosystem Fit section](#ecosystem-fit). \
174174
Our initial UI which we created is hosted [here](https://swush-labs.github.io/swush-me-app/), but we plan to iterate as per the designs shared at [Project Details](#project-details).
175175

176+
176177
## Development Roadmap :nut_and_bolt:
177178

178-
### Overview[](https://grants.web3.foundation/applications/typink#overview-1)
179+
### Overview
179180

180-
- **Total Estimated Duration:** 4 months
181-
- **Full-Time Equivalent (FTE):** 1.5
182-
- **Total Costs:** 25,000 USD
183-
- **DOT %:** 50%
181+
- **Total Estimated Duration:** 5 months
182+
- **Full-Time Equivalent (FTE):** 1.5
183+
- **Total Costs:** 25,000 USD
184+
- **DOT %:** 50%
184185

185186
### **Milestone 1: Foundational Development & Simulation Environment**
186187

187-
- **Time: 1.5 - 2 months**
188+
- **Time: 2-2.5 months**
188189
- **FTE:** 1.5
189190
- **Costs:** 9000 USD
190191

@@ -194,55 +195,59 @@ Our initial UI which we created is hosted [here](https://swush-labs.github.io/sw
194195
- Creation of a responsive user interface (UI) that will serve as the primary interaction layer. The UI will include swap functionality, wallet connection, and real-time asset balances of user.
195196
- **Wallet Integration:**
196197
- Integration of Web3 wallets (e.g., Polkadot.js, Talisman) for seamless user authentication, transaction signing, and balance viewing.
197-
- **Simulated Testing Environment:**
198-
- Setup of a simulated testing environment to replicate real-world conditions. This will include mock wallets for swap visualizations, allowing developers to test various swap scenarios and edge cases (e.g., low liquidity, high fees).
199-
- Mock multiple networks (Polkadot Asset Hub and parachain)
200-
- Liquidity pools for asset swaps
201-
- Cross-chain asset swapping
202-
- Route optimization to find the most cost-efficient swap
203-
- Final Aggregation and Testing Simulation
198+
- **Asset APIs**
199+
- Fetch asset info and metadata from Asset Hub and Hydration parachain present in their liquidity pool and display in UI
200+
- **Asset Pair Rates APIs**
201+
- Fetch asset rates for pairs present in liquidity pool of Asset Hub and Hydration parachain and display in UI
204202
- **Basic Notification System:**
205203
- Development of a notification system to provide users with real-time feedback on transaction status.
204+
206205
- **User Profiles:**
207206
- Implement user profiles to store settings (e.g.. preferred slippage tolerance).
208207

209208

210209
| Number | Deliverable | Specification |
211210
| --- | --- | --- |
212211
| **0a.** | License | GPLv3 |
213-
| **0b.** | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** |
212+
| **0b.** | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** |
214213
| **0c.** | Testing and Testing Guide | Tutorial that explains how to test all deliverables of this milestone. Core functions for this milestone will be tested with **Simulated Testing Environment** as mentioned above. |
215214
| **0d.** | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
216-
| 0e. | Article | We will publish an article for the work done. |
215+
| 0e. | Article | We will publish an article for the work done. |
217216
| 1. | **Basic Functional UI (Responsive Design)** | (as mentioned above) |
218217
| 2. | **Wallet Integration** | (as mentioned above) |
219-
| 3. | **Simulated Testing Environment** | (as mentioned above) |
220-
| 4. | **Basic Notification System** | (as mentioned above) |
221-
| 5. | **User Profiles** | (as mentioned above) |
218+
| 3. | **Asset APIs** | (as mentioned above) |
219+
| 4. | **Asset Pair Rates APIs** | (as mentioned above) |
220+
| 5. | **Basic Notification System** | (as mentioned above) |
221+
| 6. | **User Profiles** | (as mentioned above) |
222+
223+
222224

223225

224226
### **Milestone 2: Advanced Features**
225-
- **Time: 2-2.5 months**
227+
- **Time: 2.5 months**
226228
- **FTE:** 1.5
227229
- **Costs:** 16000 USD
228230

229231
### **Features:**
230232

231-
- **Cross-Chain (XCM) APIs and DEX Swap Integration:**
233+
- **Cross-Chain (XCM) APIs**
232234
- Integrates cross-chain messaging (XCM) to transfer assets from the Asset Hub to a parachain (e.g., Hydration) for swapping. After the swap on the parachain, assets are returned to the Asset Hub, allowing users to access parachain liquidity while keeping assets on the Asset Hub.
233-
- Polkadot Asset Hub’s Asset APIs to enable real-time asset balances, rates, and integration of Asset Hub assets in cross-chain swaps.
234-
235-
- **Slippage Control and Protection:**
235+
- **Slippage Control and Protection**
236236
- Implementation of slippage control, allowing users to swap assets below maximum slippage tolerance set in User Profiles(Milestone 1). This ensures that users are protected against drastic price changes during the transaction execution process.
237-
- **Real-time Fee Updates:**
238-
- Implementation of real-time updates for swap rates and transaction fees. This will involve pulling live data from Asset Hub and parachain DEX.
239-
- **Multi Asset Pair Swap**
240-
- Support swaps between asset pairs not present in liquidity pools (e.g., MYTH/USDC when only DOT/USDC and DOT/MYTH are available).
237+
- **Asset Balance**
238+
- Real time asset balances of user.
239+
- **Real-time Fee Updates**
240+
- Real-time updates for swap rates, transaction fees and XCM fees wherever applicable.
241+
- **Asset Pair Swap**
242+
- Swap between asset pairs present in liquidity pools.
243+
- **Multi Asset Pair Swap**
244+
- Support swaps between asset pairs not present in liquidity pools (e.g., MYTH/USDC when only DOT/USDC and DOT/MYTH are available).
245+
241246
- **Optimized Routing**
242-
- Automated route optimization to ensure that users are always getting the most cost-efficient swap by comparing fees, quote price and slippage across various DEXes(e.g. Polkadot Asset Hub DEX and Hydration DEX)
243-
- **Advanced Simulated Testing Environment:**
244-
- Comprehensive testing of the entire DEX aggregator, including functionality and performance. This will involve simulating testing transaction reliability across multiple chains, and ensuring the stability of the platform under different scenarios (e.g., high transaction volume, fluctuating slippage).
245-
- **User Transaction History:**
247+
- Automated route optimization to ensure that users are always getting the most cost-efficient swap by comparing fees, quote price and slippage across various DEXes(e.g. Polkadot Asset Hub DEX and Hydration DEX).
248+
- **Chopsticks simulation**
249+
- Chopsticks simulation to test all the features mentioned above.
250+
- **User Transaction History**
246251
- Implementation of user transaction history, enabling users to view their past swaps.
247252

248253
Note: for parachain DEX integration we will do for Hydration only as of now.
@@ -252,17 +257,18 @@ Note: for parachain DEX integration we will do for Hydration only as of now.
252257
| Number | Deliverable | Specification |
253258
| --- | --- | --- |
254259
| **0a.** | License | GPLv3 |
255-
| **0b.** | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** |
260+
| **0b.** | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** |
256261
| **0c.** | Testing and Testing Guide | Tutorial that explains how to test all deliverables of this milestone. |
257262
| **0d.** | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
258-
| 0e. | Article | We will publish an article for the work done. |
259-
| 1. | **Cross-Chain (XCM) APIs and DEX Swap Integration** | (as mentioned above) |
260-
| 2. | **Slippage Control and Protection** | (as mentioned above) |
261-
| 3. | **Real-time Fee Updates** | (as mentioned above) |
262-
| 4. | **Multi Asset Pair Swap** | (as mentioned above) |
263-
| 5. | **Optimized Routing** | (as mentioned above) |
264-
| 6. | **Advanced Simulated Testing Environment** | (as mentioned above) |
265-
| 7 | **User Transaction History** | (as mentioned above) |
263+
| 0e. | Article | We will publish an article for the work done. |
264+
| 1. | **Cross-Chain (XCM) APIs** | (as mentioned above) |
265+
| 2. | **Asset Balance** | (as mentioned above) |
266+
| 3. | **Slippage Control and Protection** | (as mentioned above) |
267+
| 4. | **Real-time Fee Updates** | (as mentioned above) |
268+
| 5. | **Asset Pair Swap** | (as mentioned above) |
269+
| 6. | **Optimized Routing** | (as mentioned above) |
270+
| 7. | **Chopsticks simulation** | (as mentioned above) |
271+
| 8 | **User Transaction History** | (as mentioned above) |
266272

267273

268274
## Future Plans

0 commit comments

Comments
 (0)