-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create getting_new_routes_integrated_into_cow_protocol.md #434
Merged
harisang
merged 7 commits into
main
from
getting_new_routes_integrated_into_cow_protocol.md
Jan 21, 2025
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
2ba8361
Create getting_new_routes_integrated_into_cow_protocol.md
cmagan 17e953c
Update docs/cow-protocol/tutorials/solvers/getting_new_routes_integra…
cmagan 437ef1e
Update docs/cow-protocol/tutorials/solvers/getting_new_routes_integra…
cmagan a757643
Update getting_new_routes_integrated_into_cow_protocol.md
cmagan 58259e7
Update and rename getting_new_routes_integrated_into_cow_protocol.md …
cmagan da70507
Update docs/cow-protocol/tutorials/solvers/routes_integration.md
cmagan 0505a91
Update routes_integration.md
cmagan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
122 changes: 122 additions & 0 deletions
122
docs/cow-protocol/tutorials/solvers/routes_integration.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,122 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Getting new routes integrated Into CoW Protocol | ||
|
||
## 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 unique batch auction mechanism and competition between multiple solvers provides several advantages: | ||
|
||
- Gain access to our growing ecosystem of traders and protocol integrators | ||
- The protocol finds optimal prices by aggregating liquidity across multiple sources | ||
- Trades gain protection from MEV through our batch auction system | ||
- Users benefit from reduced gas costs through our order batching mechanism | ||
|
||
## 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 follow-up 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 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistency of "." (dots) use. Some sentences have a dot at the end and some do not