afp-sdk 0.5.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

afp/api/admin.py

@@ -1,6 +1,7 @@
 from .. import validators
 from ..decorators import refresh_token_on_expiry
-from ..schemas import ExchangeProductSubmission
+from ..enums import ListingState
+from ..schemas import ExchangeProductListingSubmission, ExchangeProductUpdateSubmission
 from .base import ExchangeAPI
 
 
@@ -8,8 +9,26 @@ class Admin(ExchangeAPI):
     """API for AutEx administration, restricted to AutEx admins."""
 
     @refresh_token_on_expiry
-    def approve_product(self, product_id: str) -> None:
-        """Approves a product for trading on the exchange.
+    def list_product(self, product_id: str) -> None:
+        """Lists a product on the exchange.
+
+        The product is in private state after listing until it is revealed to the public.
+
+        Parameters
+        ----------
+        product_id : str
+
+        Raises
+        ------
+        afp.exceptions.AuthorizationError
+            If the configured account is not an exchange administrator.
+        """
+        product_listing = ExchangeProductListingSubmission(id=product_id)
+        self._exchange.list_product(product_listing)
+
+    @refresh_token_on_expiry
+    def reveal_product(self, product_id: str) -> None:
+        """Makes a product publicly available for trading on the exchange.
 
         Parameters
         ----------
@@ -20,8 +39,12 @@ class Admin(ExchangeAPI):
         afp.exceptions.AuthorizationError
             If the configured account is not an exchange administrator.
         """
-        product = ExchangeProductSubmission(id=product_id)
-        self._exchange.approve_product(product)
+        product_update = ExchangeProductUpdateSubmission(
+            listing_state=ListingState.PUBLIC
+        )
+        self._exchange.update_product_listing(
+            validators.validate_hexstr32(product_id), product_update
+        )
 
     @refresh_token_on_expiry
     def delist_product(self, product_id: str) -> None:
@@ -38,5 +61,9 @@ class Admin(ExchangeAPI):
         afp.exceptions.AuthorizationError
             If the configured account is not an exchange administrator.
         """
-        value = validators.validate_hexstr32(product_id)
-        self._exchange.delist_product(value)
+        product_update = ExchangeProductUpdateSubmission(
+            listing_state=ListingState.DELISTED
+        )
+        self._exchange.update_product_listing(
+            validators.validate_hexstr32(product_id), product_update
+        )

afp/api/product.py

@@ -1,6 +1,7 @@
+import warnings
 from datetime import datetime
 from decimal import Decimal
-from typing import cast
+from typing import Any, cast
 
 from eth_typing.evm import ChecksumAddress
 from hexbytes import HexBytes
@@ -29,7 +30,7 @@ class Product(ClearingSystemAPI):
     ### Factories ###
 
     @convert_web3_error()
-    def create_product(
+    def create(
         self,
         *,
         symbol: str,
@@ -117,15 +118,24 @@ class Product(ClearingSystemAPI):
             extended_metadata=extended_metadata,
         )
 
+    def create_product(self, **kwargs: Any) -> ProductSpecification:
+        """Deprecated alias of `Product.create`."""
+        warnings.warn(
+            "Product.create_product() is deprecated. Use Product.create() instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.create(**kwargs)
+
     ### Transactions ###
 
     @convert_web3_error(PRODUCT_REGISTRY_ABI)
-    def register_product(self, product: ProductSpecification) -> Transaction:
+    def register(self, product_specification: ProductSpecification) -> Transaction:
         """Submits a product specification to the clearing system.
 
         Parameters
         ----------
-        product : afp.schemas.ProductSpecification
+        product_specification : afp.schemas.ProductSpecification
 
         Returns
         -------
@@ -133,7 +143,7 @@ class Product(ClearingSystemAPI):
             Transaction parameters.
         """
         erc20_contract = ERC20(
-            self._w3, cast(ChecksumAddress, product.collateral_asset)
+            self._w3, cast(ChecksumAddress, product_specification.collateral_asset)
         )
         decimals = erc20_contract.decimals()
 
@@ -142,10 +152,19 @@ class Product(ClearingSystemAPI):
         )
         return self._transact(
             product_registry_contract.register(
-                self._convert_product_specification(product, decimals)
+                self._convert_product_specification(product_specification, decimals)
             )
         )
 
+    def register_product(self, product: ProductSpecification) -> Transaction:
+        """Deprecated alias of `Product.register`."""
+        warnings.warn(
+            "Product.register_product() is deprecated. Use Product.register() instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.register(product)
+
     @convert_web3_error(CLEARING_DIAMOND_ABI)
     def initiate_final_settlement(
         self, product_id: str, accounts: list[str]
@@ -181,7 +200,7 @@ class Product(ClearingSystemAPI):
     ### Views ###
 
     @convert_web3_error(PRODUCT_REGISTRY_ABI)
-    def product_state(self, product_id: str) -> str:
+    def state(self, product_id: str) -> str:
         """Returns the current state of a product.
 
         Parameters
@@ -200,6 +219,15 @@ class Product(ClearingSystemAPI):
         state = product_registry_contract.state(HexBytes(product_id))
         return state.name
 
+    def product_state(self, product_id: str) -> str:
+        """Deprecated alias of `Product.state`."""
+        warnings.warn(
+            "Product.product_state() is deprecated. Use Product.state() instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.state(product_id)
+
     @convert_web3_error(PRODUCT_REGISTRY_ABI)
     def collateral_asset(self, product_id: str) -> str:
         """Returns the collateral asset of a product.

afp/auth.py

@@ -52,7 +52,7 @@ class KeyfileAuthenticator(PrivateKeyAuthenticator):
 
     Parameters
     ----------
-    keyfile : str
+    key_file : str
         The path to the keyfile.
     password : str
         The password for decrypting the keyfile.

afp/enums.py

@@ -1,6 +1,12 @@
 from enum import StrEnum
 
 
+class ListingState(StrEnum):
+    PRIVATE = "PRIVATE"
+    PUBLIC = "PUBLIC"
+    DELISTED = "DELISTED"
+
+
 class OrderType(StrEnum):
     LIMIT_ORDER = "LIMIT_ORDER"
     CANCEL_ORDER = "CANCEL_ORDER"

afp/exchange.py

@@ -16,7 +16,8 @@ from .exceptions import (
 from .schemas import (
     ExchangeParameters,
     ExchangeProduct,
-    ExchangeProductSubmission,
+    ExchangeProductListingSubmission,
+    ExchangeProductUpdateSubmission,
     LoginSubmission,
     MarketDepthData,
     Order,
@@ -60,14 +61,22 @@ class ExchangeClient:
         return ExchangeProduct(**response.json())
 
     # POST /products
-    def approve_product(self, product_submission: ExchangeProductSubmission) -> None:
+    def list_product(
+        self, listing_submission: ExchangeProductListingSubmission
+    ) -> None:
         self._send_request(
-            "POST", "/products", data=product_submission.model_dump_json()
+            "POST", "/products", data=listing_submission.model_dump_json()
         )
 
-    # DELETE /products
-    def delist_product(self, product_id: str) -> None:
-        self._send_request("DELETE", f"/products/{product_id}")
+    # PATCH /products
+    def update_product_listing(
+        self, product_id: str, update_submission: ExchangeProductUpdateSubmission
+    ) -> None:
+        self._send_request(
+            "PATCH",
+            f"/products/{product_id}",
+            data=update_submission.model_dump_json(),
+        )
 
     # POST /orders
     def submit_order(self, order_submission: OrderSubmission) -> Order:

afp/schemas.py

@@ -15,7 +15,7 @@ from pydantic import (
 )
 
 from . import validators
-from .enums import OrderSide, OrderState, OrderType, TradeState
+from .enums import ListingState, OrderSide, OrderState, OrderType, TradeState
 
 
 # Use datetime internally but UNIX timestamp in client-server communication
@@ -53,18 +53,26 @@ class ExchangeParameters(Model):
     trading_fee_rate: Decimal
 
 
-# Trading API
+# Admin API
 
 
-class ExchangeProductSubmission(Model):
+class ExchangeProductListingSubmission(Model):
     id: Annotated[str, AfterValidator(validators.validate_hexstr32)]
 
 
+class ExchangeProductUpdateSubmission(Model):
+    listing_state: ListingState
+
+
+# Trading API
+
+
 class ExchangeProduct(Model):
     id: str
     symbol: str
     tick_size: int
     collateral_asset: str
+    listing_state: ListingState
 
     def __str__(self) -> str:
         return self.id
@@ -197,6 +205,9 @@ class ProductSpecification(Model):
     tradeout_interval: Annotated[int, Field(ge=0)]
     extended_metadata: str
 
+    def __str__(self) -> str:
+        return self.id
+
 
 # Liquidation API
 

{afp_sdk-0.5.0.dist-info → afp_sdk-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: afp-sdk
-Version: 0.5.0
+Version: 0.5.1
 Summary: Autonomous Futures Protocol Python SDK
 Keywords: autonity,web3,trading,crypto,prediction,forecast,markets
 License-Expression: MIT

{afp_sdk-0.5.0.dist-info → afp_sdk-0.5.1.dist-info}/RECORD

@@ -1,12 +1,12 @@
 afp/__init__.py,sha256=tvvXz4miC3QI8wy4vjAAf_LtL-19eEgBRA6dnrh3LA8,349
 afp/afp.py,sha256=1xpocnWjALP6QlA-Hn7G2znttJ-ikcb2WA9sLueY3zc,9107
 afp/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-afp/api/admin.py,sha256=5Q2V6Lde8ERwa0OvNhgez50WW6RcQH0eBA6aHPGwVtY,1243
+afp/api/admin.py,sha256=6TiWCo0SB41CtXYTkTYYGQY7MrdB6OMTyU3-0J0V_7o,2170
 afp/api/base.py,sha256=5X1joEwFX4gxYUDCSTvp_hSFCfLZCktnW-UtZFxDquk,4471
 afp/api/margin_account.py,sha256=sC1DF7J3QTHR7cXcRjTG33oZswVy6qr9xnevQbrQ-ew,15256
-afp/api/product.py,sha256=9EGQ5_UZ0m_uIkBIukp99fYVtTIQrqupXxQQ1ATev_E,9100
+afp/api/product.py,sha256=2N4bPBahuw19GcBbBL20oQ5RFRuUxa5LOZzmN7hs39U,10156
 afp/api/trading.py,sha256=exQQ3LJA6XCbRAUBuYVjSJ5PHFi4COyqDORxC37LLfQ,10379
-afp/auth.py,sha256=791uNaXrmcRuLbzSzgBsro1k4EOP9N1Ez3VCChX-giw,2054
+afp/auth.py,sha256=sV_9E6CgRWV1xYoppc4IdrnqNo5ZNDBIp6QF3fQbMWE,2055
 afp/bindings/__init__.py,sha256=_n9xoogYi8AAlSx_PE-wjnwP1ujVyDUwoRM0BSm243U,1271
 afp/bindings/auctioneer_facet.py,sha256=4p906zdU2lUsqpWlsiLE3dlxTPrlNpqk8DtjiQUWJ8M,23919
 afp/bindings/bankruptcy_facet.py,sha256=-Kp4Ap5PLAmo_tFrp-1s_yAh0mtHS20z3BC5YIrVjrU,12548
@@ -24,14 +24,14 @@ afp/bindings/trading_protocol.py,sha256=ZloF3REbjFq9v0UGVsM0_Lk0EhfWJKdeJ0PzVEny
 afp/config.py,sha256=_WKywiuty8poE1A0v46uBe1JGpfCzRlxCPamKennfpE,699
 afp/constants.py,sha256=XIph4R0Tx-BPw_NZJgWUtb7NdS9sYzEciFRSStm3VMs,1840
 afp/decorators.py,sha256=SEUQtbgPGc4iVPtBQV2eiCejcDAVImmXcI0uPXFhtJA,2774
-afp/enums.py,sha256=4dglBx4Amcu0GrlJn0cIj-rp9uDHZGfDEP_vMAO02xo,485
+afp/enums.py,sha256=U5b_3RteMiVJozp4WYAKzUfPXI1RdJLEK19jAg-LN8Q,588
 afp/exceptions.py,sha256=frdS-EH84K0fOf92RgRgNkTe3VII2m36XNCS8eyXLLM,390
-afp/exchange.py,sha256=ZhpZzq33jBGAderS9Pl_WZjnYLlECG7nyjYdX24KnRo,5760
+afp/exchange.py,sha256=MXQ-RhcI76l6bA9_IDTUq0RQGfwxBisrRhl6eC_yH4I,5983
 afp/hashing.py,sha256=gBCWN93-ydRPlgnnorSvDQlylcnglrAypRDb-1K-20I,1949
 afp/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-afp/schemas.py,sha256=bby8MKc6ALv-v8UaUrhiaKwpkXuQexA6CD8hw6urLUM,5083
+afp/schemas.py,sha256=M6qr0GhCeT7KevzOso5dIhydYzaYx78Rs66IWdadJO8,5284
 afp/validators.py,sha256=zQvPu3HDu6ADnEE72EJlS5hc1-xfru78Mzd74s1u_EM,1841
-afp_sdk-0.5.0.dist-info/licenses/LICENSE,sha256=ZdaKItgc2ppfqta2OJV0oHpSJiK87PUxmUkUo-_0SB8,1065
-afp_sdk-0.5.0.dist-info/WHEEL,sha256=5h_Q-_6zWQhhADpsAD_Xpw7gFbCRK5WjOOEq0nB806Q,79
-afp_sdk-0.5.0.dist-info/METADATA,sha256=zO6jbifQf9v8abl1bgpTNyuWLxpn1Oz-ch6PH0yms_0,6354
-afp_sdk-0.5.0.dist-info/RECORD,,
+afp_sdk-0.5.1.dist-info/licenses/LICENSE,sha256=ZdaKItgc2ppfqta2OJV0oHpSJiK87PUxmUkUo-_0SB8,1065
+afp_sdk-0.5.1.dist-info/WHEEL,sha256=lh7MMMfiuFQLQaR9J7pNBODdWf-aa5UOeuuDAol3xps,79
+afp_sdk-0.5.1.dist-info/METADATA,sha256=RM6EyQq2W_ZlrkRtYcGf85pZg7S15poSNJq7CUEHz0w,6354
+afp_sdk-0.5.1.dist-info/RECORD,,

{afp_sdk-0.5.0.dist-info → afp_sdk-0.5.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.8.18
+Generator: uv 0.8.20
 Root-Is-Purelib: true
 Tag: py3-none-any