add headers

Author: dangell7

xrpl/asyncio/clients/client.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
-from typing import Optional
+from typing import Optional, Dict
 
 from typing_extensions import Final, Self
 
@@ -24,7 +24,11 @@ class Client(ABC):
     :meta private:
     """
 
-    def __init__(self: Self, url: str) -> None:
+    def __init__(
+        self: Self,
+        url: str,
+        headers: Optional[Dict[str, str]] = None,
+    ) -> None:
         """
         Initializes a client.
 
@@ -34,6 +38,7 @@ def __init__(self: Self, url: str) -> None:
         self.url = url
         self.network_id: Optional[int] = None
         self.build_version: Optional[str] = None
+        self.headers = headers or {}
 
     @abstractmethod
     async def _request_impl(

xrpl/asyncio/clients/json_rpc_base.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from json import JSONDecodeError
+from typing import Optional, Dict
 
 from httpx import AsyncClient
 from typing_extensions import Self
@@ -21,8 +22,25 @@ class JsonRpcBase(Client):
     :meta private:
     """
 
+    def __init__(
+        self: Self,
+        url: str,
+        headers: Optional[Dict[str, str]] = None,
+    ) -> None:
+        """
+        Initializes a new JsonRpcBase client.
+        Arguments:
+            url: The URL of the XRPL node to connect to.
+            headers: Optional default headers for all requests (e.g. API key or Dhali payment-claim).
+        """
+        super().__init__(url, headers=headers)
+
     async def _request_impl(
-        self: Self, request: Request, *, timeout: float = REQUEST_TIMEOUT
+        self: Self,
+        request: Request,
+        *,
+        timeout: float = REQUEST_TIMEOUT,
+        headers: Optional[Dict[str, str]] = None,
     ) -> Response:
         """
         Base ``_request_impl`` implementation for JSON RPC.
@@ -40,10 +58,18 @@ async def _request_impl(
 
         :meta private:
         """
+
+        merged_headers = {
+            "Content-Type": "application/json",
+            **self.headers,
+            **(headers or {}),
+        }
+
         async with AsyncClient(timeout=timeout) as http_client:
             response = await http_client.post(
                 self.url,
                 json=request_to_json_rpc(request),
+                headers=merged_headers,
             )
             try:
                 return json_to_response(response.json())

xrpl/asyncio/clients/websocket_base.py

@@ -56,7 +56,9 @@ class WebsocketBase(Client):
     :meta private:
     """
 
-    def __init__(self: Self, url: str) -> None:
+    def __init__(
+        self: Self, url: str, headers: Optional[Dict[str, str]] = None
+    ) -> None:
         """
         Initializes a websocket client.
 
@@ -71,7 +73,7 @@ def __init__(self: Self, url: str) -> None:
         # will initialize a new event loop when it opens the connection, so for
         # that client the initializer cannot create the queue
         self._messages: Optional[_MESSAGES_TYPE] = None
-        super().__init__(url)
+        super().__init__(url, headers=headers)
 
     def is_open(self: Self) -> bool:
         """
@@ -90,7 +92,9 @@ def is_open(self: Self) -> bool:
     async def _do_open(self: Self) -> None:
         """Connects the client to the Web Socket API at its URL."""
         # open the connection
-        self._websocket = await websocket_client.connect(self.url)
+        self._websocket = await websocket_client.connect(
+            self.url, extra_headers=self.headers
+        )
 
         # make a message queue
         self._messages = asyncio.Queue()