Utopian for CoinGecko:
Utopian.io is running this task request on behalf of CoinGecko.com
GitHub Repository
https://github.com/coingecko/cryptoexchange
Project Background
Cryptoexchange is a rubygem for Ruby developers to interact with over 240+ cryptocurrency exchange market data APIs in a single library. This rubygem is used to power CoinGecko. Available as open source under the terms of the MIT License.
Task Specification
For the existing HTTP API, this rubygem has established a pretty good abstraction which allows developers to easily contribute new exchanges.
The websocket API feature, however, is a new addition to this rubygem. As such, we are still figuring out the best abstraction/structure.
This merged pull request https://github.com/coingecko/cryptoexchange/pull/1008 contains the initial proof-of-concept, which supports connecting with Bitfinex ticker, order book, and trade websocket API.
Candidate's goals are as follows:-
- [ ] Suggest ways to improve upon the rubygem websocket connection design. (See *notes below)
- [ ] Suggest ways to spec/test external websocket API connection. (See *notes below)
- [ ] Implement public websocket API connections for Binance
- [ ] Implement public websocket API connections for Poloniex
- [ ] Implement public websocket API connections for Coinbase Pro
*Notes
- The Bitfinex websocket API requires us to make only ONE connection for ONE trading pair. For example, one websocket connection of BTC/USDT, in order to obtain stream data corresponding to that. As such, the existing structure in place for Bitfinex leverages on Threads in order to handle multiple streams.
- There may be a case where some websocket API require only ONE connection for MULTIPLE trading pairs. You may need to introduce additional abstractions to handle this situation.
- The HTTP API implementation of this rubygem uses VCR in order to mock API responses to ensure we can run an end-to-end integration test. VCR does not appear to work with websocket. We are considering manually mocking the websocket response but this can turn out to be unscalable when response changes.
- Feel free to suggest ways to streamline this abstraction.
How to get started?
- Navigate to the repository on Github https://github.com/coingecko/cryptoexchange
- Be sure to check out the README on its usages to familiarize yourself with the gem and contributing guide.
- https://github.com/coingecko/cryptoexchange/wiki/Implementing-a-New-Exchange-(Websocket-API) will likely be useful to you to get started.
- When you begin work, we suggest creating a Pull Request with a WIP headline so we can commence discussion there.
Deadline
2 weeks. Set to start upon candidate selection.
Communication
Please register your interest at https://discord.gg/pKGV9sp, CoinGecko's official Discord server in "utopian-io" channel.
You may contact us directly for further information via email at hello@coingecko.com or in our Discord developer discussion hub.
Github
Rewards Information
Rewards generated by this task request will be sent as liquid STEEM to the task solver once the task is completed, as decided by the project owner.
The task will be considered considered completed after it has been merged by CoinGecko developement team and when the solver published a Steemit post, explaining what they did in order to solve the task.