feat(client): add tests/ gift card API/ multiple fixes (sammchardy#1470)

* first commit

* ruff check fix

* ruff format fix

* fix lint warnings and error

* type fix for 3.7

* add testnet to test_Ws_api

* change to testnet

* ruff@

* return test to async in test

* format with ruff

* remove blank line

* remove default tif

* add ws_futures, refactor and add tests

* lint

* fix tests

* ruff

* add tests

* remove utils

* ruff format and pr comments

* ruff format

* fix live tests and add env vars for testnet

* merge

* github action

* add tox env

* fix and test without tox

* move tox command

* fix test

* fix pyright

* type ignore

* jump test

* jump test until whitelist

* in progress

* finish tests

* remove print

* add examples

* improve docs

* fix batch order

* lint and format

* lint and format

* add tests for failed requests

* fix for 3.7

* Add gift cards endpoints and tests'

* run tests in parallel

* run tests in parallel

* reduce parallelism

* run github action sequentially

* change to 2 parallel

* fix action

* ruff format

* delete empty file

* skip dust assets test

* add missing force params

* add rerun to reduce flakiness

* remove change

* distribute tests over file

* fix test

* remove parallel test running

* increase delay

* update readme

* improve get_asset_balance

* add tests

* reformat

* tmp: continue on error

* fix cancel test

* ruff format

* update headers

* inject headers

* add overridable headers

* add headers tests

* format

* remove import

* fix tests linting

---------

Co-authored-by: carlosmiei <43336371+carlosmiei@users.noreply.github.com>

Author: pcriadoperez

.github/workflows/python-app.yml

@@ -26,10 +26,9 @@ jobs:
       run: pip install ruff
     - name: Lint code with Ruff
       run: ruff check --output-format=github --target-version=py39 .
-      continue-on-error: false # TODO: delete once ruff errors are fixed
-    # - name: Check code formatting with Ruff
-    #   run: ruff format --check .
-    #   continue-on-error: false # TODO: delete once ruff errors are fixed
+    - name: Check code formatting with Ruff
+      run: ruff format --check .
+      continue-on-error: true
 
   build:
     needs: lint
@@ -42,6 +41,7 @@ jobs:
       TEST_FUTURES_API_KEY: "227719da8d8499e8d3461587d19f259c0b39c2b462a77c9b748a6119abd74401"
       TEST_FUTURES_API_SECRET: "b14b935f9cfacc5dec829008733c40da0588051f29a44625c34967b45c11d73c"
     strategy:
+      max-parallel: 1
       matrix:
         python: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
     steps:

README.rst

@@ -66,7 +66,9 @@ Features
 - Testnet support for Spot, Futures and Vanilla Options
 - Simple handling of authentication include RSA and EDDSA keys
 - No need to generate timestamps yourself, the wrapper does it for you
+- RecvWindow sent by default
 - Response exception handling
+- Customizable HTTP headers
 - Websocket handling with reconnection and multiplexed connections
 - CRUD over websockets, create/fetch/edit through websockets for minimum latency.
 - Symbol Depth Cache
@@ -80,6 +82,7 @@ Features
 - Proxy support (REST and WS)
 - Orjson support for faster JSON parsing
 - Support other domains (.us, .jp, etc)
+- Support for the Gift Card API
 
 Upgrading to v1.0.0+
 --------------------
@@ -165,6 +168,9 @@ pass `testnet=True` when creating the client.
     # create order through websockets
     order_ws = client.ws_create_order( symbol="LTCUSDT", side="BUY", type="MARKET", quantity=0.1)
 
+    # get account using custom headers
+    account = client.get_account(headers={'MyCustomKey': 'MyCustomValue'})
+
     # socket manager using threads
     twm = ThreadedWebsocketManager()
     twm.start()

binance/async_client.py

@@ -1,7 +1,7 @@
 import asyncio
 from pathlib import Path
 from typing import Any, Dict, List, Optional, Union
-from urllib.parse import urlencode
+from urllib.parse import urlencode, quote
 import time
 import aiohttp
 import yarl
@@ -12,7 +12,12 @@
     BinanceRequestException,
     NotImplementedException,
 )
-from binance.helpers import convert_ts_str, get_loop, interval_to_milliseconds
+from binance.helpers import (
+    convert_list_to_json_array,
+    convert_ts_str,
+    get_loop,
+    interval_to_milliseconds,
+)
 from .base_client import BaseClient
 from .client import Client
 
@@ -102,16 +107,32 @@ async def close_connection(self):
     async def _request(
         self, method, uri: str, signed: bool, force_params: bool = False, **kwargs
     ):
+        # this check needs to be done before __get_request_kwargs to avoid
+        # polluting the signature
+        headers = {}
+        if method.upper() in ["POST", "PUT", "DELETE"]:
+            headers.update({"Content-Type": "application/x-www-form-urlencoded"})
+
+        if "data" in kwargs:
+            for key in kwargs["data"]:
+                if key == "headers":
+                    headers.update(kwargs["data"][key])
+                    del kwargs["data"][key]
+                    break
+
         kwargs = self._get_request_kwargs(method, signed, force_params, **kwargs)
 
-        if method == 'get':
+        if method == "get":
             # url encode the query string
-            if 'params' in kwargs:
+            if "params" in kwargs:
                 uri = f"{uri}?{kwargs['params']}"
-                kwargs.pop('params')
+                kwargs.pop("params")
 
         async with getattr(self.session, method)(
-            yarl.URL(uri, encoded=True), proxy=self.https_proxy, **kwargs
+            yarl.URL(uri, encoded=True),
+            proxy=self.https_proxy,
+            headers=headers,
+            **kwargs,
         ) as response:
             self.response = response
             return await self._handle_response(response)
@@ -138,59 +159,64 @@ async def _request_api(
         **kwargs,
     ):
         uri = self._create_api_uri(path, signed, version)
-        return await self._request(method, uri, signed, **kwargs)
+        force_params = kwargs.pop("force_params", False)
+        return await self._request(method, uri, signed, force_params, **kwargs)
 
     async def _request_futures_api(
         self, method, path, signed=False, version=1, **kwargs
     ) -> Dict:
         version = self._get_version(version, **kwargs)
         uri = self._create_futures_api_uri(path, version=version)
-
-        return await self._request(method, uri, signed, False, **kwargs)
+        force_params = kwargs.pop("force_params", False)
+        return await self._request(method, uri, signed, force_params, **kwargs)
 
     async def _request_futures_data_api(
         self, method, path, signed=False, **kwargs
     ) -> Dict:
         uri = self._create_futures_data_api_uri(path)
-
-        return await self._request(method, uri, signed, True, **kwargs)
+        force_params = kwargs.pop("force_params", True)
+        return await self._request(method, uri, signed, force_params, **kwargs)
 
     async def _request_futures_coin_api(
         self, method, path, signed=False, version=1, **kwargs
     ) -> Dict:
         version = self._get_version(version, **kwargs)
         uri = self._create_futures_coin_api_url(path, version=version)
-
-        return await self._request(method, uri, signed, False, **kwargs)
+        force_params = kwargs.pop("force_params", False)
+        return await self._request(method, uri, signed, force_params, **kwargs)
 
     async def _request_futures_coin_data_api(
         self, method, path, signed=False, version=1, **kwargs
     ) -> Dict:
         version = self._get_version(version, **kwargs)
         uri = self._create_futures_coin_data_api_url(path, version=version)
 
-        return await self._request(method, uri, signed, True, **kwargs)
+        force_params = kwargs.pop("force_params", True)
+        return await self._request(method, uri, signed, force_params, **kwargs)
 
     async def _request_options_api(self, method, path, signed=False, **kwargs) -> Dict:
         uri = self._create_options_api_uri(path)
+        force_params = kwargs.pop("force_params", True)
 
-        return await self._request(method, uri, signed, True, **kwargs)
+        return await self._request(method, uri, signed, force_params, **kwargs)
 
     async def _request_margin_api(
         self, method, path, signed=False, version=1, **kwargs
     ) -> Dict:
         version = self._get_version(version, **kwargs)
         uri = self._create_margin_api_uri(path, version)
 
-        return await self._request(method, uri, signed, **kwargs)
+        force_params = kwargs.pop("force_params", False)
+        return await self._request(method, uri, signed, force_params, **kwargs)
 
     async def _request_papi_api(
         self, method, path, signed=False, version=1, **kwargs
     ) -> Dict:
         version = self._get_version(version, **kwargs)
         uri = self._create_papi_api_uri(path, version)
 
-        return await self._request(method, uri, signed, **kwargs)
+        force_params = kwargs.pop("force_params", False)
+        return await self._request(method, uri, signed, force_params, **kwargs)
 
     async def _request_website(self, method, path, signed=False, **kwargs) -> Dict:
         uri = self._create_website_uri(path)
@@ -712,13 +738,16 @@ async def get_account(self, **params):
 
     get_account.__doc__ = Client.get_account.__doc__
 
-    async def get_asset_balance(self, asset, **params):
+    async def get_asset_balance(self, asset=None, **params):
         res = await self.get_account(**params)
         # find asset balance in list of balances
         if "balances" in res:
-            for bal in res["balances"]:
-                if bal["asset"].lower() == asset.lower():
-                    return bal
+            if asset:
+                for bal in res["balances"]:
+                    if bal["asset"].lower() == asset.lower():
+                        return bal
+            else:
+                return res["balances"]
         return None
 
     get_asset_balance.__doc__ = Client.get_asset_balance.__doc__
@@ -1775,17 +1804,28 @@ async def futures_create_order(self, **params):
             params["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
         return await self._request_futures_api("post", "order", True, data=params)
 
+    async def futures_modify_order(self, **params):
+        """Modify an existing order. Currently only LIMIT order modification is supported.
+
+        https://binance-docs.github.io/apidocs/futures/en/#modify-order-trade
+
+        """
+        return await self._request_futures_api("put", "order", True, data=params)
+
     async def futures_create_test_order(self, **params):
         return await self._request_futures_api("post", "order/test", True, data=params)
 
     async def futures_place_batch_order(self, **params):
         for order in params["batchOrders"]:
             if "newClientOrderId" not in order:
                 order["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
-        query_string = urlencode(params)
-        query_string = query_string.replace("%27", "%22")
+                order = self._order_params(order)
+        query_string = urlencode(params).replace("%40", "@").replace("%27", "%22")
         params["batchOrders"] = query_string[12:]
-        return await self._request_futures_api("post", "batchOrders", True, data=params)
+
+        return await self._request_futures_api(
+            "post", "batchOrders", True, data=params, force_params=True
+        )
 
     async def futures_get_order(self, **params):
         return await self._request_futures_api("get", "order", True, data=params)
@@ -1805,8 +1845,16 @@ async def futures_cancel_all_open_orders(self, **params):
         )
 
     async def futures_cancel_orders(self, **params):
+        if params.get("orderidlist"):
+            params["orderidlist"] = quote(
+                convert_list_to_json_array(params["orderidlist"])
+            )
+        if params.get("origclientorderidlist"):
+            params["origclientorderidlist"] = quote(
+                convert_list_to_json_array(params["origclientorderidlist"])
+            )
         return await self._request_futures_api(
-            "delete", "batchOrders", True, data=params
+            "delete", "batchOrders", True, data=params, force_params=True
         )
 
     async def futures_countdown_cancel_all(self, **params):
@@ -2036,10 +2084,18 @@ async def futures_coin_cancel_order(self, **params):
 
     async def futures_coin_cancel_all_open_orders(self, **params):
         return await self._request_futures_coin_api(
-            "delete", "allOpenOrders", signed=True, data=params
+            "delete", "allOpenOrders", signed=True, data=params, force_params=True
         )
 
     async def futures_coin_cancel_orders(self, **params):
+        if params.get("orderidlist"):
+            params["orderidlist"] = quote(
+                convert_list_to_json_array(params["orderidlist"])
+            )
+        if params.get("origclientorderidlist"):
+            params["origclientorderidlist"] = quote(
+                convert_list_to_json_array(params["origclientorderidlist"])
+            )
         return await self._request_futures_coin_api(
             "delete", "batchOrders", True, data=params
         )
@@ -3601,3 +3657,51 @@ async def ws_futures_account_status(self, **params):
         https://developers.binance.com/docs/derivatives/usds-margined-futures/account/websocket-api/Account-Information
         """
         return await self._ws_futures_api_request("account.status", True, params)
+
+    ####################################################
+    # Gift Card API Endpoints
+    ####################################################
+
+    async def gift_card_fetch_token_limit(self, **params):
+        return await self._request_margin_api(
+            "get", "giftcard/buyCode/token-limit", signed=True, data=params
+        )
+
+    gift_card_fetch_token_limit.__doc__ = Client.gift_card_fetch_token_limit.__doc__
+
+    async def gift_card_fetch_rsa_public_key(self, **params):
+        return await self._request_margin_api(
+            "get", "giftcard/cryptography/rsa-public-key", signed=True, data=params
+        )
+
+    gift_card_fetch_rsa_public_key.__doc__ = (
+        Client.gift_card_fetch_rsa_public_key.__doc__
+    )
+
+    async def gift_card_verify(self, **params):
+        return await self._request_margin_api(
+            "get", "giftcard/verify", signed=True, data=params
+        )
+
+    gift_card_verify.__doc__ = Client.gift_card_verify.__doc__
+
+    async def gift_card_redeem(self, **params):
+        return await self._request_margin_api(
+            "post", "giftcard/redeemCode", signed=True, data=params
+        )
+
+    gift_card_redeem.__doc__ = Client.gift_card_redeem.__doc__
+
+    async def gift_card_create(self, **params):
+        return await self._request_margin_api(
+            "post", "giftcard/createCode", signed=True, data=params
+        )
+
+    gift_card_create.__doc__ = Client.gift_card_create.__doc__
+
+    async def gift_card_create_dual_token(self, **params):
+        return await self._request_margin_api(
+            "post", "giftcard/buyCode", signed=True, data=params
+        )
+
+    gift_card_create_dual_token.__doc__ = Client.gift_card_create_dual_token.__doc__

binance/base_client.py

@@ -60,7 +60,7 @@ class BaseClient:
 
     REQUEST_TIMEOUT: float = 10
 
-    REQUEST_RECVWINDOW: int = 10000 # 10 seconds
+    REQUEST_RECVWINDOW: int = 10000  # 10 seconds
 
     SYMBOL_TYPE_SPOT = "SPOT"
 
@@ -209,6 +209,7 @@ def __init__(
     def _get_headers(self) -> Dict:
         headers = {
             "Accept": "application/json",
+            "Content-Type": "application/json",
             "User-Agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",  # noqa
         }
         if self.API_KEY:
@@ -480,8 +481,13 @@ def _get_request_kwargs(
             del kwargs["data"]
 
         # Temporary fix for Signature issue while using batchOrders in AsyncClient
-        if "params" in kwargs.keys() and "batchOrders" in kwargs["params"]:
-            kwargs["data"] = kwargs["params"]
-            del kwargs["params"]
+        if "params" in kwargs.keys():
+            if (
+                "batchOrders" in kwargs["params"]
+                or "orderidlist" in kwargs["params"]
+                or "origclientorderidlist" in kwargs["params"]
+            ):
+                kwargs["data"] = kwargs["params"]
+                del kwargs["params"]
 
         return kwargs