-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create getting_new_routes_integrated_into_cow_protocol.md
We get many requests for integrating new routes, so it seems appropriate to have a public doc about it
- Loading branch information
Showing
1 changed file
with
117 additions
and
0 deletions.
There are no files selected for viewing
117 changes: 117 additions & 0 deletions
117
...w-protocol/tutorials/solvers/getting_new_routes_integrated_into_cow_protocol.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
## Overview | ||
|
||
This guide is designed for teams building in DeFi who want to get their routes integrated and supported by CoW Protocol. Integration of new liquidity sources enables CoW Protocol's solvers to access more trading opportunities, potentially leading to better prices for users. | ||
|
||
## Why integrate with CoW Protocol? | ||
|
||
CoW Protocol's uses a unique batch auction mechanism and competition between multiple solvers. | ||
|
||
- Access to a growing user base of traders and integrators | ||
- Increase your volumes by integrating into the leading trading protocol on Ethereum | ||
- Finding the best prices across different liquidity sources | ||
- MEV protection through batch auctions | ||
- Gas optimization through order batching | ||
|
||
## Integration Requirements | ||
|
||
### 1. Price Discovery Interface | ||
|
||
Solvers need a reliable way to obtain price estimates and available liquidity. This can be provided through: | ||
|
||
- On-chain methods to query pool states or oracle prices | ||
- Off-chain API endpoints providing real-time pricing data | ||
- WebSocket feeds for continuous updates | ||
- Documentation of pricing functions or AMM curves | ||
|
||
### 2. Settlement Interface | ||
|
||
A well-documented smart contract interface for executing trades, including: | ||
|
||
- Function specifications for swap execution | ||
- Required parameters and their formats | ||
- Gas consumption estimates | ||
- Safety checks and failure modes | ||
|
||
### 3. Technical Documentation | ||
|
||
Comprehensive documentation should include: | ||
|
||
- Smart contract addresses on supported networks | ||
- API specifications and endpoints | ||
- Authentication requirements (if any) | ||
- Rate limits and other technical constraints | ||
- Example implementations or code snippets | ||
|
||
## Self Service Integration | ||
|
||
Instead of waiting for solver teams to have the capacity and resources to deliver your integration, few solver teams offer a self service integration. | ||
|
||
**Tycho (Propeller heads) - read more [here](https://docs.propellerheads.xyz/tycho/for-dexs/protocol-integration-sdk)** | ||
|
||
## Integration Process | ||
|
||
1. **Submit Integration Proposal** | ||
- Use the integration proposal template and make sure to add all necessary information. | ||
- Post on CoW DAO forum, and engage with any followup questions | ||
2. **Solver Integration** | ||
- Solver teams evaluate integration opportunity | ||
- Development and testing | ||
- Deployment to production | ||
|
||
## Integration Proposal Template | ||
|
||
```markdown | ||
# Liquidity Source Integration Proposal | ||
|
||
## Title | ||
[Your DEX/Liquidity Source Name] Integration | ||
|
||
## Author | ||
[Name(s)] | ||
[Contact Information] | ||
|
||
## Simple Summary | ||
[Brief description of your liquidity source and its unique features] | ||
|
||
## Motivation | ||
- What unique value does your liquidity source bring? | ||
- How will it improve settlement quality? | ||
- What trading pairs/assets are supported? | ||
- Current trading volumes and liquidity depth | ||
|
||
## Technical Specification | ||
|
||
### Price Discovery | ||
- How can solvers obtain price information? | ||
- API endpoints or on-chain methods | ||
- Response formats and data structures | ||
- Rate limits and performance characteristics | ||
|
||
### Settlement Interface | ||
- Smart contract addresses | ||
- Function signatures | ||
- Parameter specifications | ||
- Gas cost estimates | ||
- Example transactions | ||
|
||
## Integration Incentives | ||
- Are you offering integration grants? | ||
|
||
## Additional Information | ||
- Security audits | ||
- Known limitations | ||
- Future roadmap | ||
- Testing environment details | ||
|
||
## Contact Information | ||
- Development team contacts | ||
- Technical support channels | ||
- Response time expectations | ||
|
||
``` | ||
|
||
## Support and Communication | ||
|
||
- Join the CoW Protocol Discord for technical discussions | ||
- Participate in the CoW Protocol forum | ||
- Schedule technical calls with solver teams if needed |