forked from bitvavo/python-bitvavo-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhttp.py
More file actions
340 lines (283 loc) · 13.4 KB
/
http.py
File metadata and controls
340 lines (283 loc) · 13.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
"""HTTP client for Bitvavo API."""
from __future__ import annotations
import time
from typing import TYPE_CHECKING, Any
import httpx
from returns.result import Failure, Result
from structlog.stdlib import get_logger
from bitvavo_client.adapters.returns_adapter import (
BitvavoError,
decode_response_result,
)
from bitvavo_client.auth.signing import create_signature
if TYPE_CHECKING: # pragma: no cover
from bitvavo_client.auth.rate_limit import RateLimitManager
from bitvavo_client.core.settings import BitvavoSettings
from bitvavo_client.core.types import AnyDict
logger = get_logger(__name__)
class HTTPClient:
"""HTTP client for Bitvavo REST API with rate limiting and authentication."""
def __init__(self, settings: BitvavoSettings, rate_limiter: RateLimitManager) -> None:
"""Initialize HTTP client.
Args:
settings: Bitvavo settings configuration
rate_limiter: Rate limit manager instance
"""
self.settings: BitvavoSettings = settings
self.rate_limiter: RateLimitManager = rate_limiter
self._keys: list[tuple[str, str]] = [(item["key"], item["secret"]) for item in self.settings.api_keys]
if not self._keys:
msg = "API keys are required"
logger.error("api-keys-required")
raise ValueError(msg)
for idx in range(len(self._keys)):
self.rate_limiter.ensure_key(idx)
self.key_index: int = 0
self.api_key: str = ""
self.api_secret: str = ""
self._rate_limit_initialized: bool = False
key, secret = self._keys[0]
self.configure_key(key, secret, 0)
logger.info("http-client-initialized", key_count=len(self._keys))
def configure_key(self, key: str, secret: str, index: int) -> None:
"""Configure API key for authenticated requests.
Args:
key: API key
secret: API secret
index: Key index for rate limiting
"""
self.api_key = key
self.api_secret = secret
self.key_index = index
key_suffix = key[-4:] if len(key) >= 4 else "short"
logger.debug("api-key-configured", index=index, key_suffix=key_suffix)
def select_key(self, index: int) -> None:
"""Select a specific API key by index."""
if not (0 <= index < len(self._keys)):
msg = "API key index out of range"
logger.error("api-key-index-out-of-range", index=index, available_keys=len(self._keys))
raise IndexError(msg)
key, secret = self._keys[index]
self.configure_key(key, secret, index)
logger.debug("api-key-selected", index=index)
def _rotate_key(self) -> bool:
"""Rotate to the next configured API key if available."""
if len(self._keys) <= 1:
logger.debug("key-rotation-skipped", reason="only-one-key")
return False
next_idx = (self.key_index + 1) % len(self._keys)
now = int(time.time() * 1000)
reset_at = self.rate_limiter.get_reset_at(next_idx)
if now < reset_at:
logger.info("rotating-to-key-with-sleep", next_index=next_idx)
self.rate_limiter.sleep_until_reset(next_idx)
self.rate_limiter.reset_key(next_idx)
elif self.rate_limiter.get_remaining(next_idx) <= self.rate_limiter.buffer:
logger.debug("rotating-to-key-with-reset", next_index=next_idx, reason="low-remaining-budget")
self.rate_limiter.reset_key(next_idx)
self.select_key(next_idx)
logger.info("key-rotated", from_index=self.key_index, to_index=next_idx)
return True
def _find_available_key(self, weight: int) -> int | None:
"""Find the best available API key for a request with given weight.
Args:
weight: Weight of the request
Returns:
Best key index or None if all keys are rate limited
"""
available_keys = list(range(len(self._keys)))
best_key = self.rate_limiter.find_best_available_key(available_keys, weight)
if best_key is not None:
logger.debug("available-key-found", key_index=best_key, weight=weight)
else:
logger.warning("no-available-keys", weight=weight)
return best_key
def _handle_rate_limit_exhaustion(self, weight: int) -> None:
"""Handle situation when all API keys are rate limited.
Sleeps until the earliest key reset time and then resets that key.
Args:
weight: Weight of the original request
"""
logger.warning("all-keys-rate-limited", weight=weight)
all_keys = list(range(len(self._keys)))
earliest_reset = self.rate_limiter.get_earliest_reset_time(all_keys)
if earliest_reset > 0:
# Find which key has the earliest reset time
now = int(time.time() * 1000)
for idx in all_keys:
if self.rate_limiter.get_reset_at(idx) == earliest_reset:
if now < earliest_reset:
# Sleep until this key resets
sleep_ms = earliest_reset - now
logger.info("sleeping-until-key-reset", key_index=idx, sleep_ms=sleep_ms)
self.rate_limiter.sleep_until_reset(idx)
self.rate_limiter.reset_key(idx)
self.select_key(idx)
logger.info("key-reset-after-exhaustion", key_index=idx)
return
# Fallback to current key's rate limit strategy
logger.debug("fallback-to-current-key", key_index=self.key_index)
self.rate_limiter.handle_limit(self.key_index, weight)
def request(
self,
method: str,
endpoint: str,
*,
body: AnyDict | None = None,
weight: int = 1,
) -> Result[Any, BitvavoError | httpx.HTTPError]:
"""Make HTTP request and return raw JSON data as a Result.
Args:
method: HTTP method (GET, POST, PUT, DELETE)
endpoint: API endpoint path
body: Request body for POST/PUT requests
weight: Rate limit weight of the request
Returns:
Result containing raw JSON response or error
Raises:
HTTPError: On transport-level failures
"""
logger.debug("making-request", method=method, endpoint=endpoint, weight=weight)
idx = self.key_index
self._ensure_rate_limit_initialized()
# Try to find the best available key for this request
best_key = self._find_available_key(weight)
if best_key is not None and best_key != idx:
logger.debug("switching-to-best-key", from_index=idx, to_index=best_key)
self.select_key(best_key)
idx = best_key
# If current key doesn't have budget, try rotation
if not self.rate_limiter.has_budget(idx, weight):
logger.debug("key-lacks-budget", key_index=idx, weight=weight)
for _ in range(len(self._keys)):
if self.rate_limiter.has_budget(idx, weight):
break
rotated = self._rotate_key()
idx = self.key_index
if not rotated:
break
# If still no budget after trying all keys, handle exhaustion smartly
if not self.rate_limiter.has_budget(idx, weight):
logger.warning("no-budget-after-rotation", weight=weight)
self._handle_rate_limit_exhaustion(weight)
idx = self.key_index # Update idx after potential key change
url = f"{self.settings.rest_url}{endpoint}"
headers = self._create_auth_headers(method, endpoint, body)
# Update rate limit usage for this call
self.rate_limiter.record_call(idx, weight)
logger.debug("weight-recorded", weight=weight, key_index=idx)
try:
response = self._make_http_request(method, url, headers, body)
logger.debug("request-completed", status_code=response.status_code)
except httpx.HTTPError as exc:
logger.error("http-request-failed", error=str(exc))
return Failure(exc)
self._update_rate_limits(response, idx)
# Always return raw data - let the caller handle model conversion
return decode_response_result(response, model=Any)
def _ensure_rate_limit_initialized(self) -> None:
"""Ensure the initial rate limit state is fetched from the API."""
if self._rate_limit_initialized:
return
logger.info("initializing-rate-limit-state")
self._rate_limit_initialized = True
self._initialize_rate_limit()
def _initialize_rate_limit(self) -> None:
"""Fetch initial rate limit and handle potential rate limit errors."""
endpoint = "/account"
url = f"{self.settings.rest_url}{endpoint}"
logger.debug("fetching-initial-rate-limit")
while True:
headers = self._create_auth_headers("GET", endpoint, None)
# Record the weight for this check (weight 1)
self.rate_limiter.record_call(self.key_index, 1)
try:
response = self._make_http_request("GET", url, headers, None)
except httpx.HTTPError as exc:
logger.warning("rate-limit-init-failed", error=str(exc))
return
self._update_rate_limits(response, self.key_index)
err_code = ""
if response.status_code == httpx.codes.TOO_MANY_REQUESTS:
try:
data = response.json()
except ValueError:
data = {}
if isinstance(data, dict):
err = data.get("error")
if isinstance(err, dict):
err_code = str(err.get("code", ""))
if response.status_code == httpx.codes.TOO_MANY_REQUESTS and err_code == "101":
logger.info("rate-limited-during-init", error_code=err_code)
self.rate_limiter.sleep_until_reset(self.key_index)
self.rate_limiter.reset_key(self.key_index)
continue
if self.rate_limiter.get_remaining(self.key_index) < self.rate_limiter.buffer:
remaining = self.rate_limiter.get_remaining(self.key_index)
logger.info("low-budget-during-init", remaining=remaining)
self.rate_limiter.sleep_until_reset(self.key_index)
self.rate_limiter.reset_key(self.key_index)
continue
logger.info("rate-limit-initialization-completed")
break
def _create_auth_headers(self, method: str, endpoint: str, body: AnyDict | None) -> dict[str, str]:
"""Create authentication headers if API key is configured."""
timestamp = int(time.time() * 1000) + self.settings.lag_ms
signature = create_signature(timestamp, method, endpoint, body, self.api_secret)
return {
"bitvavo-access-key": self.api_key,
"bitvavo-access-signature": signature,
"bitvavo-access-timestamp": str(timestamp),
"bitvavo-access-window": str(self.settings.access_window_ms),
}
def _make_http_request(
self,
method: str,
url: str,
headers: dict[str, str],
body: AnyDict | None,
) -> httpx.Response:
"""Make the actual HTTP request."""
timeout = self.settings.access_window_ms / 1000
match method:
case "GET":
return httpx.get(url, headers=headers, timeout=timeout)
case "POST":
return httpx.post(url, headers=headers, json=body, timeout=timeout)
case "PUT":
return httpx.put(url, headers=headers, json=body, timeout=timeout)
case "DELETE":
return httpx.delete(url, headers=headers, timeout=timeout)
case _:
msg = f"Unsupported HTTP method: {method}"
logger.error("unsupported-http-method", method=method)
raise ValueError(msg)
def _update_rate_limits(self, response: httpx.Response, idx: int) -> None:
"""Update rate limits based on response."""
try:
json_data = response.json()
except ValueError:
json_data = {}
if isinstance(json_data, dict) and "error" in json_data:
if self._is_rate_limit_error(response, json_data):
logger.warning("rate-limit-error-detected", key_index=idx)
self.rate_limiter.update_from_error(idx, json_data)
else:
logger.debug("non-rate-limit-error", key_index=idx)
self.rate_limiter.update_from_headers(idx, dict(response.headers))
else:
logger.debug("successful-response", key_index=idx)
self.rate_limiter.update_from_headers(idx, dict(response.headers))
def _is_rate_limit_error(self, response: httpx.Response, json_data: dict[str, Any]) -> bool:
"""Check if response indicates a rate limit error."""
status = getattr(response, "status_code", None)
if status == httpx.codes.TOO_MANY_REQUESTS:
return True
err = json_data.get("error")
if isinstance(err, dict):
code = str(err.get("code", "")).lower()
message = str(err.get("message", "")).lower()
else:
code = ""
message = str(err).lower()
return any(k in code or k in message for k in ("rate", "limit", "too_many"))