Skip to content

Latest commit

 

History

History
188 lines (101 loc) · 5.08 KB

README.md

File metadata and controls

188 lines (101 loc) · 5.08 KB
Raw

MMM: Integrated Crypto Market Making Bot

An automated grid/ping-pong market-making bot supporting various exchanges.

In general, market making works by placing orders on both buy and sell sides. When an order is filled, the bot counters it by placing a new order on the opposing side.
The bot also maintains the number of order levels by seeding (placing new orders) or trimming (cancelling extra orders) as defined in config. In this bot only filled orders are countered. It doesn't counter partially-filled orders.

As having multiple orders on the same price and quantity is undesirable the bot will also remove such duplicates starting from the newest one.

One bot (defined in config's bots) should operate on one symbol (pair) only.

Supported exchanges:

  • HitBtc
  • Okex
  • Yobit
  • Fcoin
  • Livecoin
  • Btcalpha

Exchanges

Operation

Version notes

Running

Use config-template as config reference.

One bot in [bots] will market-make on one pair.

Clone the repo and run this to build and package it into a fat jar.

sbt assembly

(result jar is in /target)

To run

java -jar program.jar <path to config file> <path to log directory> <path to bot cache directory>

Config

exchange

Type: string

Name of the exchange. See Exchanges for supported exchanges.

credentials

pKey

Type: string

Api Key

nonce

Type: string

Nonce (used for Hitbtc). Set empty string if it's not needed.

signature

Type: string

Secret key or signed nonce (Hitbtc).

pair

Type: string

Pair or symbol in format accepted by the exchange.

seed

Type: string
Enum: lastTicker, cont, or any valid number as starting price.

Seed determines how the bot starts. Refer to Supported Exchanges for allowed methods.

lastTicker, any valid number: cancels all active orders, seeds new orders from config. Any uncountered orders during the time the bot is not running will not be countered.
This method is used when starting fresh or when config was changed.

lastOwn : uses last traded price as new seed price. As the amount information is lost, amount is taken from config.

cont: continues from last session. Any uncountered orders during the time the bot is not running will be countered.
To correctly run this method, the account needs to have some active orders and the bot should not be inactive longer than exchange's trade history retention. Some exchanges keep trade history for 2 days so if the bot is restarted later, it may not be able to retrieve all filled orders.

gridSpace

Type: string

Price level between orders, behavior determined by strategy.

buyGridLevels, sellGridLevels

Type: int

Number of orders to be maintained in orderbook.

buyOrderQuantity, sellOrderQuantity

Type: string

Amount of order.

quantityPower

Type: int

Only used in ppt. Rate of quantity appreciation / depreciation which is denoted as (sqrt(gridSpace))^quantityPower.

counterScale, baseScale

Type: int

Scale of minimum amount of counter / base currency accepted by the exchange.

Examples:

  • If minimum quantity 1 -> scale = 0
  • If minimum quantity 0.001 -> scale = 3
  • If minimum quantity 1000 -> scale = -3

isHardReset (deprecated)

Type: boolean

If true then when the bot starts it will remove all orders and seed new orders with recalculated middle price. This method will clear any holes (missing levels) but lose all ping/pong information from the old orders.

If false then the bot will only fill the hole closest to market middle price. This will preserve the ping/pong info of each order but not fill all possible holes.

isStrictLevels

Type: boolean

If true then number of orders is kept according to buyGridLevels pr sellGridLevels by removing tail orders. WARNING : this may cause holes in orderbook.

isNoQtyCutoff

Type: boolean

If true then order's quantity will never become zero. Instead it will be replaced with the currency's minimum amount.

maxPrice, minPrice (Optional)

Type: string

Maximum and minimum price the bot will operate on

strategy

Type: string

Strategy to be used. Refer to strategy section for valid names.

Strategies

Proportional

code: ppt

Both base quantity and unit price are spaced by percentage point of the previous offerCreate level.

For sell direction p1 = (1 + gridSpace / 100) * p0 and q1 = q0 / ((1 + gridSpace / 100)^0.5)^quantityPower

For buy direction p1 = p0 / (1 + gridSpace / 100) and q1 = q0 * ((1 + gridSpace / 100)^0.5)^quantityPower

Pay attention minimum quantity. Ideally minimum quantity should be smaller than (gridSpace / 100 * quantity)

Full-fixed

Code: fullfixed

The new unit price is spaced rigidly by gridSpace, e.g. if a buy order with price X is consumed then a new sell order selling the same quantity with price X + gridSpace will be created.

If a sell order with price Y is consumed then a buy order with the same quantity and price Y - gridSpace will be created.