[EXC-714] Introduced top level module (#57)

shahzaib-sheikh · YameenMalik · web-flow · commit 0f6ac9786270 · 2023-03-23T04:58:07.000+05:00
* bumped to 0.1.0 * updated examples * added keywords * updated client initialization * using aiohttp * updated all api calls to wait * uncommented limit order * get contract address method is async * minor update * subscribe_user_update_by_token is async * fetching parent leverage from exchange * extract params in get funding history * defaulted query to be empty * removed empty query param * Added top level firefly module * Updated README.md file * Updated GetFundingHistoryResponse's data property type to List to make it compatible with python version 3.8 (#59) * Updated GetOrderbookRequest property symbol's type (#58) * Bumped version to 1.1.0 --------- Co-authored-by: YameenMalik <yameen@seed.im> Co-authored-by: Yameen Malik <65854545+YameenMalik@users.noreply.github.com>
diff --git a/README.md b/README.md
@@ -32,17 +32,16 @@ When initializing the client, users must accept [terms and conditions](https://f
     "onboardingUrl": "https://testnet.firefly.exchange",
 },
 ```
-Users can import predefined networks from [constants](https://github.com/fireflyprotocol/firefly_exchange_client/blob/main/src/constants.py):
+Users can import predefined networks from [constants](https://github.com/fireflyprotocol/firefly_exchange_client/blob/main/src/firefly_exchange_client/constants.py):
 ```python
-from constants import Networks
+from firefly_exchange_client import Networks
 ```
 For testing purposes use `Networks[TESTNET_ARBITRUM]` and for production please use `Networks[MAINNET_ARBITRUM]`
 ​
 ​
 ```python
 from config import TEST_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from constants import Networks
+from firefly_exchange_client import FireflyClient, Networks
 from pprint import pprint
 import asyncio
 
@@ -75,10 +74,7 @@ if __name__ == "__main__":
 ​
 **Placing Orders:**
 ```python
-from firefly_exchange_client import FireflyClient
-from constants import Networks
-from enumerations import MARKET_SYMBOLS, ORDER_SIDE, ORDER_TYPE
-from interfaces import OrderSignatureRequest
+from firefly_exchange_client import FireflyClient, Networks, MARKET_SYMBOLS, ORDER_SIDE, ORDER_TYPE, OrderSignatureRequest
 ​import asyncio
 
 # initialize
@@ -108,10 +104,7 @@ print(resp)
 ​
 **Listening To Events Using Socket.io:**
 ```python
-from firefly_exchange_client import FireflyClient
-from constants import Networks
-from enumerations import MARKET_SYMBOLS, ORDER_SIDE, ORDER_TYPE
-from interfaces import OrderSignatureRequest
+from firefly_exchange_client import FireflyClient, Networks, MARKET_SYMBOLS, ORDER_SIDE, ORDER_TYPE, OrderSignatureRequest
 ​
 def callback(event):
     print("Event data:", event)
@@ -147,10 +140,7 @@ Look at the [example](https://github.com/fireflyprotocol/firefly_exchange_client
 
 **Listening To Events Using Web Sockets:**
 ```python
-from firefly_exchange_client import FireflyClient
-from constants import Networks
-from enumerations import MARKET_SYMBOLS, ORDER_SIDE, ORDER_TYPE, SOCKET_EVENTS
-from interfaces import OrderSignatureRequest
+from firefly_exchange_client import FireflyClient, Networks, MARKET_SYMBOLS, ORDER_SIDE, ORDER_TYPE, SOCKET_EVENTS, OrderSignatureRequest
 import time
 def callback(event):
     print("Event data:", event)
diff --git a/examples/1.initialization.py b/examples/1.initialization.py
@@ -1,6 +1,5 @@
 from config import TEST_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from constants import Networks
+from firefly_exchange_client import FireflyClient, Networks
 from pprint import pprint
 import asyncio
 
diff --git a/examples/10.sockets.py b/examples/10.sockets.py
@@ -1,8 +1,6 @@
 import time
 from config import TEST_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from constants import Networks
-from enumerations import MARKET_SYMBOLS, SOCKET_EVENTS
+from firefly_exchange_client import FireflyClient, Networks, MARKET_SYMBOLS, SOCKET_EVENTS
 import asyncio
 
 def callback(event):
diff --git a/examples/11.sub_accounts.py b/examples/11.sub_accounts.py
@@ -1,8 +1,5 @@
 from config import TEST_ACCT_KEY, TEST_SUB_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from enumerations import MARKET_SYMBOLS, ORDER_SIDE, ORDER_TYPE
-from constants import Networks
-from interfaces import OrderSignatureRequest
+from firefly_exchange_client import FireflyClient, MARKET_SYMBOLS, ORDER_SIDE, ORDER_TYPE, Networks, OrderSignatureRequest
 import asyncio
 
 
diff --git a/examples/12.open_order_event.py b/examples/12.open_order_event.py
@@ -4,11 +4,7 @@
 an event, log its data and terminate connection
 '''
 from config import TEST_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from constants import Networks
-from enumerations import MARKET_SYMBOLS, SOCKET_EVENTS
-from interfaces import OrderSignatureRequest
-from enumerations import MARKET_SYMBOLS, ORDER_SIDE, ORDER_TYPE
+from firefly_exchange_client import FireflyClient, Networks, MARKET_SYMBOLS, SOCKET_EVENTS, ORDER_SIDE, ORDER_TYPE, OrderSignatureRequest
 import asyncio
 
 
diff --git a/examples/13.orderbook_updates.py b/examples/13.orderbook_updates.py
@@ -3,11 +3,7 @@
 In this code example we open a socket connection and listen to orderbook update event
 '''
 from config import TEST_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from constants import Networks
-from enumerations import MARKET_SYMBOLS, SOCKET_EVENTS
-from interfaces import OrderSignatureRequest
-from enumerations import MARKET_SYMBOLS, ORDER_SIDE, ORDER_TYPE
+from firefly_exchange_client import FireflyClient, Networks, MARKET_SYMBOLS, SOCKET_EVENTS, ORDER_SIDE, ORDER_TYPE, OrderSignatureRequest
 import asyncio
 
 
diff --git a/examples/14.web_sockets.py b/examples/14.web_sockets.py
@@ -1,15 +1,11 @@
 import time
 from config import TEST_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from constants import Networks
-from enumerations import MARKET_SYMBOLS, SOCKET_EVENTS
+from firefly_exchange_client import FireflyClient, Networks, MARKET_SYMBOLS, SOCKET_EVENTS, config_logging
 import asyncio
 import logging
-from utilities import config_logging
 
 config_logging(logging, logging.DEBUG)
 
-
 def callback(event):
     print("Event data:", event)
 
diff --git a/examples/15.get_funding_history.py b/examples/15.get_funding_history.py
@@ -1,10 +1,7 @@
 from config import TEST_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from constants import Networks
-from enumerations import MARKET_SYMBOLS
+from firefly_exchange_client import FireflyClient, Networks, MARKET_SYMBOLS, GetFundingHistoryRequest
 from pprint import pprint
 import asyncio
-from interfaces import GetFundingHistoryRequest
 
 async def main():
     client = FireflyClient(True, Networks[TEST_NETWORK], TEST_ACCT_KEY)
diff --git a/examples/2.user_info.py b/examples/2.user_info.py
@@ -1,7 +1,5 @@
 from config import TEST_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from constants import Networks
-from enumerations import MARKET_SYMBOLS
+from firefly_exchange_client import FireflyClient, Networks, MARKET_SYMBOLS
 from pprint import pprint
 import asyncio
 
diff --git a/examples/3.balance.py b/examples/3.balance.py
@@ -1,6 +1,5 @@
 from config import TEST_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from constants import Networks
+from firefly_exchange_client import FireflyClient, Networks
 import asyncio
 
 
diff --git a/examples/4.placing_orders.py b/examples/4.placing_orders.py
@@ -1,8 +1,5 @@
 from config import TEST_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from constants import Networks
-from enumerations import MARKET_SYMBOLS, ORDER_SIDE, ORDER_TYPE
-from interfaces import OrderSignatureRequest
+from firefly_exchange_client import FireflyClient, Networks, MARKET_SYMBOLS, ORDER_SIDE, ORDER_TYPE, OrderSignatureRequest
 import asyncio
 
 
diff --git a/examples/5.adjusting_leverage.py b/examples/5.adjusting_leverage.py
@@ -1,7 +1,5 @@
 from config import TEST_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from constants import Networks
-from enumerations import MARKET_SYMBOLS
+from firefly_exchange_client import FireflyClient, Networks, MARKET_SYMBOLS
 import asyncio
 
 
diff --git a/examples/6.adjusting_margin.py b/examples/6.adjusting_margin.py
@@ -1,7 +1,5 @@
 from config import TEST_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from constants import Networks
-from enumerations import MARKET_SYMBOLS, ADJUST_MARGIN
+from firefly_exchange_client import FireflyClient, Networks, MARKET_SYMBOLS, ADJUST_MARGIN
 from eth_utils import from_wei
 import asyncio
 
diff --git a/examples/7.cancelling_orders.py b/examples/7.cancelling_orders.py
@@ -1,8 +1,6 @@
 import time
 from config import TEST_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from constants import Networks
-from enumerations import MARKET_SYMBOLS, ORDER_SIDE, ORDER_TYPE
+from firefly_exchange_client import FireflyClient, Networks, MARKET_SYMBOLS, ORDER_SIDE, ORDER_TYPE
 from pprint import pprint
 import asyncio
 
diff --git a/examples/8.exchange_data.py b/examples/8.exchange_data.py
@@ -1,7 +1,5 @@
 from config import TEST_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from constants import Networks
-from enumerations import MARKET_SYMBOLS, Interval, TRADE_TYPE
+from firefly_exchange_client import FireflyClient, Networks, MARKET_SYMBOLS, TRADE_TYPE, Interval
 from pprint import pprint
 import asyncio
     
diff --git a/examples/9.user_data.py b/examples/9.user_data.py
@@ -1,7 +1,5 @@
 from config import TEST_ACCT_KEY, TEST_NETWORK
-from firefly_exchange_client import FireflyClient
-from constants import Networks
-from enumerations import MARKET_SYMBOLS, ORDER_STATUS
+from firefly_exchange_client import FireflyClient, Networks, MARKET_SYMBOLS, ORDER_STATUS
 from pprint import pprint
 import asyncio
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "firefly_exchange_client"
-version = "0.1.0"
+version = "0.1.1"
 description = "Library to interact with firefly exchange protocol including its off-chain api-gateway and on-chain contracts"
 readme = "README.md"
 requires-python = ">=3.8"
diff --git a/src/classes/__init__.py b/src/classes/__init__.py
diff --git a/src/firefly_exchange_client/__init__.py b/src/firefly_exchange_client/__init__.py
@@ -0,0 +1,7 @@
+from .api_service import *
+from .client import *
+from .constants import *
+from .enumerations import *
+from .interfaces import *
+from .utilities import *
+from .contract_abis import *
diff --git a/src/firefly_exchange_client/api_service.py b/src/firefly_exchange_client/api_service.py
@@ -1,5 +1,5 @@
 import aiohttp
-from interfaces import *
+from .interfaces import *
 
 class APIService():
     def __init__(self, url):
diff --git a/src/firefly_exchange_client/client.py b/src/firefly_exchange_client/client.py
@@ -1,16 +1,16 @@
-from api_service import APIService
-from contracts import Contracts
-from order_signer import OrderSigner
-from onboarding_signer import OnboardingSigner
-from utilities import *
-from constants import TIME, SERVICE_URLS
-from interfaces import *
+from .api_service import APIService
+from .contracts import Contracts
+from .order_signer import OrderSigner
+from .onboarding_signer import OnboardingSigner
+from .utilities import *
+from .constants import TIME, SERVICE_URLS
+from .interfaces import *
+from .sockets import Sockets
+from .enumerations import *
+from .websocket_client import WebsocketClient
+
 from eth_account import Account
-from sockets import Sockets
-from enumerations import *
-import asyncio
 from eth_utils import to_wei, from_wei
-from websocket_client import WebsocketClient
 
 class FireflyClient:
     def __init__(self, are_terms_accepted, network, private_key):
diff --git a/src/firefly_exchange_client/constants.py b/src/firefly_exchange_client/constants.py
diff --git a/src/firefly_exchange_client/contract_abis.py b/src/firefly_exchange_client/contract_abis.py
diff --git a/src/firefly_exchange_client/contracts.py b/src/firefly_exchange_client/contracts.py
@@ -1,5 +1,4 @@
-import json, os
-import contract_abis
+from .contract_abis import MarginBank, Perpetual, USDC
 
 class Contracts:
     def __init__(self):
@@ -43,11 +42,11 @@ def get_contract_abi(self,name):
         """
 
         if name == "MarginBank":
-            return contract_abis.MarginBank["abi"]
+            return MarginBank["abi"]
         elif name == "Perpetual":
-            return contract_abis.Perpetual["abi"]
+            return Perpetual["abi"]
         elif name == "USDC":
-            return contract_abis.USDC["abi"]
+            return USDC["abi"]
         else:
             raise Exception("Unknown contract name: {}".format(name))
             
diff --git a/src/firefly_exchange_client/enumerations.py b/src/firefly_exchange_client/enumerations.py
diff --git a/src/firefly_exchange_client/interfaces.py b/src/firefly_exchange_client/interfaces.py
@@ -1,5 +1,5 @@
-from typing import TypedDict
-from enumerations import *
+from typing import TypedDict, List
+from .enumerations import *
 
 class Order(TypedDict):
     isBuy: bool 
@@ -40,7 +40,7 @@ class PlaceOrderRequest(OrderSignatureResponse):
   clientId: str # id of the client
 
 class GetOrderbookRequest(TypedDict):
-  symbol: str
+  symbol: MARKET_SYMBOLS
   limit: int # number of bids/asks to retrieve, should be <= 50
 
 class OnboardingMessage(TypedDict):
@@ -158,4 +158,4 @@ class FundingHistoryResponse(TypedDict):
 class GetFundingHistoryResponse(TypedDict):
   isMoreDataAvailable: bool # boolean indicating if there is more data available
   nextCursor: int # next page number
-  data: list[FundingHistoryResponse]
+  data: List[FundingHistoryResponse]
diff --git a/src/firefly_exchange_client/onboarding_signer.py b/src/firefly_exchange_client/onboarding_signer.py
@@ -1,6 +1,6 @@
 from web3 import Web3
-from interfaces import *
-from signer import Signer
+from .interfaces import *
+from .signer import Signer
 
 class OnboardingSigner(Signer):
     def __init__(self):
diff --git a/src/firefly_exchange_client/order_signer.py b/src/firefly_exchange_client/order_signer.py
@@ -1,8 +1,8 @@
 from web3 import Web3
-import utilities
-import constants
-from signer import Signer
-from interfaces import Order
+from .utilities import bn_to_bytes8, hash_string, address_to_bytes32
+from .constants import *
+from .signer import Signer
+from .interfaces import Order
 
 
 class OrderSigner(Signer):
@@ -17,12 +17,12 @@ def get_order_flags(self, order):
         flag = 0 
 
         if order["reduceOnly"]:
-            flag += constants.ORDER_FLAGS["IS_DECREASE_ONLY"] 
+            flag += ORDER_FLAGS["IS_DECREASE_ONLY"] 
 
         if order["isBuy"]:
-            flag += constants.ORDER_FLAGS["IS_BUY"] 
+            flag += ORDER_FLAGS["IS_BUY"] 
         
-        saltBytes = utilities.bn_to_bytes8(order["salt"])
+        saltBytes = bn_to_bytes8(order["salt"])
 
         return b''.join([
             "0x".encode('utf-8'), 
@@ -43,11 +43,11 @@ def get_domain_hash(self):
             'bytes32'
         ],
         [
-            utilities.hash_string(constants.EIP712_DOMAIN_STRING),
-            utilities.hash_string(self.domain),
-            utilities.hash_string(self.version),
+            hash_string(EIP712_DOMAIN_STRING),
+            hash_string(self.domain),
+            hash_string(self.version),
             self.network_id,
-            utilities.address_to_bytes32(self.contract_address)
+            address_to_bytes32(self.contract_address)
         ]
     ).hex()
 
@@ -73,13 +73,13 @@ def get_order_hash(self, order:Order):
                 ],
 
             values=[
-                utilities.hash_string(constants.EIP712_ORDER_STRUCT_STRING),
+                hash_string(EIP712_ORDER_STRUCT_STRING),
                 flags,
                 int(order["quantity"]),
                 int(order["price"]),
                 int(order["triggerPrice"]),
                 int(order["leverage"]),
-                utilities.address_to_bytes32(order["maker"]),
+                address_to_bytes32(order["maker"]),
                 int(order["expiration"])
             ]
         ).hex()
@@ -115,8 +115,8 @@ def sign_cancellation_hash(self,order_hash:list):
         struct_hash = Web3.solidityKeccak(
             abi_types=['bytes32','bytes32','bytes32'],
             values=[
-                utilities.hash_string(constants.EIP712_CANCEL_ORDER_STRUCT_STRING),
-                utilities.hash_string("Cancel Orders"),
+                hash_string(EIP712_CANCEL_ORDER_STRUCT_STRING),
+                hash_string("Cancel Orders"),
                 Web3.solidityKeccak(
                     abi_types=['bytes32' for i in range(len(order_hash))],
                     values=[hash for hash in order_hash]
diff --git a/src/firefly_exchange_client/signer.py b/src/firefly_exchange_client/signer.py
diff --git a/src/firefly_exchange_client/socket_manager.py b/src/firefly_exchange_client/socket_manager.py
diff --git a/src/firefly_exchange_client/sockets.py b/src/firefly_exchange_client/sockets.py
@@ -1,5 +1,5 @@
 import socketio
-from enumerations import MARKET_SYMBOLS, SOCKET_EVENTS
+from .enumerations import MARKET_SYMBOLS, SOCKET_EVENTS
 
 sio = socketio.Client()
       
diff --git a/src/firefly_exchange_client/utilities.py b/src/firefly_exchange_client/utilities.py
diff --git a/src/firefly_exchange_client/websocket_client.py b/src/firefly_exchange_client/websocket_client.py
