afp-sdk 0.5.0__tar.gz → 0.5.1__tar.gz

{afp_sdk-0.5.0 → afp_sdk-0.5.1}/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [v0.5.1] - 2025-09-23
+
+### Added
+
+- Add `Admin.list_product()` and `Admin.reveal_product()` methods for the new 2-stage product listing process ([#28](https://github.com/autonity/afp-sdk/pull/28))
+- Add `Product.create()`, `Product.register()` and `Product.state()` as short aliases for existing methods ([#27](https://github.com/autonity/afp-sdk/pull/27))
+
+### Changed
+
+- Flag `Product.create_product()`, `Product.register_product()` and `Product.product_state()` methods for deprecation ([#27](https://github.com/autonity/afp-sdk/pull/27))
+
+### Removed
+
+- Remove `Admin.approve_product()` method ([#28](https://github.com/autonity/afp-sdk/pull/28))
+
 ## [v0.5.0] - 2025-09-18
 
 ### Added
@@ -23,6 +38,7 @@
 
 _First public release for Forecastathon._
 
+[v0.5.1]: https://github.com/autonity/afp-sdk/releases/tag/v0.5.1
 [v0.5.0]: https://github.com/autonity/afp-sdk/releases/tag/v0.5.0
 [v0.4.0]: https://github.com/autonity/afp-sdk/releases/tag/v0.4.0
 [v0.3.0]: https://github.com/autonity/afp-sdk/releases/tag/v0.3.0

{afp_sdk-0.5.0 → afp_sdk-0.5.1}/PKG-INFO

@@ -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.1/afp/api/admin.py

@@ -0,0 +1,69 @@
+from .. import validators
+from ..decorators import refresh_token_on_expiry
+from ..enums import ListingState
+from ..schemas import ExchangeProductListingSubmission, ExchangeProductUpdateSubmission
+from .base import ExchangeAPI
+
+
+class Admin(ExchangeAPI):
+    """API for AutEx administration, restricted to AutEx admins."""
+
+    @refresh_token_on_expiry
+    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
+        ----------
+        product_id : str
+
+        Raises
+        ------
+        afp.exceptions.AuthorizationError
+            If the configured account is not an exchange administrator.
+        """
+        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:
+        """Delists a product from the exchange.
+
+        New order submissions of this product will be rejected.
+
+        Parameters
+        ----------
+        product_id : str
+
+        Raises
+        ------
+        afp.exceptions.AuthorizationError
+            If the configured account is not an exchange administrator.
+        """
+        product_update = ExchangeProductUpdateSubmission(
+            listing_state=ListingState.DELISTED
+        )
+        self._exchange.update_product_listing(
+            validators.validate_hexstr32(product_id), product_update
+        )

{afp_sdk-0.5.0 → afp_sdk-0.5.1}/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_sdk-0.5.0 → afp_sdk-0.5.1}/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_sdk-0.5.0 → afp_sdk-0.5.1}/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_sdk-0.5.0 → afp_sdk-0.5.1}/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_sdk-0.5.0 → afp_sdk-0.5.1}/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 → afp_sdk-0.5.1}/examples/create_product.py

@@ -14,9 +14,9 @@ def main():
     app = afp.AFP(
         rpc_url=AUTONITY_RPC_URL, authenticator=afp.PrivateKeyAuthenticator(PRIVATE_KEY)
     )
-    product_api = app.Product()
+    product = app.Product()
 
-    product = product_api.create_product(
+    specification = product.create(
         symbol="SDK-TEST-1",
         description="Test Product 1",
         oracle_address="0xd8A8C5A492Fc2448cFcF980218c0F7D2De4d6FB3",
@@ -35,10 +35,10 @@ def main():
         tradeout_interval=3600,
         extended_metadata="QmPK1s3pNYLi9ERiq3BDxKa4XosgWwFRQUydHUtz4YgpqB",
     )
-    pprint(product.model_dump())
+    pprint(specification.model_dump())
 
-    product_api.register_product(product)
-    print(product_api.product_state(product.id))
+    product.register(specification)
+    print(product.state(specification.id))
 
 
 if __name__ == "__main__":

{afp_sdk-0.5.0 → afp_sdk-0.5.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "afp-sdk"
-version = "0.5.0"
+version = "0.5.1"
 description = "Autonomous Futures Protocol Python SDK"
 readme = "README.md"
 license = "MIT"

{afp_sdk-0.5.0 → afp_sdk-0.5.1}/uv.lock

@@ -13,7 +13,7 @@ wheels = [
 
 [[package]]
 name = "afp-sdk"
-version = "0.5.0"
+version = "0.5.1"
 source = { editable = "." }
 dependencies = [
     { name = "decorator" },

afp_sdk-0.5.0/afp/api/admin.py

@@ -1,42 +0,0 @@
-from .. import validators
-from ..decorators import refresh_token_on_expiry
-from ..schemas import ExchangeProductSubmission
-from .base import ExchangeAPI
-
-
-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.
-
-        Parameters
-        ----------
-        product_id : str
-
-        Raises
-        ------
-        afp.exceptions.AuthorizationError
-            If the configured account is not an exchange administrator.
-        """
-        product = ExchangeProductSubmission(id=product_id)
-        self._exchange.approve_product(product)
-
-    @refresh_token_on_expiry
-    def delist_product(self, product_id: str) -> None:
-        """Delists a product from the exchange.
-
-        New order submissions of this product will be rejected.
-
-        Parameters
-        ----------
-        product_id : str
-
-        Raises
-        ------
-        afp.exceptions.AuthorizationError
-            If the configured account is not an exchange administrator.
-        """
-        value = validators.validate_hexstr32(product_id)
-        self._exchange.delist_product(value)