mit-dci / opencx

An open-source cryptocurrency exchange toolkit for implementing experimental exchange features
MIT License
205 stars 65 forks source link
bitcoin crypto crypto-exchange cryptocurrency cryptocurrency-exchanges exchange lightning puzzle timelock

opencx

Build Status License GoDoc

Cryptocurrency exchanges are some of the largest businesses in the cryptocurrency space, and their reserves are often viewed as "honeypots" of cryptocurrencies. Because of this, cryptocurrency exchanges have been a hotbed of crime in the form of hacks, front-running, wash trading, fake orderbooks, and much more. In order for cryptocurrency to be successful, we need safe, trustworthy ways to exchange cryptocurrencies, without fear that coins will be stolen, or trades executed unfairly. Additionally, the vast majority of exchange software is closed-source, and exchanges have historically not implemented technological upgrades that would substantially decrease risk for users.

OpenCX hopes to solve this problem by making it trivially easy to run a secure, scalable cryptocurrency exchange which implements many of these features, including:

Additionally, all of the components of OpenCX are designed to be swappable, secure, and scalable. The goal is to fit those requirements and implement features similar to that of modern cryptocurrency exchanges, while keeping high quality software.

DO NOT use in a production environment, this project is a work in progress!

Pull requests and issues encouraged!

Demo

gif of program in normal use

Contributing

Please see the contributing file to get started with contributing!

Setup

Requirements

Installing

Installing GMP

Debian

sudo apt-get install libgmp3-dev

macOS

brew install gmp

Clone repo and install dependencies

git clone git@github.com/mit-dci/opencx.git
cd opencx
go get -v ./...

Running opencx server / exchange

You will need to run MariaDB or any other MySQL database in-order to run the server. You can configure authentication details for your database at ~/.opencx/db/sqldb.conf

Start your database (MariaDB in this case)

Linux

sudo systemctl start mariadb

macOS

mysql.server start

Now build and run opencx

go build ./cmd/opencxd/...
./opencxd

Running opencx CLI client

go build ./cmd/ocx/...
./ocx

You can now issue any of the commands in the cxrpc README.md file.

Configuration

There are configuration options (both command line and .conf) for the client and the server, and by default home folders for these files will be created at ~/.opencx/opencxd/ and ~/.opencx/ocx/ respectively. You can decide whether or not to use the NOISE protocol for authentication, which hostnames and ports to use for connecting to certain clients, which coins you would like to support, and whether or not to support lightning.

If you'd like to add your own coins, just add a coinparam struct like in lit.