GMO コイン用の DataStore を一部実装する

[supermomonga]

related: #60

---

• Public WebSocket
  • 最新レート
  • 板情報
  • 取引履歴
• Private WebSocket
  • 約定
  • 注文
  • ポジション
  • ポジションサマリー

---

• できるだけエディタの支援を効かせるため、積極的に型を書いています。
  • 値の一覧が既知のプロパティについては列挙型を定義しています。（レファレンス > パラメータ など）
  • 各データは TypedDict として実装してあります。独自クラスではなく TypedDict 型を採用した理由は、現状データストアが取り扱うデータの型が Dict[str, Any] である Item であるため、既存データストアの実装を変更せずに互換性を持たせられるためです。（データの出し入れ時に Item 型との cast をしています）
• GMO コインは REST API と WebSocket API で同じ種類のデータについても返却データの型が一致していないため、片方にしか存在しないプロパティは Optional 型になっています。

[supermomonga]

自分がシストレで利用したいデータについて実装したものですので、現状 Public WebSocket の 「最新レート」「取引履歴」は未実装です。こちらは時間が取れた際に実装する気持ちはありますが、いつになるかわからないためひとまず現状できている部分で Pull Request を立てました。

[supermomonga]

注文情報について

Private WebSocket の注文情報通知チャンネルではなぜか注文がキャンセルされたことは検知できても約定したことは検知できない仕様になっているため（なぜそんな仕様に…？）、約定情報通知チャンネルのデータも用いて注文情報の更新・削除を行っています。

• https://github.com/MtkN1/pybotters/blob/3a60703feb5b7603289412fdea815ac47eb388fc/pybotters/models/gmocoin.py#L584-L587
• https://github.com/MtkN1/pybotters/blob/3a60703feb5b7603289412fdea815ac47eb388fc/pybotters/models/gmocoin.py#L328-L341

[MtkN1]

素晴らしい完成度のコードですね。本当にありがとうございます。
理解を進めているところですので数日お待ちください。

[MtkN1]

クラス設計の理解

• Enum 継承クラス
  • ApiType, Channel, MessageType, Symbol, OrderSide, ExecutionType, TimeInForce, SettleType, OrderType, OrderStatus, CancelType
  • リファレンスの既知のプロパティに基づいた列挙型
  • TypedDict の型に使ったり、WebSocketデータについてのif条件に使う
• TypedDict 継承クラス (dataclassデコレータ)
  • Ticker, OrderLevel, OrderBook, Trade, Execution, Order, Position, PositionSummary
  • DataStore の Item に対する TypedDict 型
• DataStore 継承クラス
  • OrderBookStore, OrderStore, ExecutionStore, PositionStore, PositionSummaryStore
  • 従来のストアクラス
  • データ挿入の際はcastを行っている
• MessageHelper クラス
  • スタティックメソッド to_xxxxx で Item を TypedDict に変換するヘルパークラス
  • initializeやonmessage内で利用
• DataStoreInterface 継承クラス
  • 従来のストアインターフェースクラス

[supermomonga]

MessageHelper の static メソッドは本当は各データ型自身（Order, Execution など）に持たせたかったのですが、 TypedDict している関係で（実態は単なる辞書なので）ヘルパークラスに外だしせざるを得ませんでした。もっと良い方法があればいいのですが…

[MtkN1]

@supermomonga
確認・テストを行いました。
いくつかSuggestionを出していますが、動かない箇所もあったので修正コードを書いてあります。
Suggestion内容に問題なければ修正コードをこちらでコミットしようかと思います。(Decimalの修正量が多かったので)

[MtkN1]

もう一点追記します。

[MtkN1]

テストコード

import asyncio

import pybotters
from rich.console import Console

console = Console()


async def main():
    async with pybotters.Client(base_url='https://api.coin.z.com') as client:
        # test for public websocket(板情報を1度表示する)
        store = pybotters.GMOCoinDataStore()
        console.rule('public')
        wstask = await client.ws_connect(
            'wss://api.coin.z.com/ws/public/v1',
            send_json={'command': 'subscribe', 'channel': 'orderbooks', 'symbol': 'XRP_JPY'},
            hdlr_json=store.onmessage,
        )
        while not len(store.orderbooks):
            await store.orderbooks.wait()
        console.print(store.orderbooks.sorted())

        # test for initialize
        store = pybotters.GMOCoinDataStore()
        await store.initialize(
            client.get('/private/v1/latestExecutions?symbol=XRP_JPY'),
            client.get('/private/v1/activeOrders?symbol=XRP_JPY'),
            client.get('/private/v1/openPositions?symbol=XRP_JPY'),
            client.get('/private/v1/positionSummary?symbol=XRP_JPY'),
        )
        console.rule('initialize')
        console.print(
            {
                'executions': store.executions.find(),
                'orders': store.orders.find(),
                'positions': store.positions.find(),
                'position_summary': store.position_summary.find(),
            }
        )

        # test for private websocket(無限ループ、Web画面で取引して確認する)
        console.rule('private')
        r = await client.post('/private/v1/ws-auth')
        data = await r.json()
        token = data['data']
        wstask = await client.ws_connect(
            f'wss://api.coin.z.com/ws/private/v1/{token}',
            send_json=[
                {'command': 'subscribe', 'channel': 'executionEvents'},
                {'command': 'subscribe', 'channel': 'orderEvents'},
                {'command': 'subscribe', 'channel': 'positionEvents'},
                {'command': 'subscribe', 'channel': 'positionSummaryEvents'},
            ],
            hdlr_json=store.onmessage,
        )
        while True:
            console.print(
                {
                    'executions': store.executions.find(),
                    'orders': store.orders.find(),
                    'positions': store.positions.find(),
                    'position_summary': store.position_summary.find(),
                }
            )
            await store.wait()


try:
    asyncio.run(main())
except KeyboardInterrupt:
    pass

[supermomonga]

@MtkN1

確認・テストを行いました。
いくつかSuggestionを出していますが、動かない箇所もあったので修正コードを書いてあります。
Suggestion内容に問題なければ修正コードをこちらでコミットしようかと思います。(Decimalの修正量が多かったので)

レビューありがとうございます！
Suggestion の件、一部こちらでコミットしてしまった部分があるので、それ以外の部分の追加をお願いできればと思います🙏

[supermomonga]

また、 _onmessage などが非同期になってたりなってなかったりで統一できてない部分に気づいたのでどちらかに寄せて頂ければ… 🙇

[MtkN1]

直接コミットしました。 しっかり動作してますね！
特に異議なければMergeさせて頂きます。

[supermomonga]

あ、すみません通知見落としてました。大丈夫だと思います！