Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Reidmcc/rockfish
Rockfish is an arbitrage bot for the Stellar Decentralized Exchange (SDEX)
https://github.com/Reidmcc/rockfish
arbitrage arbitrage-bot blockchain cryptocurrency cryptocurrency-exchanges cryptocurrency-trading-bot stellar stellar-network trading trading-algorithms trading-bot trading-strategies
Last synced: 3 months ago
JSON representation
Rockfish is an arbitrage bot for the Stellar Decentralized Exchange (SDEX)
- Host: GitHub
- URL: https://github.com/Reidmcc/rockfish
- Owner: Reidmcc
- License: mit
- Created: 2019-01-20T23:53:18.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-21T01:03:42.000Z (over 5 years ago)
- Last Synced: 2024-06-18T22:53:59.685Z (5 months ago)
- Topics: arbitrage, arbitrage-bot, blockchain, cryptocurrency, cryptocurrency-exchanges, cryptocurrency-trading-bot, stellar, stellar-network, trading, trading-algorithms, trading-bot, trading-strategies
- Language: Go
- Homepage:
- Size: 14.5 MB
- Stars: 72
- Watchers: 11
- Forks: 23
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-stellar - Rockfish (free & open-source) - Rockfish is an arbitrage bot for the Stellar Decentralized Exchange (SDEX). (Use the Stellar Decentralized Exchange)
- awesome-stellar-cn - Rockfish (免费和开源) - Rockfish 是 Stellar 去中心化交易所 (SDEX) 的套利机器人。 (使用恒星去中心化交易所)
README
![rockfish banner](https://user-images.githubusercontent.com/43561569/52517026-2be8b480-2bfa-11e9-9f95-4379a7010ad1.png)
![GitHub last commit](https://img.shields.io/github/last-commit/Reidmcc/rockfish.svg?style=for-the-badge)
![license](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge&longCache=true)![Build Status](https://travis-ci.com/Reidmcc/rockfish.svg?branch=master)
![GitHub issues](https://img.shields.io/github/issues/Reidmcc/rockfish.svg?style=flat-square&longCache=true)
![GitHub pull requests](https://img.shields.io/github/issues-pr/Reidmcc/rockfish.svg?style=flat-square&longCache=true)Rockfish is an arbitrage bot for the Stellar Decentralized Exchange (SDEX). The SDEX is native to [Stellar's](https://www.stellar.org/) blockchain, and you can interact with it through third-party frontends, such as [Stellar X](https://www.stellarx.com/) and [Stellarport](https://stellarport.io/home).
Due to the specifics of the SDEX, the way Rockfish works is quite different from general arbitrage. First, Rockfish uses a same-exchange cross-asset strategy, instead of buying an asset on one exchange and selling the same asset on another.
More importantly, Rockfish doesn't technically perform trades; it makes payments. One of Stellar's headline features is [atomic multi-currency transactions](https://www.stellar.org/how-it-works/stellar-basics/explainers/#Multi-currency_transactions). These payments route assets through the SDEX, using available buy and sell orders. It's essentially a currency exchange service. It is also the equivalent of buying an asset, using that asset to buy a second asset, and selling the second asset back into the destination asset. If the orders line up favorably and you set the destination asset to the start asset, it's possible to make a profit. The underlying trades all execute together, so the intermediate assets are never held by either the payer or the recepient, greatly alleviating the risk that sequential trades would incur.
All of which also adds up to rationalizing price discovery on the SDEX. Pretty great!
### Using Rockfish
Check out the [walkthrough](https://github.com/Reidmcc/rockfish/blob/master/walkthrough.md).
### Installing Rockfish
Either grab one of the releases, or you can compile from source, see below. Terminal commands in these instructions are mostly for Linux.
1. Clone this repository
2. Install the [Go programming language](https://golang.org/)
3. Install [Glide](https://github.com/Masterminds/glide) `curl https://glide.sh/get | sh`
4. Run `glide install` (for Windows too)
5. Run Rockfish's `build.sh` from the main Rockfish repo directory `./scripts/build.sh`
6. You should now have a `bin` folder in your repository with an executable: `rockfish`#### A note about network congestion
We are committed to using the Stellar network in a way that is conscientious towards other network users. There has been some concern about arbitrage bots congesting the Stellar network by spamming path payments, which is a blunt way of trying to perform arbitrage. Rockfish only submits a transaction when it sees an actual profit opportunity; at maximum one transaction per ledger if there were profits available all the time.
#### Acknowledgments
Rockfish uses many [Kelp](https://github.com/interstellar/kelp) components and would not be possible without them. Real rockfish live in [kelp forests](https://en.wikipedia.org/wiki/Kelp_forest); hence the name.
Logo image based on: _[Tiger Rockfish](https://commons.wikimedia.org/wiki/File:Tiger_rockfish_Joseph_R._Tomelleri.JPG). Joseph R. Tomelleri, NOAA Professional Paper NMFS 18-Fishes of the Salish Sea: a compilation and distributional analysis. National Marine Fisheries Service (September 2015). doi:10.7755/PP.18_
#### Disclaimer
Nothing in Rockfish or its documentation should be taken as investment advice. Rockfish is available as-is, on the terms of the [MIT License](https://github.com/Reidmcc/rockfish/blob/master/LICENSE).