https://github.com/bh2smith/cowswap-integrations-py
A collection of simple API integrations for Gnosis Protocol V2
https://github.com/bh2smith/cowswap-integrations-py
api-integration cowswap gnosis-protocol
Last synced: 6 months ago
JSON representation
A collection of simple API integrations for Gnosis Protocol V2
- Host: GitHub
- URL: https://github.com/bh2smith/cowswap-integrations-py
- Owner: bh2smith
- Created: 2021-09-26T11:32:07.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-04T12:57:19.000Z (about 2 years ago)
- Last Synced: 2025-04-24T03:13:32.773Z (6 months ago)
- Topics: api-integration, cowswap, gnosis-protocol
- Language: Python
- Homepage:
- Size: 40 KB
- Stars: 7
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**⚠️ UNDER CONSTRUCTION ⚠️**
Make an order through API CowSwap
## Setup & Installation
```shell
python3 -m venv venv
source ./env/bin/activate
pip install -r requirements.txt
```
You will need to create your own `.env` file. A template exists here as `.env.sample`
from which you can make your own by running the command `cp .env.sample .env` and
filling in your own account details.
## Placing an Order
Set your network and private key in `.env`.
Fill the variables in the `cow_swap` method of `./main.py`
```shell
source .env
python -m src.main
```
If you run the script exactly as is with the public and private keys provided, you
should receive an error from the orderbook API saying:
```shell
{"errorType":"InsufficientFunds","description":"order owner must have funds worth at least x in his account"}
```
# CowSwap API Integrations & Tid Bits
A collection of python scripts and services built as simple integrations
with [Gnosis Protocol v2](https://gnosis.io/protocol/)
## [WIP] Trading Bot for Stable Coin Orders
Initially inspired by [Martin's script](https://pastebin.com/RZyfL08P). This integration
is a simple bot which monitors the orderbook seeking open orders
between [stable coins](https://en.wikipedia.org/wiki/Stablecoin). Assuming that, on
average, USD stable coins are worth 1 USD, the bot is prepared to place a counter order
for any swap willing to trade `x` of token A for `y` of token B when `x < y`. It is
important to remember that execution fees must be factored into this decision-making
process so that the counter order placed should net a result of strictly more tokens
purchased than sold (including fees).
For this reason, the script is primarily intended to be run on xDai network where
transaction fees are negligible.
To see the trading history of the bot currently running on xDai with this script check
out this [trade history](https://dune.xyz/queries/130938/257752) table filtered by
address [0xd2cc479be0512301d0b19c3c0a9300baa1e03758](https://blockscout.com/xdai/mainnet/address/0xD2Cc479Be0512301D0B19C3C0A9300bAA1E03758/transactions)
## [TODO] LP Token Solver
Design an HTTP solver which allow people to "swap"
[LP tokens](https://coinmarketcap.com/alexandria/glossary/liquidity-provider-tokens-lp-tokens)
In essence, the solver will fetch the open orderbook, filtering for orders whose buy or
sell token is an LP token. It will then encode the interactions necessary to enter or
exit liquidity from the corresponding pool.
### Advanced features
In the event that there is a
[coincidence of wants](https://en.wikipedia.org/wiki/Coincidence_of_wants)
(a.k.a. a *CoW*), the solver could match the orders directly to reduce the cost of
execution. Note that, A CoW in this scenario corresponds to a simultaneous desire to
provide and withdraw liquidity from a specific pool.