test_okx_client.py 33 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046
  1. import base64
  2. import hashlib
  3. import hmac
  4. import json as json_module
  5. from dataclasses import dataclass
  6. from urllib.parse import urlencode, urlparse
  7. import pytest
  8. from okx_codex_trader.config import Config
  9. from okx_codex_trader.models import InstrumentMeta, TradeSignal
  10. from okx_codex_trader.okx_client import OkxClient, build_contract_size
  11. @dataclass
  12. class DummyResponse:
  13. payload: dict[str, object]
  14. status_code: int = 200
  15. json_error: Exception | None = None
  16. def json(self) -> dict[str, object]:
  17. if self.json_error is not None:
  18. raise self.json_error
  19. return self.payload
  20. @dataclass
  21. class RecordedRequest:
  22. method: str
  23. url: str
  24. headers: dict[str, str]
  25. params: dict[str, object] | None
  26. json_body: dict[str, object] | None
  27. body: str | None
  28. timeout: float | None
  29. class DummySession:
  30. def __init__(self, responses: list[DummyResponse | Exception] | None = None):
  31. self._responses = list(responses or [])
  32. self.last_request: RecordedRequest | None = None
  33. self.request_paths: list[str] = []
  34. self.request_bodies: list[dict[str, object] | None] = []
  35. @property
  36. def last_json_body(self) -> dict[str, object] | None:
  37. return self.last_request.json_body if self.last_request else None
  38. @property
  39. def last_body(self) -> str | None:
  40. return self.last_request.body if self.last_request else None
  41. def request(
  42. self,
  43. method: str,
  44. url: str,
  45. *,
  46. headers: dict[str, str] | None = None,
  47. params: dict[str, object] | None = None,
  48. json: dict[str, object] | None = None,
  49. data: str | None = None,
  50. timeout: float | None = None,
  51. ) -> DummyResponse:
  52. parsed_json = json
  53. if parsed_json is None and data is not None:
  54. parsed_json = json_module.loads(data)
  55. self.last_request = RecordedRequest(
  56. method=method,
  57. url=url,
  58. headers=headers or {},
  59. params=params,
  60. json_body=parsed_json,
  61. body=data,
  62. timeout=timeout,
  63. )
  64. self.request_paths.append(urlparse(url).path)
  65. self.request_bodies.append(parsed_json)
  66. if self._responses:
  67. response = self._responses.pop(0)
  68. if isinstance(response, Exception):
  69. raise response
  70. return response
  71. return candles_response()
  72. def sample_config() -> Config:
  73. return Config(api_key="key", api_secret="secret", api_passphrase="passphrase")
  74. def candles_response() -> DummyResponse:
  75. return DummyResponse(
  76. {
  77. "code": "0",
  78. "msg": "",
  79. "data": [
  80. ["1710000000000", "25000", "25100", "24900", "25050", "100", "1000", "1000", "1"],
  81. ],
  82. }
  83. )
  84. def descending_candles_response() -> DummyResponse:
  85. return DummyResponse(
  86. {
  87. "code": "0",
  88. "msg": "",
  89. "data": [
  90. ["1710000001000", "25100", "25200", "25000", "25150", "110", "1100", "1100", "1"],
  91. ["1710000000000", "25000", "25100", "24900", "25050", "100", "1000", "1000", "1"],
  92. ],
  93. }
  94. )
  95. def older_candles_response() -> DummyResponse:
  96. return DummyResponse(
  97. {
  98. "code": "0",
  99. "msg": "",
  100. "data": [
  101. ["1709999701000", "24699", "24799", "24649", "24749", "90", "900", "900", "1"],
  102. ["1709999700000", "24698", "24798", "24648", "24748", "80", "800", "800", "1"],
  103. ],
  104. }
  105. )
  106. def full_page_candles_response() -> DummyResponse:
  107. data = []
  108. for offset in range(300):
  109. ts = 1710000001000 - (offset * 1000)
  110. close = 25050 - offset
  111. data.append([str(ts), str(close - 50), str(close + 50), str(close - 100), str(close), "100", "1000", "1000", "1"])
  112. return DummyResponse({"code": "0", "msg": "", "data": data})
  113. def instrument_response(symbol: str = "BTC-USDT-SWAP") -> DummyResponse:
  114. return DummyResponse(
  115. {
  116. "code": "0",
  117. "msg": "",
  118. "data": [
  119. {
  120. "instId": symbol,
  121. "instType": "SWAP",
  122. "ctVal": "0.001",
  123. "lotSz": "1",
  124. "minSz": "1",
  125. }
  126. ],
  127. }
  128. )
  129. def large_min_size_instrument_response() -> DummyResponse:
  130. return DummyResponse(
  131. {
  132. "code": "0",
  133. "msg": "",
  134. "data": [
  135. {
  136. "instId": "BTC-USDT-SWAP",
  137. "instType": "SWAP",
  138. "ctVal": "0.01",
  139. "lotSz": "1",
  140. "minSz": "100",
  141. }
  142. ],
  143. }
  144. )
  145. def ticker_response(last: str) -> DummyResponse:
  146. return DummyResponse({"code": "0", "msg": "", "data": [{"instId": "BTC-USDT-SWAP", "last": last}]})
  147. def account_config_response(pos_mode: str) -> DummyResponse:
  148. return DummyResponse({"code": "0", "msg": "", "data": [{"posMode": pos_mode}]})
  149. def malformed_account_config_response(pos_mode: object) -> DummyResponse:
  150. return DummyResponse({"code": "0", "msg": "", "data": [{"posMode": pos_mode}]})
  151. def leverage_response() -> DummyResponse:
  152. return DummyResponse({"code": "0", "msg": "", "data": [{"lever": "2"}]})
  153. def place_order_response() -> DummyResponse:
  154. return DummyResponse({"code": "0", "msg": "", "data": [{"ordId": "123"}]})
  155. def place_order_response_without_order_id() -> DummyResponse:
  156. return DummyResponse({"code": "0", "msg": "", "data": [{}]})
  157. def error_response(code: str, msg: str) -> DummyResponse:
  158. return DummyResponse({"code": code, "msg": msg, "data": []})
  159. def positions_response() -> DummyResponse:
  160. return DummyResponse(
  161. {
  162. "code": "0",
  163. "msg": "",
  164. "data": [
  165. {
  166. "instId": "BTC-USDT-SWAP",
  167. "posSide": "long",
  168. "pos": "8",
  169. "avgPx": "25000",
  170. }
  171. ],
  172. }
  173. )
  174. def positions_with_zero_size_response() -> DummyResponse:
  175. return DummyResponse(
  176. {
  177. "code": "0",
  178. "msg": "",
  179. "data": [
  180. {
  181. "instId": "BTC-USDT-SWAP",
  182. "posSide": "long",
  183. "pos": "0",
  184. "avgPx": "25000",
  185. },
  186. {
  187. "instId": "BTC-USDT-SWAP",
  188. "posSide": "short",
  189. "pos": "3",
  190. "avgPx": "24900",
  191. },
  192. ],
  193. }
  194. )
  195. def positions_with_zero_size_malformed_avg_price_response() -> DummyResponse:
  196. return DummyResponse(
  197. {
  198. "code": "0",
  199. "msg": "",
  200. "data": [
  201. {
  202. "instId": "BTC-USDT-SWAP",
  203. "posSide": "long",
  204. "pos": "0",
  205. "avgPx": "bad",
  206. },
  207. {
  208. "instId": "BTC-USDT-SWAP",
  209. "posSide": "short",
  210. "pos": "3",
  211. "avgPx": "24900",
  212. },
  213. ],
  214. }
  215. )
  216. def positions_with_non_string_identity_response() -> DummyResponse:
  217. return DummyResponse(
  218. {
  219. "code": "0",
  220. "msg": "",
  221. "data": [
  222. {
  223. "instId": None,
  224. "posSide": ["long"],
  225. "pos": "3",
  226. "avgPx": "24900",
  227. }
  228. ],
  229. }
  230. )
  231. def candles_with_non_finite_numeric_response() -> DummyResponse:
  232. return DummyResponse(
  233. {
  234. "code": "0",
  235. "msg": "",
  236. "data": [
  237. ["1710000000000", "NaN", "25100", "24900", "25050", "100", "1000", "1000", "1"],
  238. ],
  239. }
  240. )
  241. def instrument_with_non_finite_numeric_response() -> DummyResponse:
  242. return DummyResponse(
  243. {
  244. "code": "0",
  245. "msg": "",
  246. "data": [
  247. {
  248. "instId": "BTC-USDT-SWAP",
  249. "instType": "SWAP",
  250. "ctVal": "NaN",
  251. "lotSz": "1",
  252. "minSz": "1",
  253. }
  254. ],
  255. }
  256. )
  257. def instrument_with_wrong_symbol_response() -> DummyResponse:
  258. return DummyResponse(
  259. {
  260. "code": "0",
  261. "msg": "",
  262. "data": [
  263. {
  264. "instId": "ETH-USDT-SWAP",
  265. "instType": "SWAP",
  266. "ctVal": "0.001",
  267. "lotSz": "1",
  268. "minSz": "1",
  269. }
  270. ],
  271. }
  272. )
  273. def instrument_with_wrong_type_response() -> DummyResponse:
  274. return DummyResponse(
  275. {
  276. "code": "0",
  277. "msg": "",
  278. "data": [
  279. {
  280. "instId": "BTC-USDT-SWAP",
  281. "instType": "FUTURES",
  282. "ctVal": "0.001",
  283. "lotSz": "1",
  284. "minSz": "1",
  285. }
  286. ],
  287. }
  288. )
  289. def ticker_with_non_finite_numeric_response() -> DummyResponse:
  290. return DummyResponse({"code": "0", "msg": "", "data": [{"instId": "BTC-USDT-SWAP", "last": "Infinity"}]})
  291. def positions_with_non_finite_numeric_response() -> DummyResponse:
  292. return DummyResponse(
  293. {
  294. "code": "0",
  295. "msg": "",
  296. "data": [
  297. {
  298. "instId": "BTC-USDT-SWAP",
  299. "posSide": "long",
  300. "pos": "1",
  301. "avgPx": "NaN",
  302. }
  303. ],
  304. }
  305. )
  306. def positions_with_wrong_symbol_response() -> DummyResponse:
  307. return DummyResponse(
  308. {
  309. "code": "0",
  310. "msg": "",
  311. "data": [
  312. {
  313. "instId": "ETH-USDT-SWAP",
  314. "posSide": "long",
  315. "pos": "1",
  316. "avgPx": "25000",
  317. }
  318. ],
  319. }
  320. )
  321. def positions_with_invalid_pos_side_response() -> DummyResponse:
  322. return DummyResponse(
  323. {
  324. "code": "0",
  325. "msg": "",
  326. "data": [
  327. {
  328. "instId": "BTC-USDT-SWAP",
  329. "posSide": "net",
  330. "pos": "1",
  331. "avgPx": "25000",
  332. }
  333. ],
  334. }
  335. )
  336. def market_long_signal() -> TradeSignal:
  337. return TradeSignal(
  338. action="long",
  339. confidence=0.9,
  340. leverage=2,
  341. entry_price=None,
  342. take_profit_price=26000.0,
  343. stop_loss_price=24000.0,
  344. reason="trend",
  345. )
  346. def limit_short_signal() -> TradeSignal:
  347. return TradeSignal(
  348. action="short",
  349. confidence=0.8,
  350. leverage=2,
  351. entry_price=25000.0,
  352. take_profit_price=24000.0,
  353. stop_loss_price=25500.0,
  354. reason="mean reversion",
  355. )
  356. def flat_signal() -> TradeSignal:
  357. return TradeSignal(
  358. action="flat",
  359. confidence=0.7,
  360. leverage=2,
  361. entry_price=None,
  362. take_profit_price=None,
  363. stop_loss_price=None,
  364. reason="exit",
  365. )
  366. def test_signed_demo_request_attaches_headers():
  367. session = DummySession()
  368. client = OkxClient(config=sample_config(), session=session)
  369. client.get_candles(symbol="BTC-USDT-SWAP", bar="1H", limit=20)
  370. request = session.last_request
  371. assert request is not None
  372. assert request.headers["x-simulated-trading"] == "1"
  373. assert request.headers["OK-ACCESS-KEY"] == "key"
  374. assert request.headers["OK-ACCESS-PASSPHRASE"] == "passphrase"
  375. timestamp = request.headers["OK-ACCESS-TIMESTAMP"]
  376. path = urlparse(request.url).path
  377. query = urlencode(request.params or {})
  378. path_with_query = path if not query else f"{path}?{query}"
  379. expected_signature = base64.b64encode(
  380. hmac.new(
  381. b"secret",
  382. f"{timestamp}{request.method}{path_with_query}".encode(),
  383. hashlib.sha256,
  384. ).digest()
  385. ).decode()
  386. assert request.headers["OK-ACCESS-SIGN"] == expected_signature
  387. assert request.timeout is not None
  388. assert request.timeout > 0
  389. def test_signed_post_request_uses_actual_serialized_body_bytes():
  390. session = DummySession(
  391. [
  392. account_config_response(pos_mode="long_short_mode"),
  393. instrument_response(symbol="ETH-USDT-SWAP"),
  394. leverage_response(),
  395. place_order_response(),
  396. ]
  397. )
  398. client = OkxClient(config=sample_config(), session=session)
  399. client.place_demo_order(symbol="ETH-USDT-SWAP", signal=limit_short_signal(), margin_usdt=100)
  400. request = session.last_request
  401. assert request is not None
  402. assert request.method == "POST"
  403. assert request.body is not None
  404. timestamp = request.headers["OK-ACCESS-TIMESTAMP"]
  405. path = urlparse(request.url).path
  406. expected_signature = base64.b64encode(
  407. hmac.new(
  408. b"secret",
  409. f"{timestamp}{request.method}{path}{request.body}".encode(),
  410. hashlib.sha256,
  411. ).digest()
  412. ).decode()
  413. assert request.headers["OK-ACCESS-SIGN"] == expected_signature
  414. def test_get_candles_returns_chronological_ascending_order():
  415. session = DummySession([descending_candles_response()])
  416. client = OkxClient(config=sample_config(), session=session)
  417. candles = client.get_candles(symbol="BTC-USDT-SWAP", bar="1H", limit=20)
  418. assert [candle.ts for candle in candles] == [1710000000000, 1710000001000]
  419. def test_get_candles_ignores_unconfirmed_history_rows():
  420. session = DummySession(
  421. [
  422. DummyResponse(
  423. {
  424. "code": "0",
  425. "msg": "",
  426. "data": [
  427. ["1710000001000", "25100", "25200", "25000", "25150", "110", "1100", "1100", "0"],
  428. ["1710000000000", "25000", "25100", "24900", "25050", "100", "1000", "1000", "1"],
  429. ],
  430. }
  431. )
  432. ]
  433. )
  434. client = OkxClient(config=sample_config(), session=session)
  435. candles = client.get_candles(symbol="BTC-USDT-SWAP", bar="1H", limit=20)
  436. assert [candle.ts for candle in candles] == [1710000000000]
  437. def test_get_candles_paginates_when_limit_exceeds_single_page():
  438. session = DummySession([full_page_candles_response(), older_candles_response()])
  439. client = OkxClient(config=sample_config(), session=session)
  440. candles = client.get_candles(symbol="BTC-USDT-SWAP", bar="1H", limit=302)
  441. assert len(candles) == 302
  442. assert candles[0].ts == 1709999700000
  443. assert candles[1].ts == 1709999701000
  444. assert len(session.request_paths) == 2
  445. def test_build_contract_size_rounds_down_to_lot_size():
  446. metadata = InstrumentMeta(ct_val=0.01, lot_sz=0.1, min_sz=0.1)
  447. assert build_contract_size(notional=251, price=25_000, metadata=metadata) == 1.0
  448. def test_build_contract_size_fails_below_min_size():
  449. metadata = InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=5)
  450. with pytest.raises(ValueError):
  451. build_contract_size(notional=250, price=25_100, metadata=metadata)
  452. @pytest.mark.parametrize("notional", [0, -1, float("nan"), float("inf")])
  453. def test_build_contract_size_rejects_invalid_notional(notional):
  454. metadata = InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=1)
  455. with pytest.raises(ValueError, match="contract sizing inputs are invalid"):
  456. build_contract_size(notional=notional, price=25_000, metadata=metadata)
  457. def test_build_contract_size_rejects_boolean_inputs():
  458. metadata = InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=1)
  459. with pytest.raises(ValueError, match="contract sizing inputs are invalid"):
  460. build_contract_size(notional=True, price=25_000, metadata=metadata)
  461. with pytest.raises(ValueError, match="contract sizing inputs are invalid"):
  462. build_contract_size(notional=100, price=False, metadata=metadata)
  463. with pytest.raises(ValueError, match="contract sizing inputs are invalid"):
  464. build_contract_size(notional=100, price=25_000, metadata=InstrumentMeta(ct_val=True, lot_sz=1, min_sz=1))
  465. @pytest.mark.parametrize(
  466. ("price", "metadata"),
  467. [
  468. (0, InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=1)),
  469. (-1, InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=1)),
  470. (25_000, InstrumentMeta(ct_val=0, lot_sz=1, min_sz=1)),
  471. (25_000, InstrumentMeta(ct_val=-0.01, lot_sz=1, min_sz=1)),
  472. (25_000, InstrumentMeta(ct_val=0.01, lot_sz=0, min_sz=1)),
  473. (25_000, InstrumentMeta(ct_val=0.01, lot_sz=-1, min_sz=1)),
  474. (25_000, InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=0)),
  475. (25_000, InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=-1)),
  476. ],
  477. )
  478. def test_build_contract_size_rejects_non_positive_inputs(price, metadata):
  479. with pytest.raises(ValueError, match="contract sizing inputs are invalid"):
  480. build_contract_size(notional=250, price=price, metadata=metadata)
  481. @pytest.mark.parametrize(
  482. ("price", "metadata"),
  483. [
  484. (float("nan"), InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=1)),
  485. (float("inf"), InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=1)),
  486. (25_000, InstrumentMeta(ct_val=float("nan"), lot_sz=1, min_sz=1)),
  487. (25_000, InstrumentMeta(ct_val=0.01, lot_sz=float("inf"), min_sz=1)),
  488. (25_000, InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=float("-inf"))),
  489. ],
  490. )
  491. def test_build_contract_size_rejects_non_finite_inputs(price, metadata):
  492. with pytest.raises(ValueError, match="contract sizing inputs are invalid"):
  493. build_contract_size(notional=250, price=price, metadata=metadata)
  494. def test_market_order_fetches_latest_price_before_sizing():
  495. session = DummySession(
  496. [
  497. account_config_response(pos_mode="long_short_mode"),
  498. instrument_response(),
  499. ticker_response(last="25000"),
  500. leverage_response(),
  501. place_order_response(),
  502. ]
  503. )
  504. client = OkxClient(config=sample_config(), session=session)
  505. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=market_long_signal(), margin_usdt=100)
  506. assert session.request_paths == [
  507. "/api/v5/account/config",
  508. "/api/v5/public/instruments",
  509. "/api/v5/market/ticker",
  510. "/api/v5/account/set-leverage",
  511. "/api/v5/trade/order",
  512. ]
  513. def test_fractional_margin_sizing_keeps_decimal_precision():
  514. session = DummySession(
  515. [
  516. account_config_response(pos_mode="long_short_mode"),
  517. instrument_response(),
  518. ticker_response(last="1"),
  519. leverage_response(),
  520. place_order_response(),
  521. ]
  522. )
  523. signal = TradeSignal(
  524. action="long",
  525. confidence=0.9,
  526. leverage=3,
  527. entry_price=None,
  528. take_profit_price=None,
  529. stop_loss_price=None,
  530. reason="x",
  531. )
  532. client = OkxClient(config=sample_config(), session=session)
  533. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=signal, margin_usdt=0.009)
  534. assert session.last_json_body is not None
  535. assert session.last_json_body["sz"] == "27"
  536. def test_place_demo_order_fails_when_not_hedge_mode():
  537. session = DummySession(
  538. [
  539. account_config_response(pos_mode="net_mode"),
  540. ]
  541. )
  542. client = OkxClient(config=sample_config(), session=session)
  543. with pytest.raises(ValueError):
  544. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=market_long_signal(), margin_usdt=100)
  545. assert session.request_paths == ["/api/v5/account/config"]
  546. def test_ensure_hedge_mode_rejects_malformed_config_payload():
  547. session = DummySession([malformed_account_config_response(pos_mode=None)])
  548. client = OkxClient(config=sample_config(), session=session)
  549. with pytest.raises(ValueError, match="okx response payload is invalid"):
  550. client.ensure_hedge_mode()
  551. def test_place_demo_order_validates_size_before_setting_leverage():
  552. session = DummySession(
  553. [
  554. account_config_response(pos_mode="long_short_mode"),
  555. large_min_size_instrument_response(),
  556. ticker_response(last="25000"),
  557. ]
  558. )
  559. client = OkxClient(config=sample_config(), session=session)
  560. with pytest.raises(ValueError, match="contract size below minimum"):
  561. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=market_long_signal(), margin_usdt=100)
  562. assert session.request_paths == [
  563. "/api/v5/account/config",
  564. "/api/v5/public/instruments",
  565. "/api/v5/market/ticker",
  566. ]
  567. def test_limit_short_order_uses_sell_and_short_pos_side():
  568. session = DummySession(
  569. [
  570. account_config_response(pos_mode="long_short_mode"),
  571. instrument_response(symbol="ETH-USDT-SWAP"),
  572. leverage_response(),
  573. place_order_response(),
  574. ]
  575. )
  576. client = OkxClient(config=sample_config(), session=session)
  577. client.place_demo_order(symbol="ETH-USDT-SWAP", signal=limit_short_signal(), margin_usdt=100)
  578. order_request = session.last_json_body
  579. assert order_request is not None
  580. assert order_request["ordType"] == "limit"
  581. assert order_request["side"] == "sell"
  582. assert order_request["posSide"] == "short"
  583. assert order_request["px"] == "25000"
  584. assert session.request_bodies[2]["lever"] == "2"
  585. assert session.request_bodies[2]["mgnMode"] == "isolated"
  586. def test_flat_signal_returns_noop_without_order_submission():
  587. session = DummySession([])
  588. client = OkxClient(config=sample_config(), session=session)
  589. result = client.place_demo_order(symbol="BTC-USDT-SWAP", signal=flat_signal(), margin_usdt=100)
  590. assert result.status == "noop"
  591. assert session.request_paths == []
  592. def test_place_demo_order_sends_computed_sz_and_ignores_tp_sl_fields():
  593. session = DummySession(
  594. [
  595. account_config_response(pos_mode="long_short_mode"),
  596. instrument_response(),
  597. ticker_response(last="25000"),
  598. leverage_response(),
  599. place_order_response(),
  600. ]
  601. )
  602. client = OkxClient(config=sample_config(), session=session)
  603. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=market_long_signal(), margin_usdt=100)
  604. order_request = session.last_json_body
  605. assert order_request is not None
  606. assert order_request["sz"] == "8"
  607. assert "tpTriggerPx" not in order_request
  608. assert "slTriggerPx" not in order_request
  609. def test_okx_error_payload_raises_value_error():
  610. session = DummySession([error_response(code="51000", msg="parameter error")])
  611. client = OkxClient(config=sample_config(), session=session)
  612. with pytest.raises(ValueError):
  613. client.get_candles(symbol="BTC-USDT-SWAP", bar="1H", limit=20)
  614. def test_get_candles_rejects_non_finite_numeric_fields():
  615. session = DummySession([candles_with_non_finite_numeric_response()])
  616. client = OkxClient(config=sample_config(), session=session)
  617. with pytest.raises(ValueError, match="okx response payload is invalid"):
  618. client.get_candles(symbol="BTC-USDT-SWAP", bar="1H", limit=20)
  619. def test_transport_failure_raises_stable_value_error():
  620. session = DummySession([RuntimeError("socket closed")])
  621. client = OkxClient(config=sample_config(), session=session)
  622. with pytest.raises(ValueError, match="okx transport error"):
  623. client.get_candles(symbol="BTC-USDT-SWAP", bar="1H", limit=20)
  624. def test_invalid_json_raises_stable_value_error():
  625. session = DummySession([DummyResponse({}, json_error=ValueError("bad json"))])
  626. client = OkxClient(config=sample_config(), session=session)
  627. with pytest.raises(ValueError, match="okx response payload is invalid"):
  628. client.get_candles(symbol="BTC-USDT-SWAP", bar="1H", limit=20)
  629. def test_empty_positions_data_returns_empty_list():
  630. session = DummySession([DummyResponse({"code": "0", "msg": "", "data": []})])
  631. client = OkxClient(config=sample_config(), session=session)
  632. assert client.get_positions(symbol="BTC-USDT-SWAP") == []
  633. def test_malformed_numeric_field_raises_stable_value_error():
  634. session = DummySession(
  635. [
  636. DummyResponse(
  637. {
  638. "code": "0",
  639. "msg": "",
  640. "data": [
  641. {
  642. "instId": "BTC-USDT-SWAP",
  643. "posSide": "long",
  644. "pos": "bad",
  645. "avgPx": "25000",
  646. }
  647. ],
  648. }
  649. )
  650. ]
  651. )
  652. client = OkxClient(config=sample_config(), session=session)
  653. with pytest.raises(ValueError, match="okx response payload is invalid"):
  654. client.get_positions(symbol="BTC-USDT-SWAP")
  655. def test_non_list_okx_data_raises_stable_value_error():
  656. session = DummySession([DummyResponse({"code": "0", "msg": "", "data": {}})])
  657. client = OkxClient(config=sample_config(), session=session)
  658. with pytest.raises(ValueError, match="okx response payload is invalid"):
  659. client.get_positions(symbol="BTC-USDT-SWAP")
  660. def test_get_instrument_meta_rejects_non_finite_numeric_fields():
  661. session = DummySession([instrument_with_non_finite_numeric_response()])
  662. client = OkxClient(config=sample_config(), session=session)
  663. with pytest.raises(ValueError, match="okx response payload is invalid"):
  664. client.get_instrument_meta(symbol="BTC-USDT-SWAP")
  665. def test_get_last_price_rejects_non_finite_numeric_field():
  666. session = DummySession([ticker_with_non_finite_numeric_response()])
  667. client = OkxClient(config=sample_config(), session=session)
  668. with pytest.raises(ValueError, match="okx response payload is invalid"):
  669. client.get_last_price(symbol="BTC-USDT-SWAP")
  670. def test_get_last_price_rejects_mismatched_symbol():
  671. session = DummySession([DummyResponse({"code": "0", "msg": "", "data": [{"instId": "ETH-USDT-SWAP", "last": "25000"}]})])
  672. client = OkxClient(config=sample_config(), session=session)
  673. with pytest.raises(ValueError, match="okx response payload is invalid"):
  674. client.get_last_price(symbol="BTC-USDT-SWAP")
  675. def test_get_instrument_meta_rejects_mismatched_symbol():
  676. session = DummySession([instrument_with_wrong_symbol_response()])
  677. client = OkxClient(config=sample_config(), session=session)
  678. with pytest.raises(ValueError, match="okx response payload is invalid"):
  679. client.get_instrument_meta(symbol="BTC-USDT-SWAP")
  680. def test_get_instrument_meta_rejects_non_swap_type():
  681. session = DummySession([instrument_with_wrong_type_response()])
  682. client = OkxClient(config=sample_config(), session=session)
  683. with pytest.raises(ValueError, match="okx response payload is invalid"):
  684. client.get_instrument_meta(symbol="BTC-USDT-SWAP")
  685. def test_place_demo_order_raises_when_order_id_is_missing():
  686. session = DummySession(
  687. [
  688. account_config_response(pos_mode="long_short_mode"),
  689. instrument_response(),
  690. ticker_response(last="25000"),
  691. leverage_response(),
  692. place_order_response_without_order_id(),
  693. ]
  694. )
  695. client = OkxClient(config=sample_config(), session=session)
  696. with pytest.raises(ValueError, match="okx response payload is invalid"):
  697. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=market_long_signal(), margin_usdt=100)
  698. assert session.request_paths[-1] == "/api/v5/trade/order"
  699. def test_place_demo_order_rejects_invalid_leverage_before_okx():
  700. session = DummySession([])
  701. signal = TradeSignal(
  702. action="long",
  703. confidence=0.9,
  704. leverage=4,
  705. entry_price=None,
  706. take_profit_price=None,
  707. stop_loss_price=None,
  708. reason="x",
  709. )
  710. client = OkxClient(config=sample_config(), session=session)
  711. with pytest.raises(ValueError, match="leverage is invalid"):
  712. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=signal, margin_usdt=100)
  713. assert session.request_paths == []
  714. def test_place_demo_order_rejects_fractional_leverage_before_okx():
  715. session = DummySession([])
  716. signal = TradeSignal(
  717. action="long",
  718. confidence=0.9,
  719. leverage=2.5,
  720. entry_price=None,
  721. take_profit_price=None,
  722. stop_loss_price=None,
  723. reason="x",
  724. )
  725. client = OkxClient(config=sample_config(), session=session)
  726. with pytest.raises(ValueError, match="leverage is invalid"):
  727. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=signal, margin_usdt=100)
  728. assert session.request_paths == []
  729. def test_place_demo_order_rejects_boolean_leverage_before_okx():
  730. session = DummySession([])
  731. signal = TradeSignal(
  732. action="long",
  733. confidence=0.9,
  734. leverage=True,
  735. entry_price=None,
  736. take_profit_price=None,
  737. stop_loss_price=None,
  738. reason="x",
  739. )
  740. client = OkxClient(config=sample_config(), session=session)
  741. with pytest.raises(ValueError, match="leverage is invalid"):
  742. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=signal, margin_usdt=100)
  743. assert session.request_paths == []
  744. @pytest.mark.parametrize("margin_usdt", [0, -1, float("nan"), float("inf")])
  745. def test_place_demo_order_rejects_invalid_margin_before_okx(margin_usdt):
  746. session = DummySession([])
  747. client = OkxClient(config=sample_config(), session=session)
  748. with pytest.raises(ValueError, match="margin_usdt is invalid"):
  749. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=market_long_signal(), margin_usdt=margin_usdt)
  750. assert session.request_paths == []
  751. def test_place_demo_order_rejects_boolean_margin_before_okx():
  752. session = DummySession([])
  753. client = OkxClient(config=sample_config(), session=session)
  754. with pytest.raises(ValueError, match="margin_usdt is invalid"):
  755. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=market_long_signal(), margin_usdt=True)
  756. assert session.request_paths == []
  757. @pytest.mark.parametrize(
  758. ("symbol", "leverage", "pos_side", "expected_message"),
  759. [
  760. ("BTC-USDT", 2, "long", "swap instrument is required"),
  761. ("BTC-USDT-SWAP", 4, "long", "leverage is invalid"),
  762. ("BTC-USDT-SWAP", 2.5, "long", "leverage is invalid"),
  763. ("BTC-USDT-SWAP", 2, "net", "pos_side is invalid"),
  764. ],
  765. )
  766. def test_set_leverage_validates_public_boundary_inputs(symbol, leverage, pos_side, expected_message):
  767. session = DummySession([])
  768. client = OkxClient(config=sample_config(), session=session)
  769. with pytest.raises(ValueError, match=expected_message):
  770. client.set_leverage(symbol=symbol, leverage=leverage, pos_side=pos_side)
  771. assert session.request_paths == []
  772. def test_place_demo_order_rejects_unknown_action_before_okx():
  773. session = DummySession([])
  774. signal = TradeSignal(
  775. action="hold",
  776. confidence=0.9,
  777. leverage=2,
  778. entry_price=None,
  779. take_profit_price=None,
  780. stop_loss_price=None,
  781. reason="x",
  782. )
  783. client = OkxClient(config=sample_config(), session=session)
  784. with pytest.raises(ValueError, match="action is invalid"):
  785. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=signal, margin_usdt=100)
  786. assert session.request_paths == []
  787. def test_get_positions_returns_normalized_positions():
  788. session = DummySession([positions_response()])
  789. client = OkxClient(config=sample_config(), session=session)
  790. positions = client.get_positions(symbol="BTC-USDT-SWAP")
  791. assert positions[0].symbol == "BTC-USDT-SWAP"
  792. assert positions[0].pos_side == "long"
  793. assert positions[0].size == 8.0
  794. assert positions[0].avg_price == 25000.0
  795. def test_get_positions_filters_zero_size_rows():
  796. session = DummySession([positions_with_zero_size_response()])
  797. client = OkxClient(config=sample_config(), session=session)
  798. positions = client.get_positions(symbol="BTC-USDT-SWAP")
  799. assert len(positions) == 1
  800. assert positions[0].pos_side == "short"
  801. assert positions[0].size == 3.0
  802. def test_get_positions_ignores_malformed_fields_on_zero_size_rows():
  803. session = DummySession([positions_with_zero_size_malformed_avg_price_response()])
  804. client = OkxClient(config=sample_config(), session=session)
  805. positions = client.get_positions(symbol="BTC-USDT-SWAP")
  806. assert len(positions) == 1
  807. assert positions[0].pos_side == "short"
  808. assert positions[0].avg_price == 24900.0
  809. def test_get_positions_rejects_non_string_inst_id_and_pos_side():
  810. session = DummySession([positions_with_non_string_identity_response()])
  811. client = OkxClient(config=sample_config(), session=session)
  812. with pytest.raises(ValueError, match="okx response payload is invalid"):
  813. client.get_positions(symbol="BTC-USDT-SWAP")
  814. def test_get_positions_rejects_non_finite_numeric_fields():
  815. session = DummySession([positions_with_non_finite_numeric_response()])
  816. client = OkxClient(config=sample_config(), session=session)
  817. with pytest.raises(ValueError, match="okx response payload is invalid"):
  818. client.get_positions(symbol="BTC-USDT-SWAP")
  819. def test_get_positions_rejects_mismatched_symbol():
  820. session = DummySession([positions_with_wrong_symbol_response()])
  821. client = OkxClient(config=sample_config(), session=session)
  822. with pytest.raises(ValueError, match="okx response payload is invalid"):
  823. client.get_positions(symbol="BTC-USDT-SWAP")
  824. def test_get_positions_rejects_invalid_pos_side():
  825. session = DummySession([positions_with_invalid_pos_side_response()])
  826. client = OkxClient(config=sample_config(), session=session)
  827. with pytest.raises(ValueError, match="okx response payload is invalid"):
  828. client.get_positions(symbol="BTC-USDT-SWAP")