Release v1.1.3 (#28)

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [1.1.3] - 2024-FEB-13
+
+### Added
+- Full MyPy annotations with return types for function definitions
+
 ## [1.1.2] - 2024-FEB-9
 
 ### Added

README.md

@@ -6,7 +6,7 @@
 Welcome to the official Coinbase Advanced API Python SDK. This python project was created to allow coders to easily plug into the [Coinbase Advanced API](https://docs.cloud.coinbase.com/advanced-trade-api/docs/welcome).
 This SDK also supports easy connection to the [Coinbase Advanced Trade WebSocket API](https://docs.cloud.coinbase.com/advanced-trade-api/docs/ws-overview).
 
-For thorough documentation of all available functions, refer to the following link: https://coinbase.github.io/coinbase-advanced-py/
+For thorough documentation of all available functions, refer to the following link: https://coinbase.github.io/coinbase-advanced-py
 
 ## Installation
 

coinbase/__version__.py

@@ -1 +1 @@
-__version__ = "1.1.2"
+__version__ = "1.1.3"

coinbase/jwt_generator.py

@@ -7,7 +7,7 @@
 from coinbase.constants import BASE_URL, REST_SERVICE, WS_SERVICE
 
 
-def build_jwt(key_var, secret_var, service, uri=None):
+def build_jwt(key_var, secret_var, service, uri=None) -> str:
     """
     :meta private:
     """
@@ -44,7 +44,7 @@ def build_jwt(key_var, secret_var, service, uri=None):
     return jwt_token
 
 
-def build_rest_jwt(uri, key_var, secret_var):
+def build_rest_jwt(uri, key_var, secret_var) -> str:
     """
     **Build REST JWT**
     __________
@@ -64,7 +64,7 @@ def build_rest_jwt(uri, key_var, secret_var):
     return build_jwt(key_var, secret_var, REST_SERVICE, uri=uri)
 
 
-def build_ws_jwt(key_var, secret_var):
+def build_ws_jwt(key_var, secret_var) -> str:
     """
     **Build WebSocket JWT**
     __________
@@ -83,7 +83,7 @@ def build_ws_jwt(key_var, secret_var):
     return build_jwt(key_var, secret_var, WS_SERVICE)
 
 
-def format_jwt_uri(method, path):
+def format_jwt_uri(method, path) -> str:
     """
     **Format JWT URI**
     __________

coinbase/rest/accounts.py

@@ -1,11 +1,11 @@
-from typing import Optional
+from typing import Any, Dict, Optional
 
 from coinbase.constants import API_PREFIX
 
 
 def get_accounts(
     self, limit: Optional[int] = None, cursor: Optional[str] = None, **kwargs
-):
+) -> Dict[str, Any]:
     """
     **List Accounts**
     _________________
@@ -28,7 +28,7 @@ def get_accounts(
     return self.get(endpoint, params=params, **kwargs)
 
 
-def get_account(self, account_uuid: str, **kwargs):
+def get_account(self, account_uuid: str, **kwargs) -> Dict[str, Any]:
     """
 
     **Get Account**

coinbase/rest/common.py

@@ -1,7 +1,9 @@
+from typing import Any, Dict
+
 from coinbase.constants import API_PREFIX
 
 
-def get_unix_time(self, **kwargs):
+def get_unix_time(self, **kwargs) -> Dict[str, Any]:
     """
     **Get UNIX Time**
     _________________

coinbase/rest/convert.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Any, Dict, Optional
 
 from coinbase.constants import API_PREFIX
 
@@ -11,7 +11,7 @@ def create_convert_quote(
     user_incentive_id: Optional[str] = None,
     code_val: Optional[str] = None,
     **kwargs,
-):
+) -> Dict[str, Any]:
     """
     **Create Convert Quote**
     ________________________
@@ -54,7 +54,7 @@ def create_convert_quote(
 
 def get_convert_trade(
     self, trade_id: str, from_account: str, to_account: str, **kwargs
-):
+) -> Dict[str, Any]:
     """
     **Get Convert Trade**
     _____________________
@@ -83,7 +83,7 @@ def get_convert_trade(
 
 def commit_convert_trade(
     self, trade_id: str, from_account: str, to_account: str, **kwargs
-):
+) -> Dict[str, Any]:
     """
     **Commit Convert Trade**
     ________________________

coinbase/rest/fees.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Any, Dict, Optional
 
 from coinbase.constants import API_PREFIX
 
@@ -8,7 +8,7 @@ def get_transaction_summary(
     product_type: Optional[str] = None,
     contract_expiry_type: Optional[str] = None,
     **kwargs,
-):
+) -> Dict[str, Any]:
     """
     **Get Transactions Summary**
     _____________________________

coinbase/rest/futures.py

@@ -1,7 +1,9 @@
+from typing import Any, Dict
+
 from coinbase.constants import API_PREFIX
 
 
-def get_futures_balance_summary(self, **kwargs):
+def get_futures_balance_summary(self, **kwargs) -> Dict[str, Any]:
     """
     **Get Futures Balance Summary**
     _______________________________
@@ -24,7 +26,7 @@ def get_futures_balance_summary(self, **kwargs):
     return self.get(endpoint, **kwargs)
 
 
-def list_futures_positions(self, **kwargs):
+def list_futures_positions(self, **kwargs) -> Dict[str, Any]:
     """
     **List Futures Positions**
     __________________________
@@ -47,7 +49,7 @@ def list_futures_positions(self, **kwargs):
     return self.get(endpoint, **kwargs)
 
 
-def get_futures_position(self, product_id: str, **kwargs):
+def get_futures_position(self, product_id: str, **kwargs) -> Dict[str, Any]:
     """
     **Get Futures Position**
     _________________________
@@ -70,7 +72,7 @@ def get_futures_position(self, product_id: str, **kwargs):
     return self.get(endpoint, **kwargs)
 
 
-def schedule_futures_sweep(self, usd_amount: str, **kwargs):
+def schedule_futures_sweep(self, usd_amount: str, **kwargs) -> Dict[str, Any]:
     """
     **Schedule Futures Sweep**
     __________________________
@@ -95,7 +97,7 @@ def schedule_futures_sweep(self, usd_amount: str, **kwargs):
     return self.post(endpoint, data=data, **kwargs)
 
 
-def list_futures_sweeps(self, **kwargs):
+def list_futures_sweeps(self, **kwargs) -> Dict[str, Any]:
     """
     **List Futures Sweeps**
     _______________________
@@ -118,7 +120,7 @@ def list_futures_sweeps(self, **kwargs):
     return self.get(endpoint, **kwargs)
 
 
-def cancel_pending_futures_sweep(self, **kwargs):
+def cancel_pending_futures_sweep(self, **kwargs) -> Dict[str, Any]:
     """
     **Cancel Pending Futures Sweep**
     ________________________________

coinbase/rest/market_data.py

@@ -1,11 +1,11 @@
-from typing import Optional
+from typing import Any, Dict, Optional
 
 from coinbase.constants import API_PREFIX
 
 
 def get_candles(
     self, product_id: str, start: str, end: str, granularity: str, **kwargs
-):
+) -> Dict[str, Any]:
     """
     **Get Product Candles**
     __________
@@ -41,7 +41,7 @@ def get_market_trades(
     start: Optional[str] = None,
     end: Optional[str] = None,
     **kwargs,
-):
+) -> Dict[str, Any]:
     """
     **Get Market Trades**
     _____________________