ostium-python-sdk 0.1.3__tar.gz → 0.1.5__tar.gz

{ostium_python_sdk-0.1.3 → ostium_python_sdk-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ostium-python-sdk
-Version: 0.1.3
+Version: 0.1.5
 Summary: A python based SDK developed for interacting with Ostium, a leveraged trading application for trading currencies, commodities, indices, crypto and more.
 Home-page: https://github.com/0xOstium/ostium-python-sdk
 Author: ami@ostium.io
@@ -13,7 +13,6 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: web3>=6.0.0
 
-
 # Ostium Python SDK
 
 A python based SDK developed for interacting with Ostium v1 Trading Platform (https://ostium.app/)
@@ -38,6 +37,45 @@ Developed using:
   python=3.8
 ```
 
+## Usage Example
+
+### Opening a Trade
+```python
+from ostium_python_sdk import OstiumSDK
+from dotenv import load_dotenv
+
+# Load environment variables if using .env file
+load_dotenv()
+
+# Initialize SDK (using environment variables)
+sdk = OstiumSDK(network="arbitrum")
+
+# Or initialize with explicit private key
+# sdk = OstiumSDK(
+#     network="arbitrum",
+#     private_key="your_private_key_here",
+#     rpc_url="https://arb1.arbitrum.io/rpc"
+# )
+
+# Define trade parameters
+trade_params = {
+    'collateral': 100,        # USDC amount
+    'leverage': 10,           # Leverage multiplier
+    'asset_type': 0,         # 0 for BTC
+    'direction': True,       # True for Long, False for Short
+    'order_type': 'MARKET'   # 'MARKET', 'LIMIT', or 'STOP'
+}
+
+try:
+    # Get latest price for BTC
+    latest_price = sdk.ostium.get_latest_price(trade_params['asset_type'])
+    
+    # Execute trade at current market price
+    receipt = sdk.ostium.perform_trade(trade_params, at_price=latest_price)
+    print(f"Trade successful! Transaction hash: {receipt['transactionHash'].hex()}")
+except Exception as e:
+    print(f"Trade failed: {str(e)}")
+
 ## Example Usage Script
 
 

{ostium_python_sdk-0.1.3 → ostium_python_sdk-0.1.5}/README.md

@@ -1,4 +1,3 @@
-
 # Ostium Python SDK
 
 A python based SDK developed for interacting with Ostium v1 Trading Platform (https://ostium.app/)
@@ -23,6 +22,45 @@ Developed using:
   python=3.8
 ```
 
+## Usage Example
+
+### Opening a Trade
+```python
+from ostium_python_sdk import OstiumSDK
+from dotenv import load_dotenv
+
+# Load environment variables if using .env file
+load_dotenv()
+
+# Initialize SDK (using environment variables)
+sdk = OstiumSDK(network="arbitrum")
+
+# Or initialize with explicit private key
+# sdk = OstiumSDK(
+#     network="arbitrum",
+#     private_key="your_private_key_here",
+#     rpc_url="https://arb1.arbitrum.io/rpc"
+# )
+
+# Define trade parameters
+trade_params = {
+    'collateral': 100,        # USDC amount
+    'leverage': 10,           # Leverage multiplier
+    'asset_type': 0,         # 0 for BTC
+    'direction': True,       # True for Long, False for Short
+    'order_type': 'MARKET'   # 'MARKET', 'LIMIT', or 'STOP'
+}
+
+try:
+    # Get latest price for BTC
+    latest_price = sdk.ostium.get_latest_price(trade_params['asset_type'])
+    
+    # Execute trade at current market price
+    receipt = sdk.ostium.perform_trade(trade_params, at_price=latest_price)
+    print(f"Trade successful! Transaction hash: {receipt['transactionHash'].hex()}")
+except Exception as e:
+    print(f"Trade failed: {str(e)}")
+
 ## Example Usage Script
 
 

{ostium_python_sdk-0.1.3 → ostium_python_sdk-0.1.5}/ostium_python_sdk/ostium.py

@@ -1,9 +1,8 @@
 import os
 import traceback
 from enum import Enum
-
-from .abi import usdc_abi, ostium_trading_abi, ostium_trading_storage_abi
 from web3 import Web3
+from .abi import usdc_abi, ostium_trading_abi, ostium_trading_storage_abi
 from .utils import convert_to_scaled_integer, fromErrorCodeToMessage, get_tp_sl_prices, to_base_units
 
 
@@ -14,14 +13,18 @@ class OpenOrderType(Enum):
 
 
 class Ostium:
-    def __init__(self, w3: Web3, usdc_address: str, ostium_trading_storage_address: str, ostium_trading_address: str) -> None:
-        self.web3 = w3
+    def __init__(self, w3: Web3, usdc_address: str, ostium_trading_storage_address: str, ostium_trading_address: str, private_key: str) -> None:
+        if not private_key:
+            raise ValueError(
+                "Private key is required for Ostium initialization")
 
+        self.web3 = w3
+        self.private_key = private_key
         self.usdc_address = usdc_address
         self.ostium_trading_storage_address = ostium_trading_storage_address
         self.ostium_trading_address = ostium_trading_address
 
-        # Create contract instance
+        # Create contract instances
         self.usdc_contract = self.web3.eth.contract(
             address=self.usdc_address, abi=usdc_abi)
         self.ostium_trading_storage_contract = self.web3.eth.contract(
@@ -29,26 +32,27 @@ class Ostium:
         self.ostium_trading_contract = self.web3.eth.contract(
             address=self.ostium_trading_address, abi=ostium_trading_abi)
 
+    def _get_account(self) -> Web3.eth.account:
+        """Get account from stored private key"""
+        return self.web3.eth.account.from_key(self.private_key)
+
     def get_block_number(self):
         return self.web3.eth.get_block('latest')['number']
 
     def get_nonce(self, address):
         return self.web3.eth.get_transaction_count(address)
 
-    def perform_trade(self, trade_params, pvt_key, at_price):
-        account = self.web3.eth.account.from_key(pvt_key)
-
+    def perform_trade(self, trade_params, at_price):
+        account = self._get_account()
         amount = to_base_units(trade_params['collateral'], decimals=6)
         self.__approve(account, amount)
+
         try:
-            # Log input trade parameters for verification
             print("Final trade parameters being sent:", trade_params)
-
             tp_price, sl_price = get_tp_sl_prices(trade_params)
-            # Define trade parameters and execute trade
+
             trade = {
                 'collateral': convert_to_scaled_integer(trade_params['collateral'], precision=5, scale=6),
-                # Example open price, adjust as needed
                 'openPrice': convert_to_scaled_integer(at_price),
                 'tp': convert_to_scaled_integer(tp_price),
                 'sl': convert_to_scaled_integer(sl_price),
@@ -59,7 +63,7 @@ class Ostium:
                 'buy': trade_params['direction']
             }
 
-            order_type = OpenOrderType.MARKET.value  # assume market order
+            order_type = OpenOrderType.MARKET.value
 
             if 'order_type' in trade_params:
                 if trade_params['order_type'] == 'LIMIT':
@@ -71,75 +75,65 @@ class Ostium:
                 else:
                     raise Exception('Invalid order type')
 
-            # Log the structured trade object to be sent
-            # print("Structured trade object:", trade)
-
             trade_tx = self.ostium_trading_contract.functions.openTrade(
                 trade, order_type, 9000).build_transaction({'from': account.address})
             trade_tx['nonce'] = self.get_nonce(account.address)
 
             signed_tx = self.web3.eth.account.sign_transaction(
-                trade_tx, private_key=account.key)
+                trade_tx, private_key=self.private_key)
             trade_tx_hash = self.web3.eth.send_raw_transaction(
                 signed_tx.raw_transaction)
-            # print('Trade TX Hash:', trade_tx_hash.hex())
-
-            # Wait for the trade transaction to be mined
             trade_receipt = self.web3.eth.wait_for_transaction_receipt(
                 trade_tx_hash)
             print('Trade Receipt:', trade_receipt)
             return trade_receipt
+
         except Exception as e:
             reason_string, suggestion = fromErrorCodeToMessage(e)
             print(
                 f"An error ({str(e)}) occurred during the trading process - parsed as {reason_string}")
-            # traceback.print_exc()  # This prints the full traceback
             raise Exception(
                 f'{reason_string}\n\n{suggestion}' if suggestion != None else reason_string)
 
-    # Cancel Limit and Stop orders
-
-    def cancel_limit_order(self, pairID, index, pvt_key):
-        account = self.web3.eth.account.from_key(pvt_key)
+    def cancel_limit_order(self, pairID, index):
+        account = self._get_account()
 
         trade_tx = self.ostium_trading_contract.functions.cancelOpenLimitOrder(
             int(pairID), int(index)).build_transaction({'from': account.address})
         trade_tx['nonce'] = self.get_nonce(account.address)
 
         signed_tx = self.web3.eth.account.sign_transaction(
-            trade_tx, private_key=account.key)
-        trade_tx_hash = self. web3.eth.send_raw_transaction(
+            trade_tx, private_key=self.private_key)
+        trade_tx_hash = self.web3.eth.send_raw_transaction(
             signed_tx.raw_transaction)
         print('Cancel Limit Order TX Hash:', trade_tx_hash.hex())
 
-        # Wait for the trade transaction to be mined
         trade_receipt = self.web3.eth.wait_for_transaction_receipt(
             trade_tx_hash)
         print('Cancel Limit Order Receipt:', trade_receipt)
         return trade_receipt
 
-    def close_trade(self, pairID, index, pvt_key):
-        account = self.web3.eth.account.from_key(pvt_key)
+    def close_trade(self, pairID, index):
+        account = self._get_account()
 
         trade_tx = self.ostium_trading_contract.functions.closeTradeMarket(
             int(pairID), int(index)).build_transaction({'from': account.address})
         trade_tx['nonce'] = self.get_nonce(account.address)
 
         signed_tx = self.web3.eth.account.sign_transaction(
-            trade_tx, private_key=account.key)
-        trade_tx_hash = self. web3.eth.send_raw_transaction(
+            trade_tx, private_key=self.private_key)
+        trade_tx_hash = self.web3.eth.send_raw_transaction(
             signed_tx.raw_transaction)
         print('Trade TX Hash:', trade_tx_hash.hex())
 
-        # Wait for the trade transaction to be mined
         trade_receipt = self.web3.eth.wait_for_transaction_receipt(
             trade_tx_hash)
         print('Trade Receipt:', trade_receipt)
         return trade_receipt
 
-    def add_collateral(self, pairID, index, collateral, pvt_key):
+    def add_collateral(self, pairID, index, collateral):
         try:
-            account = self.web3.eth.account.from_key(pvt_key)
+            account = self._get_account()
             amount = to_base_units(collateral, decimals=6)
             self.__approve(account, amount)
 
@@ -148,11 +142,11 @@ class Ostium:
             add_collateral_tx['nonce'] = self.get_nonce(account.address)
 
             signed_tx = self.web3.eth.account.sign_transaction(
-                add_collateral_tx, private_key=account.key)
+                add_collateral_tx, private_key=self.private_key)
             add_collateral_tx_hash = self.web3.eth.send_raw_transaction(
                 signed_tx.raw_transaction)
             print('Add Collateral TX Hash:', add_collateral_tx_hash.hex())
-            # Wait for the trade transaction to be mined
+
             add_collateral_receipt = self.web3.eth.wait_for_transaction_receipt(
                 add_collateral_tx_hash)
             print('Add Collateral Receipt:', add_collateral_receipt)
@@ -160,13 +154,12 @@ class Ostium:
 
         except Exception as e:
             print("An error occurred during the add collateral process:")
-            traceback.print_exc()  # This prints the full traceback
-            raise e  # Optionally re-raise the exception if you want it to propagate
+            traceback.print_exc()
+            raise e
 
-    def update_tp(self, pairID, index, tp, pvt_key):
+    def update_tp(self, pairID, index, tp):
         try:
-            account = self.web3.eth.account.from_key(pvt_key)
-
+            account = self._get_account()
             tp_value = to_base_units(tp, decimals=18)
 
             update_tp_tx = self.ostium_trading_contract.functions.updateTp(
@@ -174,18 +167,19 @@ class Ostium:
             update_tp_tx['nonce'] = self.get_nonce(account.address)
 
             signed_tx = self.web3.eth.account.sign_transaction(
-                update_tp_tx, private_key=account.key)
+                update_tp_tx, private_key=self.private_key)
             update_tp_tx_hash = self.web3.eth.send_raw_transaction(
                 signed_tx.raw_transaction)
             print('Update TP TX Hash:', update_tp_tx_hash.hex())
+
         except Exception as e:
             print("An error occurred during the update tp process:")
-            traceback.print_exc()  # This prints the full traceback
-            raise e  # Optionally re-raise the exception if you want it to propagate
+            traceback.print_exc()
+            raise e
 
-    def update_sl(self, pairID, index, sl, pvt_key):
+    def update_sl(self, pairID, index, sl):
         try:
-            account = self.web3.eth.account.from_key(pvt_key)
+            account = self._get_account()
             sl_value = to_base_units(sl, decimals=18)
 
             update_sl_tx = self.ostium_trading_contract.functions.updateSl(
@@ -193,24 +187,19 @@ class Ostium:
             update_sl_tx['nonce'] = self.get_nonce(account.address)
 
             signed_tx = self.web3.eth.account.sign_transaction(
-                update_sl_tx, private_key=account.key)
+                update_sl_tx, private_key=self.private_key)
             update_sl_tx_hash = self.web3.eth.send_raw_transaction(
                 signed_tx.raw_transaction)
             print('Update SL TX Hash:', update_sl_tx_hash.hex())
+
         except Exception as e:
-            print(f"An error occurred during the update sl process: {e}")
             reason_string, suggestion = fromErrorCodeToMessage(str(e))
             print(
                 f"An error occurred during the update sl process: {reason_string}")
-            # traceback.print_exc()  # This prints the full traceback
-            # Optionally re-raise the exception if you want it to propagate
             raise Exception(
                 f'{reason_string}\n\n{suggestion}' if suggestion != None else reason_string)
 
     def __approve(self, account, collateral):
-        # Approve the transaction
-        # Approval tx should only be done if sufficient amount is not already approved.
-
         allowance = self.usdc_contract.functions.allowance(
             account.address, self.ostium_trading_storage_address).call()
 
@@ -223,25 +212,23 @@ class Ostium:
             approve_tx['nonce'] = self.get_nonce(account.address)
 
             signed_tx = self.web3.eth.account.sign_transaction(
-                approve_tx, private_key=account.key)
+                approve_tx, private_key=self.private_key)
             approve_tx_hash = self.web3.eth.send_raw_transaction(
                 signed_tx.raw_transaction)
             print('Approval TX Hash:', approve_tx_hash.hex())
 
-            # Ensure the approval transaction is mined
             approve_receipt = self.web3.eth.wait_for_transaction_receipt(
                 approve_tx_hash)
             print('Approval Receipt:', approve_receipt)
 
-    def withdraw(self, amount, receiving_address, pvt_key):
+    def withdraw(self, amount, receiving_address):
         try:
-            account = self.web3.eth.account.from_key(pvt_key)
+            account = self._get_account()
             amount_in_base_units = to_base_units(amount, decimals=6)
 
             if not self.web3.is_address(receiving_address):
                 raise ValueError("Invalid Arbitrum address format")
 
-            # Use USDCs' transfer function to send funds to the receiving address
             transfer_tx = self.usdc_contract.functions.transfer(
                 receiving_address,
                 amount_in_base_units
@@ -250,7 +237,7 @@ class Ostium:
             transfer_tx['nonce'] = self.get_nonce(account.address)
 
             signed_tx = self.web3.eth.account.sign_transaction(
-                transfer_tx, private_key=account.key)
+                transfer_tx, private_key=self.private_key)
             transfer_tx_hash = self.web3.eth.send_raw_transaction(
                 signed_tx.raw_transaction)
             print('Transfer TX Hash:', transfer_tx_hash.hex())

ostium_python_sdk-0.1.5/ostium_python_sdk/sdk.py

@@ -0,0 +1,39 @@
+from dotenv import load_dotenv
+import os
+from web3 import Web3
+from .ostium import Ostium
+
+
+class OstiumSDK:
+    def __init__(self, network="arbitrum", private_key: str = None, rpc_url: str = None):
+        load_dotenv()
+        self.private_key = private_key or os.getenv('OSTIUM_PRIVATE_KEY')
+        if not self.private_key:
+            raise ValueError(
+                "No private key provided. Please provide via constructor or OSTIUM_PRIVATE_KEY environment variable")
+
+        # Use provided RPC URL or get from env
+        self.rpc_url = rpc_url or os.getenv('OSTIUM_RPC_URL')
+        if not self.rpc_url:
+            raise ValueError(
+                "No RPC URL provided. Please provide via constructor or OSTIUM_RPC_URL environment variable")
+
+        # Initialize Web3
+        self.w3 = Web3(Web3.HTTPProvider(self.rpc_url))
+
+        # Set network-specific addresses
+        if network == "arbitrum":
+            self.usdc_address = "0xaf88d065e77c8cC2239327C5EDb3A432268e5831"
+            self.ostium_trading_storage_address = "0x937F3002dE1C7b9E6f461f5F5C5Ac5cA8A1a6339"
+            self.ostium_trading_address = "0x4c78B6566864e374a5949C6EE1408Fd0Fe01A6ED"
+        else:
+            raise ValueError(f"Unsupported network: {network}")
+
+        # Initialize Ostium instance
+        self.ostium = Ostium(
+            self.w3,
+            self.usdc_address,
+            self.ostium_trading_storage_address,
+            self.ostium_trading_address,
+            private_key=self.private_key
+        )

{ostium_python_sdk-0.1.3 → ostium_python_sdk-0.1.5}/ostium_python_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ostium-python-sdk
-Version: 0.1.3
+Version: 0.1.5
 Summary: A python based SDK developed for interacting with Ostium, a leveraged trading application for trading currencies, commodities, indices, crypto and more.
 Home-page: https://github.com/0xOstium/ostium-python-sdk
 Author: ami@ostium.io
@@ -13,7 +13,6 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: web3>=6.0.0
 
-
 # Ostium Python SDK
 
 A python based SDK developed for interacting with Ostium v1 Trading Platform (https://ostium.app/)
@@ -38,6 +37,45 @@ Developed using:
   python=3.8
 ```
 
+## Usage Example
+
+### Opening a Trade
+```python
+from ostium_python_sdk import OstiumSDK
+from dotenv import load_dotenv
+
+# Load environment variables if using .env file
+load_dotenv()
+
+# Initialize SDK (using environment variables)
+sdk = OstiumSDK(network="arbitrum")
+
+# Or initialize with explicit private key
+# sdk = OstiumSDK(
+#     network="arbitrum",
+#     private_key="your_private_key_here",
+#     rpc_url="https://arb1.arbitrum.io/rpc"
+# )
+
+# Define trade parameters
+trade_params = {
+    'collateral': 100,        # USDC amount
+    'leverage': 10,           # Leverage multiplier
+    'asset_type': 0,         # 0 for BTC
+    'direction': True,       # True for Long, False for Short
+    'order_type': 'MARKET'   # 'MARKET', 'LIMIT', or 'STOP'
+}
+
+try:
+    # Get latest price for BTC
+    latest_price = sdk.ostium.get_latest_price(trade_params['asset_type'])
+    
+    # Execute trade at current market price
+    receipt = sdk.ostium.perform_trade(trade_params, at_price=latest_price)
+    print(f"Trade successful! Transaction hash: {receipt['transactionHash'].hex()}")
+except Exception as e:
+    print(f"Trade failed: {str(e)}")
+
 ## Example Usage Script
 
 

{ostium_python_sdk-0.1.3 → ostium_python_sdk-0.1.5}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="ostium-python-sdk",
-    version="0.1.3",
+    version="0.1.5",
     packages=find_packages(),
     install_requires=[
         "web3>=6.0.0",

ostium_python_sdk-0.1.3/ostium_python_sdk/sdk.py

@@ -1,33 +0,0 @@
-from typing import Optional
-from web3 import Web3
-from .config import NetworkConfig
-from .ostium import Ostium
-# from .formulae import Formulae
-from .subgraph import SubgraphClient
-from .price import Price
-from .balance import Balance
-
-
-class OstiumSDK:
-    def __init__(
-        self,
-        network_config: NetworkConfig,
-        custom_rpc_url: Optional[str] = None,
-        custom_graph_url: Optional[str] = None
-    ):
-        self.config = network_config
-        self.w3 = Web3(Web3.HTTPProvider(
-            custom_rpc_url or network_config.rpc_url
-        ))
-        self.ostium = Ostium(
-            self.w3,
-            network_config.contracts["usdc"],
-            network_config.contracts["trading"],
-            network_config.contracts["tradingStorage"]
-        )
-        # self.formulae = Formulae()
-        self.subgraph = SubgraphClient(
-            custom_graph_url or network_config.graph_url
-        )
-        self.price = Price()
-        self.balance = Balance(self.w3, network_config.contracts["usdc"])