v2.0.0-rc1 release (#187)

* v2.0.0-rc1 release

* fixing rst format

* update readme

Author: 2pd

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.0.0-rc1 - 2022-11-29
+
+### Added
+- Add support for use of RSA Key to generate signatures
+
 ## 1.18.0 - 2022-09-29
 
 ### Added

README.md

@@ -30,7 +30,7 @@ pip install binance-connector
 
 Usage examples:
 ```python
-from binance.spot import Spot 
+from binance.spot import Spot
 
 client = Spot()
 
@@ -41,8 +41,8 @@ print(client.klines("BTCUSDT", "1m"))
 # Get last 10 klines of BNBUSDT at 1h interval
 print(client.klines("BNBUSDT", "1h", limit=10))
 
-# api key/secret are required for user data endpoints
-client = Spot(key='<api_key>', secret='<api_secret>')
+# API key/secret are required for user data endpoints
+client = Spot(api_key='<api_key>', api_secret='<api_secret>')
 
 # Get account and balance information
 print(client.account())
@@ -62,6 +62,27 @@ print(response)
 ```
 Please find `examples` folder to check for more endpoints.
 
+### Authentication
+
+Binance supports HMAC and RSA API authentication.
+
+```python
+
+# HMAC: pass API key and secret
+client = Client(api_key, api_secret)
+print(client.account())
+
+# RSA Keys
+client = Client(api_key=api_key, private_key=private_key)
+print(client.account())
+
+# Encrypted RSA Key
+client = Client(api_key=api_key, private_key=private_key, private_key_pass='password')
+print(client.account())
+```
+
+Please find `examples/spot/trade/get_account.py` for more details.
+
 ### Testnet
 
 [Spot Testnet](https://testnet.binance.vision/) is available, it can be used to test `/api/*` endpoints.
@@ -109,7 +130,7 @@ Anything beyond the limit will result in an error response from Binance server.
 ```python
 from binance.spot import Spot as Client
 
-client = Client(key, secret)
+client = Client(api_key, api_secret)
 response = client.get_order('BTCUSDT', orderId=11, recvWindow=10000)
 ```
 
@@ -182,7 +203,7 @@ There are 2 types of error returned from the library:
         - `status_code` - HTTP status code
         - `error_code` - Server's error code, e.g. `-1102`
         - `error_message` - Server's error message, e.g. `Unknown order sent.`
-        - `header` - Full response header. 
+        - `header` - Full response header.
 - `binance.error.ServerError`
     - This is thrown when server returns `5XX`, it's an issue from server side.
 

binance/__version__.py

@@ -1 +1 @@
-__version__ = "1.18.0"
+__version__ = "2.0.0-rc1"

binance/api.py

@@ -1,16 +1,14 @@
-import hmac
 import json
-import logging
-import hashlib
 from json import JSONDecodeError
-
+import logging
 import requests
 from .__version__ import __version__
 from binance.error import ClientError, ServerError
 from binance.lib.utils import get_timestamp
 from binance.lib.utils import cleanNoneValue
 from binance.lib.utils import encoded_string
 from binance.lib.utils import check_required_parameter
+from binance.lib.authentication import hmac_hashing, rsa_signature
 
 
 class API(object):
@@ -22,36 +20,40 @@ class API(object):
         proxies (obj, optional): Dictionary mapping protocol to the URL of the proxy. e.g. {'https': 'http://1.2.3.4:8080'}
         show_limit_usage (bool, optional): whether return limit usage(requests and/or orders). By default, it's False
         show_header (bool, optional): whether return the whole response header. By default, it's False
+        private_key (str, optional): RSA private key for RSA authentication
+        private_key_pass(str, optional): Password for PSA private key
     """
 
     def __init__(
         self,
-        key=None,
-        secret=None,
+        api_key=None,
+        api_secret=None,
         base_url=None,
         timeout=None,
         proxies=None,
         show_limit_usage=False,
         show_header=False,
+        private_key=None,
+        private_key_pass=None,
     ):
-        self.key = key
-        self.secret = secret
+        self.api_key = api_key
+        self.api_secret = api_secret
+        self.base_url = base_url
         self.timeout = timeout
+        self.proxies = None
         self.show_limit_usage = False
         self.show_header = False
-        self.proxies = None
+        self.private_key = private_key
+        self.private_key_pass = private_key_pass
         self.session = requests.Session()
         self.session.headers.update(
             {
                 "Content-Type": "application/json;charset=utf-8",
                 "User-Agent": "binance-connector/" + __version__,
-                "X-MBX-APIKEY": key,
+                "X-MBX-APIKEY": api_key,
             }
         )
 
-        if base_url:
-            self.base_url = base_url
-
         if show_limit_usage is True:
             self.show_limit_usage = True
 
@@ -70,16 +72,15 @@ def query(self, url_path, payload=None):
     def limit_request(self, http_method, url_path, payload=None):
         """limit request is for those endpoints require API key in the header"""
 
-        check_required_parameter(self.key, "apiKey")
+        check_required_parameter(self.api_key, "api_key")
         return self.send_request(http_method, url_path, payload=payload)
 
     def sign_request(self, http_method, url_path, payload=None):
         if payload is None:
             payload = {}
         payload["timestamp"] = get_timestamp()
         query_string = self._prepare_params(payload)
-        signature = self._get_sign(query_string)
-        payload["signature"] = signature
+        payload["signature"] = self._get_sign(query_string)
         return self.send_request(http_method, url_path, payload)
 
     def limited_encoded_sign_request(self, http_method, url_path, payload=None):
@@ -95,8 +96,9 @@ def limited_encoded_sign_request(self, http_method, url_path, payload=None):
             payload = {}
         payload["timestamp"] = get_timestamp()
         query_string = self._prepare_params(payload)
-        signature = self._get_sign(query_string)
-        url_path = url_path + "?" + query_string + "&signature=" + signature
+        url_path = (
+            url_path + "?" + query_string + "&signature=" + self._get_sign(query_string)
+        )
         return self.send_request(http_method, url_path)
 
     def send_request(self, http_method, url_path, payload=None):
@@ -146,9 +148,10 @@ def send_request(self, http_method, url_path, payload=None):
     def _prepare_params(self, params):
         return encoded_string(cleanNoneValue(params))
 
-    def _get_sign(self, data):
-        m = hmac.new(self.secret.encode("utf-8"), data.encode("utf-8"), hashlib.sha256)
-        return m.hexdigest()
+    def _get_sign(self, payload):
+        if self.private_key:
+            return rsa_signature(self.private_key, payload, self.private_key_pass)
+        return hmac_hashing(self.api_secret, payload)
 
     def _dispatch_request(self, http_method):
         return {

binance/lib/authentication.py

@@ -0,0 +1,18 @@
+import hmac
+import hashlib
+from base64 import b64encode
+from Crypto.PublicKey import RSA
+from Crypto.Hash import SHA256
+from Crypto.Signature import pkcs1_15
+
+
+def hmac_hashing(api_secret, payload):
+    m = hmac.new(api_secret.encode("utf-8"), payload.encode("utf-8"), hashlib.sha256)
+    return m.hexdigest()
+
+
+def rsa_signature(private_key, payload, private_key_pass=None):
+    private_key = RSA.import_key(private_key, passphrase=private_key_pass)
+    h = SHA256.new(payload.encode("utf-8"))
+    signature = pkcs1_15.new(private_key).sign(h)
+    return b64encode(signature)

binance/spot/__init__.py

@@ -2,10 +2,10 @@
 
 
 class Spot(API):
-    def __init__(self, key=None, secret=None, **kwargs):
+    def __init__(self, api_key=None, api_secret=None, **kwargs):
         if "base_url" not in kwargs:
             kwargs["base_url"] = "https://api.binance.com"
-        super().__init__(key, secret, **kwargs)
+        super().__init__(api_key, api_secret, **kwargs)
 
     # MARKETS
     from binance.spot.market import ping

docs/source/CHANGELOG.rst

@@ -2,6 +2,14 @@
 Changelog
 =========
 
+2.0.0-rc1 - 2022-11-29
+----------------------
+
+Added
+^^^^^
+
+* Add support for use of RSA Key to generate signatures
+
 1.18.0 - 2022-09-29
 -------------------
 
@@ -55,7 +63,7 @@ Added
 ^^^^^
 
 * New endpoint for Portfolio Margin:
-  
+
   * ``GET /sapi/v1/portfolio/pmLoan`` to query Portfolio Margin Bankruptcy Loan Record.
   * ``POST /sapi/v1/portfolio/repay`` to repay Portfolio Margin Bankruptcy Loan.
   * ``GET /sapi/v1/portfolio/collateralRate`` to get Portfolio Margin Collateral Rate.
@@ -64,17 +72,17 @@ Update
 ^^^^^^
 
 * Changes to ``POST /api/v3/order`` and ``POST /api/v3/order/cancelReplace``
-  
+
   * New optional field ``strategyId`` is a parameter used to identify an order as part of a strategy.
   * New optional field ``strategyType`` is a parameter used to identify what strategy was running. (E.g. If all the orders are part of spot grid strategy, it can be set to strategyType=1000000)
   * Note: ``strategyType`` cannot be less than 1000000.
-  
+
 * Changes to ``POST /api/v3/order/oco``
 
   * New optional fields ``limitStrategyId``, ``limitStrategyType``, ``stopStrategyId``, ``stopStrategyType``
   * These are the strategy metadata parameters for both legs of the OCO orders.
   * ``limitStrategyType`` and ``stopStrategyType`` both cannot be less than 1000000.
-  
+
 * ``asset`` is no longer mandatory in ``GET /sapi/v1/lending/project/position/list``
 
 1.15.0 - 2022-07-19

docs/source/getting_started.rst

@@ -40,7 +40,7 @@ Usage example:
    print(client.klines("BNBUSDT", "1h", limit=10))
 
    # api key/secret are required for user data endpoints
-   client = Spot(key='<api_key>', secret='<api_secret>')
+   client = Spot(api_key='<api_key>', api_secret='<api_secret>')
 
    # Get account and balance information
    print(client.account())
@@ -104,7 +104,7 @@ Anything beyond the limit will result in an error response from Binance server.
 
    from binance.spot import Spot as Client
 
-   client = Client(key, secret)
+   client = Client(api_key, api_secret)
    response = client.get_order('BTCUSDT', orderId=11, recvWindow=10000)
 
 

docs/source/intro.rst

@@ -89,12 +89,12 @@ RESTful APIs
 
 .. code-block:: python
 
-   from binance.spot import Spot 
+   from binance.spot import Spot
 
    client = Spot()
    print(client.time())
 
-   client = Spot(key='<api_key>', secret='<api_secret>')
+   client = Spot(api_key='<api_key>', api_secret='<api_secret>')
 
    # Get account information
    print(client.account())

examples/spot/blvt/blvt_info.py

@@ -6,10 +6,10 @@
 
 config_logging(logging, logging.DEBUG)
 
-key = ""
-secret = ""
+api_key = ""
+api_secret = ""
 
-client = Client(key, secret)
+client = Client(api_key, api_secret)
 
 logger = logging.getLogger(__name__)
 logger.info(client.blvt_info(tokenName="LINKUP"))

examples/spot/blvt/redeem_blvt.py

@@ -6,8 +6,8 @@
 
 config_logging(logging, logging.DEBUG)
 
-key = ""
-secret = ""
+api_key = ""
+api_secret = ""
 
-client = Client(key, secret)
+client = Client(api_key, api_secret)
 logging.info(client.redeem_blvt(tokenName="LINKUP", amount="10.05022099"))

examples/spot/blvt/redemption_record.py

@@ -6,8 +6,8 @@
 
 config_logging(logging, logging.DEBUG)
 
-key = ""
-secret = ""
+api_key = ""
+api_secret = ""
 
-client = Client(key, secret)
+client = Client(api_key, api_secret)
 logging.info(client.redemption_record(tokenName="LINKUP"))

examples/spot/blvt/subscribe_blvt.py

@@ -6,8 +6,8 @@
 
 config_logging(logging, logging.DEBUG)
 
-key = ""
-secret = ""
+api_key = ""
+api_secret = ""
 
-client = Client(key, secret)
+client = Client(api_key, api_secret)
 logging.info(client.subscribe_blvt(tokenName="LINKUP", cost="9.99999995"))

examples/spot/blvt/subscription_record.py

@@ -6,8 +6,8 @@
 
 config_logging(logging, logging.DEBUG)
 
-key = ""
-secret = ""
+api_key = ""
+api_secret = ""
 
-client = Client(key, secret)
+client = Client(api_key, api_secret)
 logging.info(client.subscription_record(tokenName="LINKUP"))

examples/spot/blvt/user_limit_info.py

@@ -6,8 +6,8 @@
 
 config_logging(logging, logging.DEBUG)
 
-key = ""
-secret = ""
+api_key = ""
+api_secret = ""
 
-client = Client(key, secret)
+client = Client(api_key, api_secret)
 logging.info(client.user_limit_info(tokenName="BTCDOWN"))

examples/spot/bswap/bswap_add_liquidity_preview.py

@@ -6,10 +6,10 @@
 
 config_logging(logging, logging.DEBUG)
 
-key = ""
-secret = ""
+api_key = ""
+api_secret = ""
 
-client = Client(key, secret)
+client = Client(api_key, api_secret)
 logging.info(
     client.bswap_add_liquidity_preview(
         poolId=2, type="SINGLE", quoteAsset="USDT", quoteQty=0.01