rockfish

command module
v1.0.0-rc Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 20, 2019 License: MIT Imports: 2 Imported by: 0

README

rockfish banner GitHub last commit license

Build Status GitHub issues GitHub pull requests

Rockfish is an arbitrage bot for the Stellar Decentralized Exchange (SDEX). The SDEX is native to Stellar's blockchain, and you can interact with it through third-party frontends, such as Stellar X and Stellarport.

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. 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. Please note Rockfish is in alpha; proceed with care.

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
  3. Install 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 components and would not be possible without them. Real rockfish live in kelp forests; hence the name.

Logo image based on: Tiger Rockfish. 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.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL