afp-sdk 0.2.2__tar.gz → 0.3.0__tar.gz

{afp_sdk-0.2.2 → afp_sdk-0.3.0}/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [v0.3.0] - 2025-09-05
+
+_First public release for Forecastathon._
+
+### Changed
+
+- Update the interface with the AutEx exchange ([#17](https://github.com/autonity/afp-sdk/pull/17))
+- Update the contract bindings ([#18](https://github.com/autonity/afp-sdk/pull/18))
+- Update Clearing System parameters for Autonity Mainnet ([#19](https://github.com/autonity/afp-sdk/pull/19))
+
 ## [v0.2.2] - 2025-09-03
 
 ### Added
@@ -45,6 +55,7 @@
 
 _First release._
 
+[v0.3.0]: https://github.com/autonity/afp-sdk/releases/tag/v0.3.0
 [v0.2.2]: https://github.com/autonity/afp-sdk/releases/tag/v0.2.2
 [v0.2.1]: https://github.com/autonity/afp-sdk/releases/tag/v0.2.1
 [v0.2.0]: https://github.com/autonity/afp-sdk/releases/tag/v0.2.0

{afp_sdk-0.2.2 → afp_sdk-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: afp-sdk
-Version: 0.2.2
+Version: 0.3.0
 Summary: Autonomous Futures Protocol Python SDK
 Keywords: autonity,web3,trading,crypto,prediction,forecast,markets
 License-Expression: MIT
@@ -38,7 +38,7 @@ pip install afp-sdk
 
 The `afp` package consists of the following:
 
-- `afp` top-level module: High-level API for interacting with the Clearing
+- `afp` top-level module: High-level API for interacting with the AFP Clearing
   System and the AutEx exchange.
 - `afp.bindings` submodule: Low-level API that provides typed Python bindings
   for the Clearing System smart contracts.
@@ -47,7 +47,7 @@ The `afp` package consists of the following:
 
 ### Preparation
 
-In order to use the AFP system, traders need to prepare the following:
+In order to trade in the AFP system, traders need to prepare the following:
 
 - The ID of a product to be traded.
 - The address of the product's collateral token.
@@ -55,7 +55,7 @@ In order to use the AFP system, traders need to prepare the following:
   balance in ATN (for paying gas fee) and in the product's collateral token.
 - An Autonity account for signing intents. The two accounts can be the same.
 - The address of an Autonity RPC provider. They can be found on
-  [Chainlist](https://chainlist.org/?search=autonity&testnets=true).
+  [Chainlist](https://chainlist.org/?search=autonity).
 
 We can store those in the following constants (using random example IDs):
 
@@ -169,6 +169,22 @@ print(fills)
 
 See further code examples in the [examples](./examples/) directory.
 
+## Configuration
+
+By default the SDK communicates with the AFP Clearing System contracts on
+Autonity Mainnet, and the AutEx Exchange. Connection parameters can be
+overridden with the following environment variables:
+
+```sh
+AFP_EXCHANGE_URL=
+AFP_CHAIN_ID=
+AFP_CLEARING_DIAMOND_ADDRESS=
+AFP_MARGIN_ACCOUNT_REGISTRY_ADDRESS=
+AFP_ORACLE_PROVIDER_ADDRESS=
+AFP_PRODUCT_REGISTRY_ADDRESS=
+AFP_SYSTEM_VIEWER_ADDRESS=
+```
+
 ## Development
 
 The package uses [`uv`](https://docs.astral.sh/uv/) as project manager.

{afp_sdk-0.2.2 → afp_sdk-0.3.0}/README.md

@@ -13,7 +13,7 @@ pip install afp-sdk
 
 The `afp` package consists of the following:
 
-- `afp` top-level module: High-level API for interacting with the Clearing
+- `afp` top-level module: High-level API for interacting with the AFP Clearing
   System and the AutEx exchange.
 - `afp.bindings` submodule: Low-level API that provides typed Python bindings
   for the Clearing System smart contracts.
@@ -22,7 +22,7 @@ The `afp` package consists of the following:
 
 ### Preparation
 
-In order to use the AFP system, traders need to prepare the following:
+In order to trade in the AFP system, traders need to prepare the following:
 
 - The ID of a product to be traded.
 - The address of the product's collateral token.
@@ -30,7 +30,7 @@ In order to use the AFP system, traders need to prepare the following:
   balance in ATN (for paying gas fee) and in the product's collateral token.
 - An Autonity account for signing intents. The two accounts can be the same.
 - The address of an Autonity RPC provider. They can be found on
-  [Chainlist](https://chainlist.org/?search=autonity&testnets=true).
+  [Chainlist](https://chainlist.org/?search=autonity).
 
 We can store those in the following constants (using random example IDs):
 
@@ -144,6 +144,22 @@ print(fills)
 
 See further code examples in the [examples](./examples/) directory.
 
+## Configuration
+
+By default the SDK communicates with the AFP Clearing System contracts on
+Autonity Mainnet, and the AutEx Exchange. Connection parameters can be
+overridden with the following environment variables:
+
+```sh
+AFP_EXCHANGE_URL=
+AFP_CHAIN_ID=
+AFP_CLEARING_DIAMOND_ADDRESS=
+AFP_MARGIN_ACCOUNT_REGISTRY_ADDRESS=
+AFP_ORACLE_PROVIDER_ADDRESS=
+AFP_PRODUCT_REGISTRY_ADDRESS=
+AFP_SYSTEM_VIEWER_ADDRESS=
+```
+
 ## Development
 
 The package uses [`uv`](https://docs.astral.sh/uv/) as project manager.

{afp_sdk-0.2.2 → afp_sdk-0.3.0}/afp/bindings/final_settlement_facet.py

@@ -32,6 +32,16 @@ class FinalSettlementFacet:
             abi=ABI,
         )
 
+    @property
+    def FSPFinalized(self) -> contract.ContractEvent:
+        """Binding for `event FSPFinalized` on the FinalSettlementFacet contract."""
+        return self._contract.events.FSPFinalized
+
+    @property
+    def FinalSettlementCloseout(self) -> contract.ContractEvent:
+        """Binding for `event FinalSettlementCloseout` on the FinalSettlementFacet contract."""
+        return self._contract.events.FinalSettlementCloseout
+
     def closeout_fee_rate(
         self,
     ) -> int:
@@ -210,6 +220,50 @@ ABI = typing.cast(
             "name": "ProductNotInFinalSettlement",
             "type": "error",
         },
+        {
+            "anonymous": False,
+            "inputs": [
+                {
+                    "indexed": True,
+                    "internalType": "bytes32",
+                    "name": "productID",
+                    "type": "bytes32",
+                },
+                {
+                    "indexed": False,
+                    "internalType": "uint256",
+                    "name": "fsp",
+                    "type": "uint256",
+                },
+            ],
+            "name": "FSPFinalized",
+            "type": "event",
+        },
+        {
+            "anonymous": False,
+            "inputs": [
+                {
+                    "indexed": True,
+                    "internalType": "bytes32",
+                    "name": "productID",
+                    "type": "bytes32",
+                },
+                {
+                    "indexed": False,
+                    "internalType": "uint256",
+                    "name": "accountLength",
+                    "type": "uint256",
+                },
+                {
+                    "indexed": False,
+                    "internalType": "address",
+                    "name": "closedBy",
+                    "type": "address",
+                },
+            ],
+            "name": "FinalSettlementCloseout",
+            "type": "event",
+        },
         {
             "inputs": [],
             "name": "CLOSEOUT_FEE_RATE",

{afp_sdk-0.2.2 → afp_sdk-0.3.0}/afp/config.py

@@ -9,33 +9,34 @@ FEE_RATE_MULTIPLIER = 10**6
 FULL_PRECISION_MULTIPLIER = 10**18
 
 USER_AGENT = "afp-sdk"
+DEFAULT_EXCHANGE_API_VERSION = 1
 EXCHANGE_URL = os.getenv(
-    "AFP_EXCHANGE_URL", "https://afp-exchange-staging.up.railway.app"
+    "AFP_EXCHANGE_URL", "https://afp-exchange-stable.up.railway.app"
 )
 
-CHAIN_ID = int(os.getenv("AFP_CHAIN_ID", 65010004))
+CHAIN_ID = int(os.getenv("AFP_CHAIN_ID", 65000000))
 
 CLEARING_DIAMOND_ADDRESS = Web3.to_checksum_address(
     os.getenv(
-        "AFP_CLEARING_DIAMOND_ADDRESS", "0xB894bFf368Bf1EA89c18612670B7E072866a5264"
+        "AFP_CLEARING_DIAMOND_ADDRESS", "0x5B5411F1548254d25360d71FE40cFc1cC983B2A2"
     )
 )
 MARGIN_ACCOUNT_REGISTRY_ADDRESS = Web3.to_checksum_address(
     os.getenv(
         "AFP_MARGIN_ACCOUNT_REGISTRY_ADDRESS",
-        "0xDA71FdE0E7cfFf445e848EAdB3B2255B68Ed6ef6",
+        "0x99f4FA9Cdce7AD227eB84907936a8FeF2095D846",
     )
 )
 ORACLE_PROVIDER_ADDRESS = Web3.to_checksum_address(
     os.getenv(
-        "AFP_ORACLE_PROVIDER_ADDRESS", "0x626da921088a5A00C75C208Decbb60E816488481"
+        "AFP_ORACLE_PROVIDER_ADDRESS", "0xF2A2A27da33D30B4BF38D7e186E7B0b1e964e55c"
     )
 )
 PRODUCT_REGISTRY_ADDRESS = Web3.to_checksum_address(
     os.getenv(
-        "AFP_PRODUCT_REGISTRY_ADDRESS", "0x9b92EAC112c996a513e515Cf8c3BDd83619F730D"
+        "AFP_PRODUCT_REGISTRY_ADDRESS", "0x86B3829471929B115367DA0958f56A6AB844b08e"
     )
 )
 SYSTEM_VIEWER_ADDRESS = Web3.to_checksum_address(
-    os.getenv("AFP_SYSTEM_VIEWER_ADDRESS", "0xcB3F71Db710544283a1FfB38FE1bEC554d0634A5")
+    os.getenv("AFP_SYSTEM_VIEWER_ADDRESS", "0xfF2DFcC44a95cce96E03EfC33C65c8Be671Bae5B")
 )

{afp_sdk-0.2.2 → afp_sdk-0.3.0}/afp/exchange.py

@@ -116,7 +116,13 @@ class ExchangeClient:
             yield MarketDepthData.model_validate_json(line)
 
     def _send_request(
-        self, method: str, endpoint: str, stream: bool = False, **kwargs: Any
+        self,
+        method: str,
+        endpoint: str,
+        *,
+        stream: bool = False,
+        api_version: int = config.DEFAULT_EXCHANGE_API_VERSION,
+        **kwargs: Any,
     ) -> Response:
         kwargs["headers"] = {
             "Content-Type": "application/json",
@@ -126,7 +132,10 @@ class ExchangeClient:
 
         try:
             response = self._session.request(
-                method, f"{config.EXCHANGE_URL}{endpoint}", stream=stream, **kwargs
+                method,
+                f"{config.EXCHANGE_URL}/v{api_version}{endpoint}",
+                stream=stream,
+                **kwargs,
             )
         except requests.exceptions.RequestException as request_exception:
             raise ExchangeError(

{afp_sdk-0.2.2 → afp_sdk-0.3.0}/pyproject.toml

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

afp_sdk-0.3.0/tests/test_exchange_client.py

@@ -0,0 +1,24 @@
+from unittest.mock import Mock
+
+from requests import Response
+from requests.adapters import HTTPAdapter
+
+from afp import config
+from afp.exchange import ExchangeClient
+
+
+def test_send_request(monkeypatch):
+    fake_response = Response()
+    fake_response.status_code = 200
+    mock_send = Mock(return_value=fake_response)
+    monkeypatch.setattr(HTTPAdapter, "send", mock_send)
+    monkeypatch.setattr(config, "EXCHANGE_URL", "https://foobar.com")
+
+    client = ExchangeClient()
+    client._send_request("POST", "/orders", api_version=2, data="hello")
+
+    mock_send.assert_called_once()
+    request = mock_send.call_args_list[0].args[0]
+    assert request.method == "POST"
+    assert request.url == "https://foobar.com/v2/orders"
+    assert request.body == "hello"

{afp_sdk-0.2.2 → afp_sdk-0.3.0}/uv.lock

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