Skip to content
This repository has been archived by the owner on Sep 9, 2023. It is now read-only.

Add exchange GMO Coin #247

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add exchange GMO Coin
  • Loading branch information
develoQ authored and develoQ committed Jan 8, 2021
commit 6d8cbbd98c014137b69d1f45315d0f273bdb34e3
1 change: 1 addition & 0 deletions .github/workflows/node.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ jobs:
- ftx-us
- gateio
- gemini
- gmocoin
- hitbtc
- huobi
- huobi-futures
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ binance.subscribeLevel2Snapshots(market);
| FTX US | 1 | FtxUs | ✓ | ✓ | - | - | ✓\* | - | - |
| Gate.io | 3 | Gateio | ✓ | ✓ | - | - | ✓\* | - | - |
| Gemini | 1 | Gemini | - | ✓ | - | - | ✓\* | - | - |
| GMOCoin | 1 | GMOCoin | ✓ | ✓ | - | ✓ | - | - | - |
| HitBTC | 2 | HitBTC | ✓ | ✓ | ✓ | - | ✓\* | - | - |
| Huobi Global | 1 | Huobi | ✓ | ✓ | ✓ | ✓ | - | - | - |
| Huobi Global Futures | 1 | HuobiFutures | ✓ | ✓ | ✓ | ✓ | ✓\* | - | - |
Expand Down
81 changes: 81 additions & 0 deletions __tests__/exchanges/gmocoin-client.spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
const { testClient } = require("../test-runner");
const GMOCoinClient = require("../../src/exchanges/gmocoin-client");

testClient({
clientFactory: () => new GMOCoinClient(),
clientName: "GMOCoinClient",
exchangeName: "GMOCoin",
markets: [
{
id: "BTC",
base: "BTC",
quote: "JPY",
},
{
id: "ETH",
base: "XRP",
quote: "JPY",
},
{
id: "BCH",
base: "XRP",
quote: "JPY",
},
{
id: "LTC",
base: "XRP",
quote: "JPY",
},
{
id: "XRP",
base: "XRP",
quote: "JPY",
},
],

testConnectEvents: false,
bmancini55 marked this conversation as resolved.
Show resolved Hide resolved
testDisconnectEvents: false,
testReconnectionEvents: false,
testCloseEvents: false,

hasTickers: true,
hasTrades: true,
hasCandles: false,
hasLevel2Snapshots: true,
hasLevel2Updates: false,
hasLevel3Snapshots: false,
hasLevel3Updates: false,

ticker: {
hasTimestamp: true,
hasLast: true,
hasOpen: false,
hasHigh: true,
hasLow: true,
hasVolume: true,
hasQuoteVolume: false,
hasChange: false,
hasChangePercent: false,
hasBid: true,
hasBidVolume: false,
hasAsk: true,
hasAskVolume: false,
},

trade: {
hasTradeId: false,
},

l2snapshot: {
hasTimestampMs: true,
hasSequenceId: false,
hasCount: false,
},

l2update: {
bmancini55 marked this conversation as resolved.
Show resolved Hide resolved
hasSnapshot: true,
hasTimestampMs: false,
hasSequenceId: false,
hasCount: false,
},
});
180 changes: 180 additions & 0 deletions src/exchanges/gmocoin-client.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
const BasicClient = require("../basic-client");
const BasicMultiClient = require("../basic-multiclient");
const Ticker = require("../ticker");
const Trade = require("../trade");
const Level2Point = require("../level2-point");
const Level2Snapshot = require("../level2-snapshot");
const moment = require("moment");

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a class level comment that points to the documentation and indicates that types of subscriptions that are available to the client?

class GMOCoinClient extends BasicMultiClient {
bmancini55 marked this conversation as resolved.
Show resolved Hide resolved
constructor(options = {}) {
super();
this.options = options;
this.hasTickers = true;
this.hasTrades = true;
this.hasLevel2Snapshots = true;
}

_createBasicClient() {
return new GMOCoinSingleClient({ ...this.options, parent: this });
}
}
class GMOCoinSingleClient extends BasicClient {
constructor({ wssPath = "wss:https://api.coin.z.com/ws/public/v1", watcherMs, parent } = {}) {
super(wssPath, "GMOCoin", undefined, watcherMs);

this.hasTickers = true;
this.hasTrades = true;
this.hasLevel2Snapshots = true;
this.parent = parent;
}

bmancini55 marked this conversation as resolved.
Show resolved Hide resolved
_sendPong(id) {
this._wss.send(JSON.stringify({ pong: id }));
bmancini55 marked this conversation as resolved.
Show resolved Hide resolved
}

_sendSubTicker(remote_id) {
this._wss.send(
bmancini55 marked this conversation as resolved.
Show resolved Hide resolved
JSON.stringify({
command: "subscribe",
bmancini55 marked this conversation as resolved.
Show resolved Hide resolved
channel: "ticker",
symbol: remote_id,
})
);
}

_sendUnsubTicker(remote_id) {
this._wss.send(
JSON.stringify({
command: "unsubscribe",
channel: "ticker",
symbol: remote_id,
})
);
}

_sendSubTrades(remote_id) {
this._wss.send(
JSON.stringify({
command: "subscribe",
channel: "trades",
symbol: remote_id,
// option:'TAKER_ONLY'
})
);
}

_sendUnsubTrades(remote_id) {
this._wss.send(
JSON.stringify({
command: "unsubscribe",
channel: "trades",
symbol: remote_id,
// option:'TAKER_ONLY'
})
);
}

_sendSubLevel2Snapshots(remote_id) {
this._wss.send(
JSON.stringify({
command: "subscribe",
channel: "orderbooks",
symbol: remote_id,
})
);
}

_sendUnsubLevel2Snapshots(remote_id) {
this._wss.send(
JSON.stringify({
command: "unsubscribe",
channel: "orderbooks",
symbol: remote_id,
})
);
}

_onMessage(raw) {
let msg = JSON.parse(raw);

if (msg.ping) {
this._sendPong(msg.ping);
return;
}

// tickers
if (msg.channel === "ticker") {
let market = this._tickerSubs.get(msg.symbol);
if (!market) return;

let ticker = this._constructTicker(msg, market);
this.emit("ticker", ticker, market);
return;
}

// trade
if (msg.channel === "trades") {
let market = this._tradeSubs.get(msg.symbol);
if (!market) return;

let trade = this._constructTrade(msg, market);
this.emit("trade", trade, market);
return;
}

// l2 snapshot
if (msg.channel === "orderbooks") {
let market = this._level2SnapshotSubs.get(msg.symbol);
if (!market) return;

let snapshot = this._constructLevel2Snapshot(msg, market);
this.emit("l2snapshot", snapshot, market);
return;
}
}

_constructTicker(msg, market) {
bmancini55 marked this conversation as resolved.
Show resolved Hide resolved
let { ask, bid, high, last, low, timestamp, volume } = msg;
return new Ticker({
exchange: this._name,
base: market.base,
quote: market.quote,
timestamp: moment.utc(timestamp).valueOf(),
last: last,
high: high,
low: low,
volume: volume,
bid,
ask,
});
}

_constructTrade(datum, market) {
bmancini55 marked this conversation as resolved.
Show resolved Hide resolved
let { price, side, size, timestamp } = datum;
let unix = moment(timestamp).valueOf();
return new Trade({
exchange: this._name,
base: market.base,
quote: market.quote,
side: side.toLowerCase(),
unix,
price: price,
amount: size,
});
}

_constructLevel2Snapshot(msg, market) {
bmancini55 marked this conversation as resolved.
Show resolved Hide resolved
let asks = msg.asks.map(p => new Level2Point(p.price, p.size));
let bids = msg.bids.map(p => new Level2Point(p.price, p.size));
return new Level2Snapshot({
exchange: this._name,
base: market.base,
quote: market.quote,
timestampMs: moment.utc(msg.timestamp).valueOf(),
asks,
bids,
});
}
}
module.exports = GMOCoinClient;
3 changes: 3 additions & 0 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ const ethfinex = require("./exchanges/ethfinex-client");
const ftx = require("./exchanges/ftx-client");
const gateio = require("./exchanges/gateio-client");
const gemini = require("./exchanges/gemini-client");
const gmocoin = require("./exchanges/gmocoin-client");
const hitbtc = require("./exchanges/hitbtc-client");
const huobi = require("./exchanges/huobi-client");
const kucoin = require("./exchanges/kucoin-client");
Expand Down Expand Up @@ -42,6 +43,7 @@ module.exports = {
ftx,
gateio,
gemini,
gmocoin,
hitbtc,
hitbtc2: hitbtc,
huobi,
Expand Down Expand Up @@ -79,6 +81,7 @@ module.exports = {
FtxUs: require("./exchanges/ftx-us-client"),
Gateio: gateio,
Gemini: gemini,
GMOCoin: gmocoin,
HitBTC: hitbtc,
Huobi: huobi,
HuobiFutures: require("./exchanges/huobi-futures-client"),
Expand Down