afp-sdk 0.1.2__tar.gz → 0.2.0__tar.gz

{afp_sdk-0.1.2 → afp_sdk-0.2.0}/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [v0.2.0] - 2025-09-02
+
+### Changed
+
+- Validate limit price to make sure it conforms to the product's tick size
+  ([#12](https://github.com/autonity/afp-sdk/pull/12))
+- Update Clearing System contract bindings for Autonity Bakerloo (Nile) Testnet
+  deployment as of 2025-09-02 ([#13](https://github.com/autonity/afp-sdk/pull/13))
+
+### Added
+
+- Add optional `rounding` argument to `afp.Trading.create_intent`
+  ([#12](https://github.com/autonity/afp-sdk/pull/12))
+
 ## [v0.1.2] - 2025-08-28
 
 ### Fixed
@@ -14,6 +28,7 @@
 
 _First release._
 
+[v0.2.0]: https://github.com/autonity/afp-sdk/releases/tag/v0.2.0
 [v0.1.2]: https://github.com/autonity/afp-sdk/releases/tag/v0.1.2
 [v0.1.1]: https://github.com/autonity/afp-sdk/releases/tag/v0.1.1
 [v0.1.0]: https://github.com/autonity/afp-sdk/releases/tag/v0.1.0

{afp_sdk-0.1.2 → afp_sdk-0.2.0}/PKG-INFO

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

{afp_sdk-0.1.2 → afp_sdk-0.2.0}/afp/api/trading.py

@@ -54,6 +54,7 @@ class Trading(ExchangeAPI):
         max_trading_fee_rate: Decimal,
         good_until_time: datetime,
         margin_account_id: str | None = None,
+        rounding: str | None = None,
     ) -> Intent:
         """Creates an intent with the given intent data, generates its hash and signs it
         with the configured account's private key.
@@ -62,6 +63,13 @@ class Trading(ExchangeAPI):
         is assumed to be the same as the margin account if the margin account ID is not
         specified.
 
+        The limit price must have at most as many fractional digits as the product's
+        tick size, or if `rounding` is specified then the limit price is rounded to the
+        appropriate number of fractional digits. `rounding` may be one of
+        `ROUND_CEILING`, `ROUND_FLOOR`, `ROUND_UP`, `ROUND_DOWN`, `ROUND_HALF_UP`,
+        `ROUND_HALF_DOWN`, `ROUND_HALF_EVEN` and `ROUND_05UP`; see the rounding modes of
+        the `decimal` module of the Python Standard Library.
+
         Parameters
         ----------
         product : afp.schemas.ExchangeProduct
@@ -71,6 +79,8 @@ class Trading(ExchangeAPI):
         max_trading_fee_rate : decimal.Decimal
         good_until_time : datetime.datetime
         margin_account_id : str, optional
+        rounding : str, optional
+            A rounding mode of the `decimal` module or `None` for no rounding.
 
         Returns
         -------
@@ -85,7 +95,9 @@ class Trading(ExchangeAPI):
         intent_data = IntentData(
             trading_protocol_id=self._trading_protocol_id,
             product_id=product.id,
-            limit_price=limit_price,
+            limit_price=validators.validate_limit_price(
+                Decimal(limit_price), product.tick_size, rounding
+            ),
             quantity=quantity,
             max_trading_fee_rate=max_trading_fee_rate,
             side=getattr(OrderSide, side.upper()),

{afp_sdk-0.1.2 → afp_sdk-0.2.0}/afp/bindings/trading_protocol.py

@@ -59,6 +59,24 @@ class Trade:
     intents: typing.List[Intent]
 
 
+@dataclass
+class Settlement:
+    """Port of `struct Settlement` on the IMarginAccount contract."""
+
+    position_id: hexbytes.HexBytes
+    quantity: int
+    price: int
+
+
+@dataclass
+class Order:
+    """Port of `struct Order` on the ITradingProtocol contract."""
+
+    margin_account_id: eth_typing.ChecksumAddress
+    margin_account_contract: eth_typing.ChecksumAddress
+    settlement: Settlement
+
+
 class TradingProtocol:
     """TradingProtocol contract binding.
 
@@ -101,6 +119,11 @@ class TradingProtocol:
         """Binding for `event RoleRevoked` on the TradingProtocol contract."""
         return self._contract.events.RoleRevoked
 
+    @property
+    def SequenceExecuted(self) -> contract.ContractEvent:
+        """Binding for `event SequenceExecuted` on the TradingProtocol contract."""
+        return self._contract.events.SequenceExecuted
+
     @property
     def Upgraded(self) -> contract.ContractEvent:
         """Binding for `event Upgraded` on the TradingProtocol contract."""
@@ -450,6 +473,36 @@ class TradingProtocol:
             clearing_address,
         )
 
+    def order_mae_check(
+        self,
+        orders: typing.List[Order],
+    ) -> typing.List[bool]:
+        """Binding for `orderMAECheck` on the TradingProtocol contract.
+
+        Parameters
+        ----------
+        orders : typing.List[Order]
+
+        Returns
+        -------
+        typing.List[bool]
+        """
+        return_value = self._contract.functions.orderMAECheck(
+            [
+                (
+                    item.margin_account_id,
+                    item.margin_account_contract,
+                    (
+                        item.settlement.position_id,
+                        item.settlement.quantity,
+                        item.settlement.price,
+                    ),
+                )
+                for item in orders
+            ],
+        ).call()
+        return [bool(return_value_elem) for return_value_elem in return_value]
+
     def proxiable_uuid(
         self,
     ) -> hexbytes.HexBytes:
@@ -718,6 +771,25 @@ ABI = typing.cast(
             "name": "RoleRevoked",
             "type": "event",
         },
+        {
+            "anonymous": False,
+            "inputs": [
+                {
+                    "indexed": False,
+                    "internalType": "bool[]",
+                    "name": "results",
+                    "type": "bool[]",
+                },
+                {
+                    "indexed": False,
+                    "internalType": "bytes[]",
+                    "name": "errors",
+                    "type": "bytes[]",
+                },
+            ],
+            "name": "SequenceExecuted",
+            "type": "event",
+        },
         {
             "anonymous": False,
             "inputs": [
@@ -1100,6 +1172,55 @@ ABI = typing.cast(
             "stateMutability": "nonpayable",
             "type": "function",
         },
+        {
+            "inputs": [
+                {
+                    "components": [
+                        {
+                            "internalType": "address",
+                            "name": "marginAccountID",
+                            "type": "address",
+                        },
+                        {
+                            "internalType": "address",
+                            "name": "marginAccountContract",
+                            "type": "address",
+                        },
+                        {
+                            "components": [
+                                {
+                                    "internalType": "bytes32",
+                                    "name": "positionId",
+                                    "type": "bytes32",
+                                },
+                                {
+                                    "internalType": "int256",
+                                    "name": "quantity",
+                                    "type": "int256",
+                                },
+                                {
+                                    "internalType": "uint256",
+                                    "name": "price",
+                                    "type": "uint256",
+                                },
+                            ],
+                            "internalType": "struct IMarginAccount.Settlement",
+                            "name": "settlement",
+                            "type": "tuple",
+                        },
+                    ],
+                    "internalType": "struct ITradingProtocol.Order[]",
+                    "name": "orders",
+                    "type": "tuple[]",
+                }
+            ],
+            "name": "orderMAECheck",
+            "outputs": [
+                {"internalType": "bool[]", "name": "results", "type": "bool[]"}
+            ],
+            "stateMutability": "view",
+            "type": "function",
+        },
         {
             "inputs": [],
             "name": "proxiableUUID",

{afp_sdk-0.1.2 → afp_sdk-0.2.0}/afp/validators.py

@@ -1,4 +1,5 @@
 from datetime import datetime, timedelta
+from decimal import Decimal
 
 from binascii import Error
 from eth_typing.evm import ChecksumAddress
@@ -41,3 +42,15 @@ def validate_address(value: str) -> ChecksumAddress:
         return Web3.to_checksum_address(value)
     except ValueError:
         raise ValueError(f"{value} is not a valid blockchain address")
+
+
+def validate_limit_price(
+    value: Decimal, tick_size: int, rounding: str | None = None
+) -> Decimal:
+    if rounding is None:
+        num_fractional_digits = abs(int(value.normalize().as_tuple().exponent))
+        if num_fractional_digits > tick_size:
+            raise ValueError(
+                f"Limit price {value} can have at most {tick_size} fractional digits"
+            )
+    return value.quantize(Decimal("10") ** -tick_size, rounding=rounding)

{afp_sdk-0.1.2 → afp_sdk-0.2.0}/pyproject.toml

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

{afp_sdk-0.1.2 → afp_sdk-0.2.0}/tests/test_validators.py

@@ -1,4 +1,6 @@
+import decimal
 from datetime import datetime, UTC
+from decimal import Decimal
 
 import pytest
 
@@ -45,3 +47,25 @@ def test_validate_hexstr32__pass():
 def test_validate_hexstr32__error(value):
     with pytest.raises(ValueError):
         validators.validate_hexstr32(value)
+
+
+def test_validate_limit_price__pass():
+    assert str(validators.validate_limit_price(Decimal("1.25"), 2)) == "1.25"
+    assert str(validators.validate_limit_price(Decimal("1.25"), 4)) == "1.2500"
+
+
+def test_validate_limit_price__rounding():
+    assert (
+        str(validators.validate_limit_price(Decimal("1.25"), 1, decimal.ROUND_DOWN))
+        == "1.2"
+    )
+
+
+def test_validate_limit_price__error():
+    with pytest.raises(ValueError):
+        validators.validate_limit_price(Decimal("1.25"), 1)
+
+
+def test_validate_limit_price__invalid_rounding_mode():
+    with pytest.raises(TypeError):
+        validators.validate_limit_price(Decimal("1.25"), 1, "foobar")

{afp_sdk-0.1.2 → afp_sdk-0.2.0}/uv.lock

@@ -1,5 +1,5 @@
 version = 1
-revision = 3
+revision = 2
 requires-python = ">=3.11"
 
 [[package]]
@@ -13,7 +13,7 @@ wheels = [
 
 [[package]]
 name = "afp-sdk"
-version = "0.1.2"
+version = "0.2.0"
 source = { editable = "." }
 dependencies = [
     { name = "decorator" },