README.md

AlunaJS / Scaffolding

The first step to add a new exchange.

TL;DR

yarn add-exchange

Terminology

Before configuring the generator, the basics.

1. Trading Features
   • The account types that trading is enabled on this exchange:
     • Spot
     • Margin
     • Derivatives
2. API Features (that the exchange provides)
   • Order Editting
     • Does the exhange API provides a method for editing orders?
   • Position Indentifier
     • Does the exhange API provides a uid for positions?

1. Scafflding

Let's do it.

yarn add-exchange

<image-1-here>
<image-2-here>

Configure your new exchange and voilà.

If your exchangeId was 'bitfinex', you should end up with this:

src/exchanges/bitfinex
├── Bitfinex.ts
├── BitfinexAuthed.ts
├── BitfinexHttp.ts
├── bitfinexSpecs.ts
├── enums
│   └── delete-me.txt
├── errors
│   └── delete-me.txt
├── modules
│   ├── authed
│   └── public
└── schemas
    ├── IBitfinexKeySchema.ts
    ├── IBitfinexMarketSchema.ts
    └── IBitfinexSymbolSchema.ts

2. HTTP Class

First, implement an http class.

It should sign requests and send them the way the exchange expects.

Examples:

• BittrexHttp.ts
• BittfinexHttp.ts

3. Enums & Schemas

Here we need to configure and the types related to the exchange.

They should completely describe the data model for all Exchange API methods.

Enums

• Bittrex:
  • BittrexOrderSideEnum.ts
  • BittrexOrderTypeEnum.ts
• Bitfinex:
  • BitfinexOrderTypeEnum.ts

Schemas

• Bittrex:
  • IBittrexSymbolSchema.ts
  • IBittrexMarketSchema.ts
  • IBittrexKeySchema.ts
  • IBittrexBalanceSchema.ts
• Bitfinex:
  • IBitfinexSymbolSchema.ts
  • IBitfinexMarketSchema.ts
  • IBitfinexKeySchema.ts
  • IBitfinexBalanceSchema.ts

4. Public Modules

Implement all the public API methods:

Examples:

• Bittrex

  • bittrex/modules/public/market.ts
    • bittrex/modules/public/market/list.ts
    • bittrex/modules/public/market/listRaw.ts
  • bittrex/modules/public/symbol.ts
    • bittrex/modules/public/symbol/list.ts
    • bittrex/modules/public/symbol/listRaw.ts

• Bitfinex

  • bitfinex/modules/public/market.ts
    • bitfinex/modules/public/market/list.ts
    • bitfinex/modules/public/market/listRaw.ts
  • bitfinex/modules/public/symbol.ts
    • bitfinex/modules/public/symbol/list.ts
    • bitfinex/modules/public/symbol/listRaw.ts

5. Authed Modules

Here, all the authenticated methods:

Examples:

• Bittrex
  • bittrex/modules/authed/key.ts
  • bittrex/modules/authed/balance.ts
  • bittrex/modules/authed/order.ts
• Bitfinex
  • bitfinex/modules/authed/key.ts
  • bitfinex/modules/authed/balance.ts
  • bitfinex/modules/authed/order.ts
  • bitfinex/modules/authed/position.ts