ostium-python-sdk 0.1.34__tar.gz → 0.1.36__tar.gz

{ostium_python_sdk-0.1.34 → ostium_python_sdk-0.1.36}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ostium-python-sdk
-Version: 0.1.34
+Version: 0.1.36
 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
@@ -90,7 +90,6 @@ You can instantiate the SDK with the following parameters.
 Ostium Platform is deployed on Arbitrum. You can use the testnet or mainnet config via the `NetworkConfig` class, see below for an example.
 
 
-**NOTE: You can also use the SDK _without_ providing a private key, in which case you will be limited to read only operations on the SDK.**
 
 ```python
 from dotenv import load_dotenv
@@ -117,8 +116,11 @@ sdk = OstiumSDK(configTestnet, private_key)
 # sdk = OstiumSDK(configMainnet, private_key)
 #
 ```
+
 <b>NOTE:</b> create a .env file with PRIVATE_KEY and RPC_URL to use the SDK. An RPC URL is required to use the SDK. You can get one by signing up for a free account at https://www.alchemy.com/ and creating an app. 
 
+**NOTE: You can also use the SDK _without_ providing a private key, in which case you will be limited to read only operations on the SDK.**
+
 ```
 PRIVATE_KEY=your_private_key_here
 RPC_URL=https://arb-sepolia.g.alchemy.com/v2/...
@@ -475,6 +477,16 @@ All notable changes to the Ostium Python SDK will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.36] - 2025-01-14
+
+### Added
+- Before write-operations, check if private key is provided
+
+## [0.1.34] - 2025-01-14
+
+### Added
+- Allow read only operations on the SDK without providing a private key
+
 ## [0.1.31] - 2025-01-13
 
 ### Added

{ostium_python_sdk-0.1.34 → ostium_python_sdk-0.1.36}/README.md

@@ -62,7 +62,6 @@ You can instantiate the SDK with the following parameters.
 Ostium Platform is deployed on Arbitrum. You can use the testnet or mainnet config via the `NetworkConfig` class, see below for an example.
 
 
-**NOTE: You can also use the SDK _without_ providing a private key, in which case you will be limited to read only operations on the SDK.**
 
 ```python
 from dotenv import load_dotenv
@@ -89,8 +88,11 @@ sdk = OstiumSDK(configTestnet, private_key)
 # sdk = OstiumSDK(configMainnet, private_key)
 #
 ```
+
 <b>NOTE:</b> create a .env file with PRIVATE_KEY and RPC_URL to use the SDK. An RPC URL is required to use the SDK. You can get one by signing up for a free account at https://www.alchemy.com/ and creating an app. 
 
+**NOTE: You can also use the SDK _without_ providing a private key, in which case you will be limited to read only operations on the SDK.**
+
 ```
 PRIVATE_KEY=your_private_key_here
 RPC_URL=https://arb-sepolia.g.alchemy.com/v2/...

{ostium_python_sdk-0.1.34 → ostium_python_sdk-0.1.36}/ostium_python_sdk/faucet.py

@@ -40,7 +40,17 @@ class Faucet:
         wait_days = wait_hours // 24
         return f"{wait_days} day{'s' if wait_days != 1 else ''}"
 
+    def _check_private_key(self):
+        if not self.private_key:
+            raise ValueError(
+                "Private key is required for Faucet operations")
+
+    def _get_account(self):
+        self._check_private_key()
+        return self.web3.eth.account.from_key(self.private_key)
+
     def request_tokens(self) -> dict:
+        account = self._get_account()
         """
         Request testnet USDC tokens from the faucet.
         Raises:
@@ -50,8 +60,6 @@ class Faucet:
             Transaction receipt
         """
         try:
-            account = self.web3.eth.account.from_key(self.private_key)
-
             # Get the current base fee and add a buffer
             base_fee = self.web3.eth.get_block('latest')['baseFeePerGas']
             # Add 50% buffer to ensure it's above base fee

{ostium_python_sdk-0.1.34 → ostium_python_sdk-0.1.36}/ostium_python_sdk/ostium.py

@@ -16,10 +16,6 @@ class OpenOrderType(Enum):
 
 class Ostium:
     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
@@ -43,6 +39,7 @@ class Ostium:
         return self.slippage_percentage
 
     def _get_account(self) -> Account:
+        self._check_private_key()
         """Get account from stored private key"""
         return self.web3.eth.account.from_key(self.private_key)
 
@@ -52,6 +49,11 @@ class Ostium:
     def get_nonce(self, address):
         return self.web3.eth.get_transaction_count(address)
 
+    def _check_private_key(self):
+        if not self.private_key:
+            raise ValueError(
+                "Private key is required for Ostium platform write-operations")
+
     def perform_trade(self, trade_params, at_price):
         account = self._get_account()
         amount = to_base_units(trade_params['collateral'], decimals=6)
@@ -142,8 +144,8 @@ class Ostium:
         return trade_receipt
 
     def add_collateral(self, pairID, index, collateral):
+        account = self._get_account()
         try:
-            account = self._get_account()
             amount = to_base_units(collateral, decimals=6)
             self.__approve(account, amount)
 
@@ -168,8 +170,8 @@ class Ostium:
             raise e
 
     def update_tp(self, pairID, index, tp):
+        account = self._get_account()
         try:
-            account = self._get_account()
             tp_value = to_base_units(tp, decimals=18)
 
             update_tp_tx = self.ostium_trading_contract.functions.updateTp(
@@ -188,8 +190,8 @@ class Ostium:
             raise e
 
     def update_sl(self, pairID, index, sl):
+        account = self._get_account()
         try:
-            account = self._get_account()
             sl_value = to_base_units(sl, decimals=18)
 
             update_sl_tx = self.ostium_trading_contract.functions.updateSl(
@@ -232,8 +234,9 @@ class Ostium:
             print('Approval Receipt:', approve_receipt)
 
     def withdraw(self, amount, receiving_address):
+        account = self._get_account()
+
         try:
-            account = self._get_account()
             amount_in_base_units = to_base_units(amount, decimals=6)
 
             if not self.web3.is_address(receiving_address):

{ostium_python_sdk-0.1.34 → ostium_python_sdk-0.1.36}/ostium_python_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ostium-python-sdk
-Version: 0.1.34
+Version: 0.1.36
 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
@@ -90,7 +90,6 @@ You can instantiate the SDK with the following parameters.
 Ostium Platform is deployed on Arbitrum. You can use the testnet or mainnet config via the `NetworkConfig` class, see below for an example.
 
 
-**NOTE: You can also use the SDK _without_ providing a private key, in which case you will be limited to read only operations on the SDK.**
 
 ```python
 from dotenv import load_dotenv
@@ -117,8 +116,11 @@ sdk = OstiumSDK(configTestnet, private_key)
 # sdk = OstiumSDK(configMainnet, private_key)
 #
 ```
+
 <b>NOTE:</b> create a .env file with PRIVATE_KEY and RPC_URL to use the SDK. An RPC URL is required to use the SDK. You can get one by signing up for a free account at https://www.alchemy.com/ and creating an app. 
 
+**NOTE: You can also use the SDK _without_ providing a private key, in which case you will be limited to read only operations on the SDK.**
+
 ```
 PRIVATE_KEY=your_private_key_here
 RPC_URL=https://arb-sepolia.g.alchemy.com/v2/...
@@ -475,6 +477,16 @@ All notable changes to the Ostium Python SDK will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.36] - 2025-01-14
+
+### Added
+- Before write-operations, check if private key is provided
+
+## [0.1.34] - 2025-01-14
+
+### Added
+- Allow read only operations on the SDK without providing a private key
+
 ## [0.1.31] - 2025-01-13
 
 ### Added

{ostium_python_sdk-0.1.34 → ostium_python_sdk-0.1.36}/setup.py

@@ -12,7 +12,7 @@ if changelog_path.exists():
 
 setup(
     name="ostium-python-sdk",
-    version="0.1.34",
+    version="0.1.36",
     packages=find_packages(),
     install_requires=[
         "web3>=6.0.0",