afp-sdk 0.2.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

afp/bindings/__init__.py

@@ -8,6 +8,7 @@ from .facade import (
     MarginAccountRegistry,
     OracleProvider,
     ProductRegistry,
+    SystemViewer,
 )
 from .margin_account import MarginAccount, PositionData, Settlement
 from .product_registry import (
@@ -16,6 +17,7 @@ from .product_registry import (
     ProductMetadata,
     ProductState,
 )
+from .system_viewer import UserMarginAccountData
 from .trading_protocol import TradingProtocol
 
 __all__ = (
@@ -25,6 +27,7 @@ __all__ = (
     "MarginAccountRegistry",
     "OracleProvider",
     "ProductRegistry",
+    "SystemViewer",
     "TradingProtocol",
     # Structures
     "AuctionConfig",
@@ -42,6 +45,7 @@ __all__ = (
     "ProductMetadata",
     "Settlement",
     "Trade",
+    "UserMarginAccountData",
     # Enumerations
     "ProductState",
     "Side",

afp/bindings/auctioneer_facet.py

@@ -2,7 +2,6 @@
 
 # This module has been generated using pyabigen v0.2.16
 
-import enum
 import typing
 from dataclasses import dataclass
 
@@ -11,12 +10,7 @@ import hexbytes
 import web3
 from web3.contract import contract
 
-
-class Side(enum.IntEnum):
-    """Port of `enum Side` on the AuctioneerFacet contract."""
-
-    BID = 0
-    ASK = 1
+from .clearing_facet import Side
 
 
 @dataclass

afp/bindings/clearing_facet.py

@@ -11,6 +11,9 @@ import hexbytes
 import web3
 from web3.contract import contract
 
+if typing.TYPE_CHECKING:
+    from .auctioneer_facet import AuctionConfig
+
 
 class Side(enum.IntEnum):
     """Port of `enum Side` on the ClearingFacet contract."""
@@ -19,14 +22,6 @@ class Side(enum.IntEnum):
     ASK = 1
 
 
-@dataclass
-class AuctionConfig:
-    """Port of `struct AuctionConfig` on the IAuctioneer contract."""
-
-    restoration_buffer: int
-    liquidation_duration: int
-
-
 @dataclass
 class ClearingConfig:
     """Port of `struct ClearingConfig` on the IClearing contract."""
@@ -38,7 +33,7 @@ class ClearingConfig:
 class Config:
     """Port of `struct Config` on the IClearing contract."""
 
-    auction_config: AuctionConfig
+    auction_config: "AuctionConfig"
     clearing_config: ClearingConfig
 
 

afp/bindings/facade.py

@@ -12,6 +12,7 @@ from . import (
     mark_price_tracker_facet,
     oracle_provider,
     product_registry,
+    system_viewer,
 )
 
 # In order to include a facet in the ClearingDiamond facade:
@@ -85,3 +86,15 @@ class ProductRegistry(product_registry.ProductRegistry):
 
     def __init__(self, w3: Web3):
         super().__init__(w3, config.PRODUCT_REGISTRY_ADDRESS)
+
+
+class SystemViewer(system_viewer.SystemViewer):
+    """SystemViewer contract binding.
+
+    Parameters
+    ----------
+    w3 : web3.Web3
+    """
+
+    def __init__(self, w3: Web3):
+        super().__init__(w3, config.SYSTEM_VIEWER_ADDRESS)

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/bindings/system_viewer.py

@@ -2,7 +2,6 @@
 
 # This module has been generated using pyabigen v0.2.16
 
-import enum
 import typing
 from dataclasses import dataclass
 
@@ -11,76 +10,13 @@ import hexbytes
 import web3
 from web3.contract import contract
 
-
-class ProductState(enum.IntEnum):
-    """Port of `enum ProductState` on the SystemViewer contract."""
-
-    NOT_EXIST = 0
-    PENDING = 1
-    LIVE = 2
-    TRADEOUT = 3
-    FINAL_SETTLEMENT = 4
-    EXPIRED = 5
-
-
-@dataclass
-class Settlement:
-    """Port of `struct Settlement` on the IMarginAccount contract."""
-
-    position_id: hexbytes.HexBytes
-    quantity: int
-    price: int
-
-
-@dataclass
-class PositionData:
-    """Port of `struct PositionData` on the IMarginAccount contract."""
-
-    position_id: hexbytes.HexBytes
-    quantity: int
-    cost_basis: int
-    maintenance_margin: int
-    pnl: int
-
-
-@dataclass
-class ProductMetadata:
-    """Port of `struct ProductMetadata` on the IProductRegistry contract."""
-
-    builder: eth_typing.ChecksumAddress
-    symbol: str
-    description: str
-
-
-@dataclass
-class OracleSpecification:
-    """Port of `struct OracleSpecification` on the IProductRegistry contract."""
-
-    oracle_address: eth_typing.ChecksumAddress
-    fsv_decimals: int
-    fsp_alpha: int
-    fsp_beta: int
-    fsv_calldata: hexbytes.HexBytes
-
-
-@dataclass
-class Product:
-    """Port of `struct Product` on the IProductRegistry contract."""
-
-    metadata: ProductMetadata
-    oracle_spec: OracleSpecification
-    price_quotation: str
-    collateral_asset: eth_typing.ChecksumAddress
-    start_time: int
-    earliest_fsp_submission_time: int
-    unit_value: int
-    initial_margin_requirement: int
-    maintenance_margin_requirement: int
-    offer_price_buffer: int
-    auction_bounty: int
-    tradeout_interval: int
-    tick_size: int
-    extended_metadata: str
+from .margin_account import Settlement, PositionData
+from .product_registry import (
+    OracleSpecification,
+    Product,
+    ProductMetadata,
+    ProductState,
+)
 
 
 @dataclass

afp/bindings/trading_protocol.py

@@ -2,61 +2,14 @@
 
 # This module has been generated using pyabigen v0.2.16
 
-import enum
 import typing
-from dataclasses import dataclass
 
 import eth_typing
 import hexbytes
 import web3
 from web3.contract import contract
 
-
-class Side(enum.IntEnum):
-    """Port of `enum Side` on the TradingProtocol contract."""
-
-    BID = 0
-    ASK = 1
-
-
-@dataclass
-class IntentData:
-    """Port of `struct IntentData` on the IClearing contract."""
-
-    nonce: int
-    trading_protocol_id: eth_typing.ChecksumAddress
-    product_id: hexbytes.HexBytes
-    limit_price: int
-    quantity: int
-    max_trading_fee_rate: int
-    good_until: int
-    side: Side
-
-
-@dataclass
-class Intent:
-    """Port of `struct Intent` on the IClearing contract."""
-
-    margin_account_id: eth_typing.ChecksumAddress
-    intent_account_id: eth_typing.ChecksumAddress
-    hash: hexbytes.HexBytes
-    data: IntentData
-    signature: hexbytes.HexBytes
-
-
-@dataclass
-class Trade:
-    """Port of `struct Trade` on the IClearing contract."""
-
-    product_id: hexbytes.HexBytes
-    protocol_id: eth_typing.ChecksumAddress
-    trade_id: int
-    price: int
-    timestamp: int
-    accounts: typing.List[eth_typing.ChecksumAddress]
-    quantities: typing.List[int]
-    fee_rates: typing.List[int]
-    intents: typing.List[Intent]
+from .clearing_facet import Trade
 
 
 class TradingProtocol:

afp/config.py

@@ -9,30 +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", "0xfF2DFcC44a95cce96E03EfC33C65c8Be671Bae5B")
+)

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.1.dist-info → afp_sdk-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: afp-sdk
-Version: 0.2.1
+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.1.dist-info → afp_sdk-0.3.0.dist-info}/RECORD

@@ -6,30 +6,30 @@ afp/api/builder.py,sha256=mde8XemEMKL76KgEd5rxg7RLBS6lyIfNOEGmE1_iK0M,7114
 afp/api/clearing.py,sha256=nMVjayFkf0XYYP3aKAdgR6NaFSG4Cl_QsEuADRuIO7M,12922
 afp/api/liquidation.py,sha256=CtME5524VVW9mXMMpORyUP205sTVqpLnHIPoTy2MGa8,5439
 afp/api/trading.py,sha256=HjskW4c13CwAB-AwyIsSBcvyXKKEJk7a9768tqcTzUE,10648
-afp/bindings/__init__.py,sha256=5PDdlk0aClsTt2NgbVqP-R-z2QQp99IfXaSB13Pmf5c,1155
-afp/bindings/auctioneer_facet.py,sha256=99FmK35trfOIJGqJqyc1NnpG0KavhH0_jNufszZ9VhA,24013
+afp/bindings/__init__.py,sha256=_n9xoogYi8AAlSx_PE-wjnwP1ujVyDUwoRM0BSm243U,1271
+afp/bindings/auctioneer_facet.py,sha256=4p906zdU2lUsqpWlsiLE3dlxTPrlNpqk8DtjiQUWJ8M,23919
 afp/bindings/bankruptcy_facet.py,sha256=Yg8sLhDU0crsL1ISSy4eoeQEP5jrAuiWBBlco5MtgPc,11370
-afp/bindings/clearing_facet.py,sha256=GLBtquybV1FRvDNlYXgpcvlpgw9pvZ5UJbLOYKayPMU,34168
+afp/bindings/clearing_facet.py,sha256=DzRzzP9qXQ7kJMcMRwoLwLJ7S-w-2mid_CbF1fOVHaE,34081
 afp/bindings/erc20.py,sha256=-jw7ohcEbUL7g3PpK3-a5_7ClUDCDHt1bezm-w7exzo,10822
-afp/bindings/facade.py,sha256=FDKY6XLYsK6suDmWSsP5cek8y4ycY4soo9R4udvG1MM,2019
-afp/bindings/final_settlement_facet.py,sha256=gYJXiUyZ_-L8i8LHnPUmB3mBhLxHr8GAtKurwsCypa0,7699
+afp/bindings/facade.py,sha256=nZmAp7r26iszxtNyE5imdl_PKbG6vii_3oYJ3Q69iow,2278
+afp/bindings/final_settlement_facet.py,sha256=1U5F3WFvf4GUml3gb90YF9RZK_xCwBsX2zRQ8sWSkR0,9470
 afp/bindings/margin_account.py,sha256=ffkpf5HEXQCxiWuLpgDcHVAiaUVvbKU1Kt0K8tvgZcA,42461
 afp/bindings/margin_account_registry.py,sha256=mx9sAU6HuC09d-LAf9bzP57HPLa3M6qXpN7Lj-uiXSc,18800
 afp/bindings/mark_price_tracker_facet.py,sha256=vnVsAmpts_2Sv9Jmx3JlON8X8FJd9D2jOFhqSwXIA7A,2830
 afp/bindings/oracle_provider.py,sha256=CMpVAXdUuTP_W9ZE297B-m9MjuW90yCOhNLMVl3kCf0,15863
 afp/bindings/product_registry.py,sha256=HFWwbFKvXk0A2dZB6KBa0Ul8-vX9uvvtGj0dhRL9UUw,43701
-afp/bindings/system_viewer.py,sha256=v5yeogqMsRTjG3aRUd8O1oiQZ4ErEaOTfcctTfmcRu8,42767
-afp/bindings/trading_protocol.py,sha256=FSfK4HejLQUb7oNiGmyvyqbkUAG379OXNK2F5SG1Qzg,40642
-afp/config.py,sha256=3S7k49n4ZaRko3FX6Hw95r5L-sw2XiAjWtqYiX3Omx0,1017
+afp/bindings/system_viewer.py,sha256=Kwi-Kz2oKh5qWy17N0D2LyrAbkKz_sW9OxeWh6VX_j8,41347
+afp/bindings/trading_protocol.py,sha256=ZloF3REbjFq9v0UGVsM0_Lk0EhfWJKdeJ0PzVEnyZo0,39573
+afp/config.py,sha256=GbfvtsRkRDas4L-s1E-9AB7RitrN9JRQ79R5zfv6Ha0,1190
 afp/decorators.py,sha256=Ustc15RbXGYIEqDb9lXnd-bdhZJ8ZrztN4h_vjkLsG0,2692
 afp/enums.py,sha256=4dglBx4Amcu0GrlJn0cIj-rp9uDHZGfDEP_vMAO02xo,485
 afp/exceptions.py,sha256=RE8IE6akDgbar2PobdpOiBdGZZCYkb4jWf1ozJmdLaI,342
-afp/exchange.py,sha256=l8Cartp0R4PPe6O_Wu10YDw-5P_PbaAkd7w-W5QrlWY,5272
+afp/exchange.py,sha256=K_SkVyRvs7ebW82BGbxND1r5UHzb4_TNRfkOOIG-Dvs,5444
 afp/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 afp/schemas.py,sha256=8nlNPq6t_jmYEpa_WWhOIr_yvpQv5tj86uvpGTNHWZY,4996
 afp/signing.py,sha256=7fohnAvoiDA4ems_3OcVnr16OmYLSg9NnnCSzDplg6s,2235
 afp/validators.py,sha256=m61ZpP385CxsdDGJavPkXKTXnJAHKLCzedoZ8mL6daI,1818
-afp_sdk-0.2.1.dist-info/licenses/LICENSE,sha256=ZdaKItgc2ppfqta2OJV0oHpSJiK87PUxmUkUo-_0SB8,1065
-afp_sdk-0.2.1.dist-info/WHEEL,sha256=NHRAbdxxzyL9K3IO2LjmlNqKSyPZnKv2BD16YYVKo18,79
-afp_sdk-0.2.1.dist-info/METADATA,sha256=muk0O2vQMBGviKdMsUXxCwmwKUWJqviVSkPuz4y1yMo,5618
-afp_sdk-0.2.1.dist-info/RECORD,,
+afp_sdk-0.3.0.dist-info/licenses/LICENSE,sha256=ZdaKItgc2ppfqta2OJV0oHpSJiK87PUxmUkUo-_0SB8,1065
+afp_sdk-0.3.0.dist-info/WHEEL,sha256=Jb20R3Ili4n9P1fcwuLup21eQ5r9WXhs4_qy7VTrgPI,79
+afp_sdk-0.3.0.dist-info/METADATA,sha256=YJmCZfdcfYbJxL2DTDKNuoiPZW0SEb13aOVgxtRgzoc,6026
+afp_sdk-0.3.0.dist-info/RECORD,,

{afp_sdk-0.2.1.dist-info → afp_sdk-0.3.0.dist-info}/WHEEL

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