Skip to content

Design Notes

Jump to bottom Edit New page
gmkarl edited this page Nov 19, 2015 · 20 revisions

General overview

The intention to is allow clients to connect to a wide range of exchanges offering trade opportunities. This is not limited to Bitcoin, although the first exchange implementation happens to use the BTC currency due to market demand.

High level overview of architecture

Two approaches were considered: fully self-contained, or extensible. Existing APIs addressing similar problems (such as JDBC for relational databases) demonstrated that the extensible approach is the better choice. This implied that XChange should provide a collection of interfaces that someone will need to implement for their exchange. Clearly, XChange will initially create early versions of these providers, but eventually it is hoped that exchange owners themselves will contribute them. This is actively encouraged.

High level overview of components

The following are the main components that developers will interact with, typically in the order presented below. These classes are all in xchange-core in the com.xeiam.xchange package.

ExchangeSpecification

This provides all the configuration for the Exchange including the implementor class name, authentication credentials, API secret keys and so on. Passing this to the ExchangeFactory will result in a suitable configured Exchange to work with.

ExchangeFactory

Is responsible for creating Exchange implementations based on details provided in the ExchangeSpecification.

Exchange

The main point of interaction. This interface provided to consuming applications, which will use this to access the various services supported by the exchange by calling one of the supporting getters. Exchanges may implement this interface by extending BaseExchange.

ExchangeServices

  • BasePollingService
    • PollingMarketDataService
    • PollingTradeService
    • PollingAccountService
  • StreamingExchangeService

Interfaces which are the entry point to an exchange service (e.g. listing market prices against a particular symbol etc), could be synchronous (blocking) or asynchronous (non-blocking) depending on the requirement.

Implementations of these service extend provide base classes:

  • BaseExchangeService
    • BasePollingExchangeService
    • BaseWebSocketExchangeService

A service is encouraged to have two implementations, one which provides the raw data from the exchange, and one which coerces this data into standard DTOs and implements one of the Service interfaces.

DTOs

Standard DTOs for encoding a message to and from the exchange. Treated as immutable.

Where next?

See here for a list of completed and planned milestones

<title>gfg</title> <style type=text/css> p{ background-color:gray; margin: 10px; } 
     div
     {
     color: white;
     background-color: 009900;
     margin: 2px;
     font-size: 25px;
     }
     span
     {
     color: black;
     background-color: gray;
     margin: 5px;
     font-size: 25px;
     }
  </style>

  <div> div tag   </div>
  <div> div tag   </div>
  <div> div tag   </div>
  <div> div tag   </div>

  <span>span-tag</span>
  <span>span-tag</span>
  <span>span-tag</span>
  <span>span-tag</span>
Add a custom sidebar
Clone this wiki locally