test_okx_client.py 33 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024
  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_paginates_when_limit_exceeds_single_page():
  420. session = DummySession([full_page_candles_response(), older_candles_response()])
  421. client = OkxClient(config=sample_config(), session=session)
  422. candles = client.get_candles(symbol="BTC-USDT-SWAP", bar="1H", limit=302)
  423. assert len(candles) == 302
  424. assert candles[0].ts == 1709999700000
  425. assert candles[1].ts == 1709999701000
  426. assert len(session.request_paths) == 2
  427. def test_build_contract_size_rounds_down_to_lot_size():
  428. metadata = InstrumentMeta(ct_val=0.01, lot_sz=0.1, min_sz=0.1)
  429. assert build_contract_size(notional=251, price=25_000, metadata=metadata) == 1.0
  430. def test_build_contract_size_fails_below_min_size():
  431. metadata = InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=5)
  432. with pytest.raises(ValueError):
  433. build_contract_size(notional=250, price=25_100, metadata=metadata)
  434. @pytest.mark.parametrize("notional", [0, -1, float("nan"), float("inf")])
  435. def test_build_contract_size_rejects_invalid_notional(notional):
  436. metadata = InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=1)
  437. with pytest.raises(ValueError, match="contract sizing inputs are invalid"):
  438. build_contract_size(notional=notional, price=25_000, metadata=metadata)
  439. def test_build_contract_size_rejects_boolean_inputs():
  440. metadata = InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=1)
  441. with pytest.raises(ValueError, match="contract sizing inputs are invalid"):
  442. build_contract_size(notional=True, price=25_000, metadata=metadata)
  443. with pytest.raises(ValueError, match="contract sizing inputs are invalid"):
  444. build_contract_size(notional=100, price=False, metadata=metadata)
  445. with pytest.raises(ValueError, match="contract sizing inputs are invalid"):
  446. build_contract_size(notional=100, price=25_000, metadata=InstrumentMeta(ct_val=True, lot_sz=1, min_sz=1))
  447. @pytest.mark.parametrize(
  448. ("price", "metadata"),
  449. [
  450. (0, InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=1)),
  451. (-1, InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=1)),
  452. (25_000, InstrumentMeta(ct_val=0, lot_sz=1, min_sz=1)),
  453. (25_000, InstrumentMeta(ct_val=-0.01, lot_sz=1, min_sz=1)),
  454. (25_000, InstrumentMeta(ct_val=0.01, lot_sz=0, min_sz=1)),
  455. (25_000, InstrumentMeta(ct_val=0.01, lot_sz=-1, min_sz=1)),
  456. (25_000, InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=0)),
  457. (25_000, InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=-1)),
  458. ],
  459. )
  460. def test_build_contract_size_rejects_non_positive_inputs(price, metadata):
  461. with pytest.raises(ValueError, match="contract sizing inputs are invalid"):
  462. build_contract_size(notional=250, price=price, metadata=metadata)
  463. @pytest.mark.parametrize(
  464. ("price", "metadata"),
  465. [
  466. (float("nan"), InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=1)),
  467. (float("inf"), InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=1)),
  468. (25_000, InstrumentMeta(ct_val=float("nan"), lot_sz=1, min_sz=1)),
  469. (25_000, InstrumentMeta(ct_val=0.01, lot_sz=float("inf"), min_sz=1)),
  470. (25_000, InstrumentMeta(ct_val=0.01, lot_sz=1, min_sz=float("-inf"))),
  471. ],
  472. )
  473. def test_build_contract_size_rejects_non_finite_inputs(price, metadata):
  474. with pytest.raises(ValueError, match="contract sizing inputs are invalid"):
  475. build_contract_size(notional=250, price=price, metadata=metadata)
  476. def test_market_order_fetches_latest_price_before_sizing():
  477. session = DummySession(
  478. [
  479. account_config_response(pos_mode="long_short_mode"),
  480. instrument_response(),
  481. ticker_response(last="25000"),
  482. leverage_response(),
  483. place_order_response(),
  484. ]
  485. )
  486. client = OkxClient(config=sample_config(), session=session)
  487. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=market_long_signal(), margin_usdt=100)
  488. assert session.request_paths == [
  489. "/api/v5/account/config",
  490. "/api/v5/public/instruments",
  491. "/api/v5/market/ticker",
  492. "/api/v5/account/set-leverage",
  493. "/api/v5/trade/order",
  494. ]
  495. def test_fractional_margin_sizing_keeps_decimal_precision():
  496. session = DummySession(
  497. [
  498. account_config_response(pos_mode="long_short_mode"),
  499. instrument_response(),
  500. ticker_response(last="1"),
  501. leverage_response(),
  502. place_order_response(),
  503. ]
  504. )
  505. signal = TradeSignal(
  506. action="long",
  507. confidence=0.9,
  508. leverage=3,
  509. entry_price=None,
  510. take_profit_price=None,
  511. stop_loss_price=None,
  512. reason="x",
  513. )
  514. client = OkxClient(config=sample_config(), session=session)
  515. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=signal, margin_usdt=0.009)
  516. assert session.last_json_body is not None
  517. assert session.last_json_body["sz"] == "27"
  518. def test_place_demo_order_fails_when_not_hedge_mode():
  519. session = DummySession(
  520. [
  521. account_config_response(pos_mode="net_mode"),
  522. ]
  523. )
  524. client = OkxClient(config=sample_config(), session=session)
  525. with pytest.raises(ValueError):
  526. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=market_long_signal(), margin_usdt=100)
  527. assert session.request_paths == ["/api/v5/account/config"]
  528. def test_ensure_hedge_mode_rejects_malformed_config_payload():
  529. session = DummySession([malformed_account_config_response(pos_mode=None)])
  530. client = OkxClient(config=sample_config(), session=session)
  531. with pytest.raises(ValueError, match="okx response payload is invalid"):
  532. client.ensure_hedge_mode()
  533. def test_place_demo_order_validates_size_before_setting_leverage():
  534. session = DummySession(
  535. [
  536. account_config_response(pos_mode="long_short_mode"),
  537. large_min_size_instrument_response(),
  538. ticker_response(last="25000"),
  539. ]
  540. )
  541. client = OkxClient(config=sample_config(), session=session)
  542. with pytest.raises(ValueError, match="contract size below minimum"):
  543. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=market_long_signal(), margin_usdt=100)
  544. assert session.request_paths == [
  545. "/api/v5/account/config",
  546. "/api/v5/public/instruments",
  547. "/api/v5/market/ticker",
  548. ]
  549. def test_limit_short_order_uses_sell_and_short_pos_side():
  550. session = DummySession(
  551. [
  552. account_config_response(pos_mode="long_short_mode"),
  553. instrument_response(symbol="ETH-USDT-SWAP"),
  554. leverage_response(),
  555. place_order_response(),
  556. ]
  557. )
  558. client = OkxClient(config=sample_config(), session=session)
  559. client.place_demo_order(symbol="ETH-USDT-SWAP", signal=limit_short_signal(), margin_usdt=100)
  560. order_request = session.last_json_body
  561. assert order_request is not None
  562. assert order_request["ordType"] == "limit"
  563. assert order_request["side"] == "sell"
  564. assert order_request["posSide"] == "short"
  565. assert order_request["px"] == "25000"
  566. assert session.request_bodies[2]["lever"] == "2"
  567. assert session.request_bodies[2]["mgnMode"] == "isolated"
  568. def test_flat_signal_returns_noop_without_order_submission():
  569. session = DummySession([])
  570. client = OkxClient(config=sample_config(), session=session)
  571. result = client.place_demo_order(symbol="BTC-USDT-SWAP", signal=flat_signal(), margin_usdt=100)
  572. assert result.status == "noop"
  573. assert session.request_paths == []
  574. def test_place_demo_order_sends_computed_sz_and_ignores_tp_sl_fields():
  575. session = DummySession(
  576. [
  577. account_config_response(pos_mode="long_short_mode"),
  578. instrument_response(),
  579. ticker_response(last="25000"),
  580. leverage_response(),
  581. place_order_response(),
  582. ]
  583. )
  584. client = OkxClient(config=sample_config(), session=session)
  585. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=market_long_signal(), margin_usdt=100)
  586. order_request = session.last_json_body
  587. assert order_request is not None
  588. assert order_request["sz"] == "8"
  589. assert "tpTriggerPx" not in order_request
  590. assert "slTriggerPx" not in order_request
  591. def test_okx_error_payload_raises_value_error():
  592. session = DummySession([error_response(code="51000", msg="parameter error")])
  593. client = OkxClient(config=sample_config(), session=session)
  594. with pytest.raises(ValueError):
  595. client.get_candles(symbol="BTC-USDT-SWAP", bar="1H", limit=20)
  596. def test_get_candles_rejects_non_finite_numeric_fields():
  597. session = DummySession([candles_with_non_finite_numeric_response()])
  598. client = OkxClient(config=sample_config(), session=session)
  599. with pytest.raises(ValueError, match="okx response payload is invalid"):
  600. client.get_candles(symbol="BTC-USDT-SWAP", bar="1H", limit=20)
  601. def test_transport_failure_raises_stable_value_error():
  602. session = DummySession([RuntimeError("socket closed")])
  603. client = OkxClient(config=sample_config(), session=session)
  604. with pytest.raises(ValueError, match="okx transport error"):
  605. client.get_candles(symbol="BTC-USDT-SWAP", bar="1H", limit=20)
  606. def test_invalid_json_raises_stable_value_error():
  607. session = DummySession([DummyResponse({}, json_error=ValueError("bad json"))])
  608. client = OkxClient(config=sample_config(), session=session)
  609. with pytest.raises(ValueError, match="okx response payload is invalid"):
  610. client.get_candles(symbol="BTC-USDT-SWAP", bar="1H", limit=20)
  611. def test_empty_positions_data_returns_empty_list():
  612. session = DummySession([DummyResponse({"code": "0", "msg": "", "data": []})])
  613. client = OkxClient(config=sample_config(), session=session)
  614. assert client.get_positions(symbol="BTC-USDT-SWAP") == []
  615. def test_malformed_numeric_field_raises_stable_value_error():
  616. session = DummySession(
  617. [
  618. DummyResponse(
  619. {
  620. "code": "0",
  621. "msg": "",
  622. "data": [
  623. {
  624. "instId": "BTC-USDT-SWAP",
  625. "posSide": "long",
  626. "pos": "bad",
  627. "avgPx": "25000",
  628. }
  629. ],
  630. }
  631. )
  632. ]
  633. )
  634. client = OkxClient(config=sample_config(), session=session)
  635. with pytest.raises(ValueError, match="okx response payload is invalid"):
  636. client.get_positions(symbol="BTC-USDT-SWAP")
  637. def test_non_list_okx_data_raises_stable_value_error():
  638. session = DummySession([DummyResponse({"code": "0", "msg": "", "data": {}})])
  639. client = OkxClient(config=sample_config(), session=session)
  640. with pytest.raises(ValueError, match="okx response payload is invalid"):
  641. client.get_positions(symbol="BTC-USDT-SWAP")
  642. def test_get_instrument_meta_rejects_non_finite_numeric_fields():
  643. session = DummySession([instrument_with_non_finite_numeric_response()])
  644. client = OkxClient(config=sample_config(), session=session)
  645. with pytest.raises(ValueError, match="okx response payload is invalid"):
  646. client.get_instrument_meta(symbol="BTC-USDT-SWAP")
  647. def test_get_last_price_rejects_non_finite_numeric_field():
  648. session = DummySession([ticker_with_non_finite_numeric_response()])
  649. client = OkxClient(config=sample_config(), session=session)
  650. with pytest.raises(ValueError, match="okx response payload is invalid"):
  651. client.get_last_price(symbol="BTC-USDT-SWAP")
  652. def test_get_last_price_rejects_mismatched_symbol():
  653. session = DummySession([DummyResponse({"code": "0", "msg": "", "data": [{"instId": "ETH-USDT-SWAP", "last": "25000"}]})])
  654. client = OkxClient(config=sample_config(), session=session)
  655. with pytest.raises(ValueError, match="okx response payload is invalid"):
  656. client.get_last_price(symbol="BTC-USDT-SWAP")
  657. def test_get_instrument_meta_rejects_mismatched_symbol():
  658. session = DummySession([instrument_with_wrong_symbol_response()])
  659. client = OkxClient(config=sample_config(), session=session)
  660. with pytest.raises(ValueError, match="okx response payload is invalid"):
  661. client.get_instrument_meta(symbol="BTC-USDT-SWAP")
  662. def test_get_instrument_meta_rejects_non_swap_type():
  663. session = DummySession([instrument_with_wrong_type_response()])
  664. client = OkxClient(config=sample_config(), session=session)
  665. with pytest.raises(ValueError, match="okx response payload is invalid"):
  666. client.get_instrument_meta(symbol="BTC-USDT-SWAP")
  667. def test_place_demo_order_raises_when_order_id_is_missing():
  668. session = DummySession(
  669. [
  670. account_config_response(pos_mode="long_short_mode"),
  671. instrument_response(),
  672. ticker_response(last="25000"),
  673. leverage_response(),
  674. place_order_response_without_order_id(),
  675. ]
  676. )
  677. client = OkxClient(config=sample_config(), session=session)
  678. with pytest.raises(ValueError, match="okx response payload is invalid"):
  679. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=market_long_signal(), margin_usdt=100)
  680. assert session.request_paths[-1] == "/api/v5/trade/order"
  681. def test_place_demo_order_rejects_invalid_leverage_before_okx():
  682. session = DummySession([])
  683. signal = TradeSignal(
  684. action="long",
  685. confidence=0.9,
  686. leverage=4,
  687. entry_price=None,
  688. take_profit_price=None,
  689. stop_loss_price=None,
  690. reason="x",
  691. )
  692. client = OkxClient(config=sample_config(), session=session)
  693. with pytest.raises(ValueError, match="leverage is invalid"):
  694. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=signal, margin_usdt=100)
  695. assert session.request_paths == []
  696. def test_place_demo_order_rejects_fractional_leverage_before_okx():
  697. session = DummySession([])
  698. signal = TradeSignal(
  699. action="long",
  700. confidence=0.9,
  701. leverage=2.5,
  702. entry_price=None,
  703. take_profit_price=None,
  704. stop_loss_price=None,
  705. reason="x",
  706. )
  707. client = OkxClient(config=sample_config(), session=session)
  708. with pytest.raises(ValueError, match="leverage is invalid"):
  709. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=signal, margin_usdt=100)
  710. assert session.request_paths == []
  711. def test_place_demo_order_rejects_boolean_leverage_before_okx():
  712. session = DummySession([])
  713. signal = TradeSignal(
  714. action="long",
  715. confidence=0.9,
  716. leverage=True,
  717. entry_price=None,
  718. take_profit_price=None,
  719. stop_loss_price=None,
  720. reason="x",
  721. )
  722. client = OkxClient(config=sample_config(), session=session)
  723. with pytest.raises(ValueError, match="leverage is invalid"):
  724. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=signal, margin_usdt=100)
  725. assert session.request_paths == []
  726. @pytest.mark.parametrize("margin_usdt", [0, -1, float("nan"), float("inf")])
  727. def test_place_demo_order_rejects_invalid_margin_before_okx(margin_usdt):
  728. session = DummySession([])
  729. client = OkxClient(config=sample_config(), session=session)
  730. with pytest.raises(ValueError, match="margin_usdt is invalid"):
  731. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=market_long_signal(), margin_usdt=margin_usdt)
  732. assert session.request_paths == []
  733. def test_place_demo_order_rejects_boolean_margin_before_okx():
  734. session = DummySession([])
  735. client = OkxClient(config=sample_config(), session=session)
  736. with pytest.raises(ValueError, match="margin_usdt is invalid"):
  737. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=market_long_signal(), margin_usdt=True)
  738. assert session.request_paths == []
  739. @pytest.mark.parametrize(
  740. ("symbol", "leverage", "pos_side", "expected_message"),
  741. [
  742. ("BTC-USDT", 2, "long", "swap instrument is required"),
  743. ("BTC-USDT-SWAP", 4, "long", "leverage is invalid"),
  744. ("BTC-USDT-SWAP", 2.5, "long", "leverage is invalid"),
  745. ("BTC-USDT-SWAP", 2, "net", "pos_side is invalid"),
  746. ],
  747. )
  748. def test_set_leverage_validates_public_boundary_inputs(symbol, leverage, pos_side, expected_message):
  749. session = DummySession([])
  750. client = OkxClient(config=sample_config(), session=session)
  751. with pytest.raises(ValueError, match=expected_message):
  752. client.set_leverage(symbol=symbol, leverage=leverage, pos_side=pos_side)
  753. assert session.request_paths == []
  754. def test_place_demo_order_rejects_unknown_action_before_okx():
  755. session = DummySession([])
  756. signal = TradeSignal(
  757. action="hold",
  758. confidence=0.9,
  759. leverage=2,
  760. entry_price=None,
  761. take_profit_price=None,
  762. stop_loss_price=None,
  763. reason="x",
  764. )
  765. client = OkxClient(config=sample_config(), session=session)
  766. with pytest.raises(ValueError, match="action is invalid"):
  767. client.place_demo_order(symbol="BTC-USDT-SWAP", signal=signal, margin_usdt=100)
  768. assert session.request_paths == []
  769. def test_get_positions_returns_normalized_positions():
  770. session = DummySession([positions_response()])
  771. client = OkxClient(config=sample_config(), session=session)
  772. positions = client.get_positions(symbol="BTC-USDT-SWAP")
  773. assert positions[0].symbol == "BTC-USDT-SWAP"
  774. assert positions[0].pos_side == "long"
  775. assert positions[0].size == 8.0
  776. assert positions[0].avg_price == 25000.0
  777. def test_get_positions_filters_zero_size_rows():
  778. session = DummySession([positions_with_zero_size_response()])
  779. client = OkxClient(config=sample_config(), session=session)
  780. positions = client.get_positions(symbol="BTC-USDT-SWAP")
  781. assert len(positions) == 1
  782. assert positions[0].pos_side == "short"
  783. assert positions[0].size == 3.0
  784. def test_get_positions_ignores_malformed_fields_on_zero_size_rows():
  785. session = DummySession([positions_with_zero_size_malformed_avg_price_response()])
  786. client = OkxClient(config=sample_config(), session=session)
  787. positions = client.get_positions(symbol="BTC-USDT-SWAP")
  788. assert len(positions) == 1
  789. assert positions[0].pos_side == "short"
  790. assert positions[0].avg_price == 24900.0
  791. def test_get_positions_rejects_non_string_inst_id_and_pos_side():
  792. session = DummySession([positions_with_non_string_identity_response()])
  793. client = OkxClient(config=sample_config(), session=session)
  794. with pytest.raises(ValueError, match="okx response payload is invalid"):
  795. client.get_positions(symbol="BTC-USDT-SWAP")
  796. def test_get_positions_rejects_non_finite_numeric_fields():
  797. session = DummySession([positions_with_non_finite_numeric_response()])
  798. client = OkxClient(config=sample_config(), session=session)
  799. with pytest.raises(ValueError, match="okx response payload is invalid"):
  800. client.get_positions(symbol="BTC-USDT-SWAP")
  801. def test_get_positions_rejects_mismatched_symbol():
  802. session = DummySession([positions_with_wrong_symbol_response()])
  803. client = OkxClient(config=sample_config(), session=session)
  804. with pytest.raises(ValueError, match="okx response payload is invalid"):
  805. client.get_positions(symbol="BTC-USDT-SWAP")
  806. def test_get_positions_rejects_invalid_pos_side():
  807. session = DummySession([positions_with_invalid_pos_side_response()])
  808. client = OkxClient(config=sample_config(), session=session)
  809. with pytest.raises(ValueError, match="okx response payload is invalid"):
  810. client.get_positions(symbol="BTC-USDT-SWAP")