This tool allows the user to simulate trades through a liquidity pool on Osmosis and see how trades may be affected by slippage.
The aim of this application is to allow users to see how trades on Osmosis Zone are affected by slippage. Users can select a liquidity pool they wish to simulate as well as size of the trade. Many new tokens may only be available in liquidity pools with minimal depth, and thus trading can be severly impacted by slippage. While the default slippage percentage is set at 1%, users can toggle this setting to allow for greater slippage.
Right now, this application utilizes Flipside Crypto Osmosis data to monitor transactions. Flipside Crypto does not provide live data, but data on a 12 hour delay. So transactions performed within the last 12 hours will not be immediately available on the application.
To access the Flipside Crypto dataset, you will need an API key. To obtain an API key, sign up for the app and navigate to the key management page.
Alternatively, you can visit app.flipsidecrypto.com and sign up for an account using either your Discord, ETH wallet, or email. Write your query in the application's query editor, set an appropriate refresh rate in the upper right corner, and use the API button to generate a URL. Use this URL as a GET request in your code, and the Python json library to parse the query results.
The front-end of this application was created using Shiny for Python. To install Shiny, please follow the installation instructions on the Shiny webpage. Please note that Shiny for Python is still in the alpha phase, and thus the package may include bugs. It is not currently recommended to use Shiny for Python for large-scale production applications.
Contributions of any form are encouraged and appreciated. Please follow the "fork and pull" Git workflow if you would like to create a new feature:
- Fork the repo on Github
- Clone the repo onto your own machine
- Create a new branch and commit any changes to this branch
- Push your work to back up your fork
- Submit a pull request and request review from jhuhnke
IMPORTANT: Be sure to merge the lastest commit from upstream before submitting a pull request.
The more detailed the branch name and description of the pull request, the better! A thorough description of what you are adding to the codebase will help speed up the review process.
To report a bug or submit a feature request, please use the issues tab to open and submit an issue. The more detailed the bug report or feature request, the easier it is for me to integrate it into the application!
Any donations are greatly appreciated and will be put torwards the cost of the deployment server. Extra donations will likely be used to buy the dev a coffee or a beer.
Osmosis address: osmo1dup5a0hn4lel0kexcsx2yk4arm0hxm0cde6d4h
Cosmos Hub address: cosmos1dup5a0hn4lel0kexcsx2yk4arm0hxm0c9zfar9
ETH address: 0xdB69470D5e86Ae237721Cf1A292B80220d5575EA
Solana address: 2L6j3wZXEByg8jycytabZitDh9VVMhKiMYv7EeJh6R2H
This software has a GNU GPLv3 License. Feel free to do anything with this code except distribute a closed source version.
If you fork or get inspirition from this code, please include proper attribution.