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

afp/bindings/margin_account.py

@@ -53,6 +53,11 @@ class MarginAccount:
             abi=ABI,
         )
 
+    @property
+    def Deposit(self) -> contract.ContractEvent:
+        """Binding for `event Deposit` on the MarginAccount contract."""
+        return self._contract.events.Deposit
+
     @property
     def FeeCollected(self) -> contract.ContractEvent:
         """Binding for `event FeeCollected` on the MarginAccount contract."""
@@ -68,11 +73,26 @@ class MarginAccount:
         """Binding for `event Initialized` on the MarginAccount contract."""
         return self._contract.events.Initialized
 
+    @property
+    def IntentAuthorized(self) -> contract.ContractEvent:
+        """Binding for `event IntentAuthorized` on the MarginAccount contract."""
+        return self._contract.events.IntentAuthorized
+
+    @property
+    def IntentRevoked(self) -> contract.ContractEvent:
+        """Binding for `event IntentRevoked` on the MarginAccount contract."""
+        return self._contract.events.IntentRevoked
+
     @property
     def PositionUpdated(self) -> contract.ContractEvent:
         """Binding for `event PositionUpdated` on the MarginAccount contract."""
         return self._contract.events.PositionUpdated
 
+    @property
+    def Withdraw(self) -> contract.ContractEvent:
+        """Binding for `event Withdraw` on the MarginAccount contract."""
+        return self._contract.events.Withdraw
+
     def authorize(
         self,
         intent_account: eth_typing.ChecksumAddress,
@@ -789,6 +809,25 @@ ABI = typing.cast(
             "name": "Unauthorized",
             "type": "error",
         },
+        {
+            "anonymous": False,
+            "inputs": [
+                {
+                    "indexed": True,
+                    "internalType": "address",
+                    "name": "user",
+                    "type": "address",
+                },
+                {
+                    "indexed": False,
+                    "internalType": "uint256",
+                    "name": "amount",
+                    "type": "uint256",
+                },
+            ],
+            "name": "Deposit",
+            "type": "event",
+        },
         {
             "anonymous": False,
             "inputs": [
@@ -840,6 +879,44 @@ ABI = typing.cast(
             "name": "Initialized",
             "type": "event",
         },
+        {
+            "anonymous": False,
+            "inputs": [
+                {
+                    "indexed": True,
+                    "internalType": "address",
+                    "name": "marginAccountID",
+                    "type": "address",
+                },
+                {
+                    "indexed": True,
+                    "internalType": "address",
+                    "name": "intentAccount",
+                    "type": "address",
+                },
+            ],
+            "name": "IntentAuthorized",
+            "type": "event",
+        },
+        {
+            "anonymous": False,
+            "inputs": [
+                {
+                    "indexed": True,
+                    "internalType": "address",
+                    "name": "marginAccountID",
+                    "type": "address",
+                },
+                {
+                    "indexed": True,
+                    "internalType": "address",
+                    "name": "intentAccount",
+                    "type": "address",
+                },
+            ],
+            "name": "IntentRevoked",
+            "type": "event",
+        },
         {
             "anonymous": False,
             "inputs": [
@@ -867,10 +944,41 @@ ABI = typing.cast(
                     "name": "costBasis",
                     "type": "int256",
                 },
+                {
+                    "indexed": False,
+                    "internalType": "uint256",
+                    "name": "price",
+                    "type": "uint256",
+                },
+                {
+                    "indexed": False,
+                    "internalType": "int256",
+                    "name": "quantity",
+                    "type": "int256",
+                },
             ],
             "name": "PositionUpdated",
             "type": "event",
         },
+        {
+            "anonymous": False,
+            "inputs": [
+                {
+                    "indexed": True,
+                    "internalType": "address",
+                    "name": "user",
+                    "type": "address",
+                },
+                {
+                    "indexed": False,
+                    "internalType": "uint256",
+                    "name": "amount",
+                    "type": "uint256",
+                },
+            ],
+            "name": "Withdraw",
+            "type": "event",
+        },
         {
             "inputs": [
                 {"internalType": "address", "name": "intentAccount", "type": "address"}

afp/bindings/product_registry.py

@@ -56,7 +56,6 @@ class Product:
     unit_value: int
     initial_margin_requirement: int
     maintenance_margin_requirement: int
-    offer_price_buffer: int
     auction_bounty: int
     tradeout_interval: int
     tick_size: int
@@ -221,7 +220,6 @@ class ProductRegistry:
                 product.unit_value,
                 product.initial_margin_requirement,
                 product.maintenance_margin_requirement,
-                product.offer_price_buffer,
                 product.auction_bounty,
                 product.tradeout_interval,
                 product.tick_size,
@@ -280,25 +278,6 @@ class ProductRegistry:
         ).call()
         return int(return_value)
 
-    def offer_price_buffer(
-        self,
-        product_id: hexbytes.HexBytes,
-    ) -> int:
-        """Binding for `offerPriceBuffer` on the ProductRegistry contract.
-
-        Parameters
-        ----------
-        product_id : hexbytes.HexBytes
-
-        Returns
-        -------
-        int
-        """
-        return_value = self._contract.functions.offerPriceBuffer(
-            product_id,
-        ).call()
-        return int(return_value)
-
     def oracle_specification(
         self,
         product_id: hexbytes.HexBytes,
@@ -395,8 +374,7 @@ class ProductRegistry:
             int(return_value[9]),
             int(return_value[10]),
             int(return_value[11]),
-            int(return_value[12]),
-            str(return_value[13]),
+            str(return_value[12]),
         )
 
     def proxiable_uuid(
@@ -447,7 +425,6 @@ class ProductRegistry:
                 product.unit_value,
                 product.initial_margin_requirement,
                 product.maintenance_margin_requirement,
-                product.offer_price_buffer,
                 product.auction_bounty,
                 product.tradeout_interval,
                 product.tick_size,
@@ -856,11 +833,6 @@ ABI = typing.cast(
                             "name": "maintenanceMarginRequirement",
                             "type": "uint16",
                         },
-                        {
-                            "internalType": "uint64",
-                            "name": "offerPriceBuffer",
-                            "type": "uint64",
-                        },
                         {
                             "internalType": "uint64",
                             "name": "auctionBounty",
@@ -913,15 +885,6 @@ ABI = typing.cast(
             "stateMutability": "view",
             "type": "function",
         },
-        {
-            "inputs": [
-                {"internalType": "bytes32", "name": "productId", "type": "bytes32"}
-            ],
-            "name": "offerPriceBuffer",
-            "outputs": [{"internalType": "uint256", "name": "", "type": "uint256"}],
-            "stateMutability": "view",
-            "type": "function",
-        },
         {
             "inputs": [
                 {"internalType": "bytes32", "name": "productId", "type": "bytes32"}
@@ -1073,11 +1036,6 @@ ABI = typing.cast(
                             "name": "maintenanceMarginRequirement",
                             "type": "uint16",
                         },
-                        {
-                            "internalType": "uint64",
-                            "name": "offerPriceBuffer",
-                            "type": "uint64",
-                        },
                         {
                             "internalType": "uint64",
                             "name": "auctionBounty",
@@ -1203,11 +1161,6 @@ ABI = typing.cast(
                             "name": "maintenanceMarginRequirement",
                             "type": "uint16",
                         },
-                        {
-                            "internalType": "uint64",
-                            "name": "offerPriceBuffer",
-                            "type": "uint64",
-                        },
                         {
                             "internalType": "uint64",
                             "name": "auctionBounty",

afp/bindings/system_viewer.py

@@ -324,8 +324,7 @@ class SystemViewer:
                 int(return_value_elem[9]),
                 int(return_value_elem[10]),
                 int(return_value_elem[11]),
-                int(return_value_elem[12]),
-                str(return_value_elem[13]),
+                str(return_value_elem[12]),
             )
             for return_value_elem in return_value
         ]
@@ -929,11 +928,6 @@ ABI = typing.cast(
                             "name": "maintenanceMarginRequirement",
                             "type": "uint16",
                         },
-                        {
-                            "internalType": "uint64",
-                            "name": "offerPriceBuffer",
-                            "type": "uint64",
-                        },
                         {
                             "internalType": "uint64",
                             "name": "auctionBounty",

afp/config.py

@@ -1,42 +1,28 @@
-import os
+from dataclasses import dataclass
 
-from web3 import Web3
+from eth_typing.evm import ChecksumAddress
 
+from .auth import Authenticator
 
-# Constants from clearing/contracts/lib/constants.sol
-RATE_MULTIPLIER = 10**4
-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-stable.up.railway.app"
-)
+@dataclass(frozen=True)
+class Config:
+    authenticator: Authenticator | None
 
-CHAIN_ID = int(os.getenv("AFP_CHAIN_ID", 65000000))
+    # Venue parameters
+    exchange_url: str
 
-CLEARING_DIAMOND_ADDRESS = Web3.to_checksum_address(
-    os.getenv(
-        "AFP_CLEARING_DIAMOND_ADDRESS", "0x5B5411F1548254d25360d71FE40cFc1cC983B2A2"
-    )
-)
-MARGIN_ACCOUNT_REGISTRY_ADDRESS = Web3.to_checksum_address(
-    os.getenv(
-        "AFP_MARGIN_ACCOUNT_REGISTRY_ADDRESS",
-        "0x99f4FA9Cdce7AD227eB84907936a8FeF2095D846",
-    )
-)
-ORACLE_PROVIDER_ADDRESS = Web3.to_checksum_address(
-    os.getenv(
-        "AFP_ORACLE_PROVIDER_ADDRESS", "0xF2A2A27da33D30B4BF38D7e186E7B0b1e964e55c"
-    )
-)
-PRODUCT_REGISTRY_ADDRESS = Web3.to_checksum_address(
-    os.getenv(
-        "AFP_PRODUCT_REGISTRY_ADDRESS", "0x86B3829471929B115367DA0958f56A6AB844b08e"
-    )
-)
-SYSTEM_VIEWER_ADDRESS = Web3.to_checksum_address(
-    os.getenv("AFP_SYSTEM_VIEWER_ADDRESS", "0xfF2DFcC44a95cce96E03EfC33C65c8Be671Bae5B")
-)
+    # Blockchain parameters
+    rpc_url: str | None
+    chain_id: int
+    gas_limit: int | None
+    max_fee_per_gas: int | None
+    max_priority_fee_per_gas: int | None
+    timeout_seconds: int
+
+    # Clearing System parameters
+    clearing_diamond_address: ChecksumAddress
+    margin_account_registry_address: ChecksumAddress
+    oracle_provider_address: ChecksumAddress
+    product_registry_address: ChecksumAddress
+    system_viewer_address: ChecksumAddress

afp/constants.py

@@ -0,0 +1,52 @@
+import os
+from types import SimpleNamespace
+
+
+def _int_or_none(value: str | None) -> int | None:
+    return int(value) if value is not None else None
+
+
+USER_AGENT = "afp-sdk"
+DEFAULT_EXCHANGE_API_VERSION = 1
+
+# Constants from clearing/contracts/lib/constants.sol
+RATE_MULTIPLIER = 10**4
+FEE_RATE_MULTIPLIER = 10**6
+FULL_PRECISION_MULTIPLIER = 10**18
+
+defaults = SimpleNamespace(
+    # Authentication parameters
+    KEYFILE=os.getenv("AFP_KEYFILE", None),
+    KEYFILE_PASSWORD=os.getenv("AFP_KEYFILE_PASSWORD", ""),
+    PRIVATE_KEY=os.getenv("AFP_PRIVATE_KEY", None),
+    # Venue parameters
+    EXCHANGE_URL=os.getenv(
+        "AFP_EXCHANGE_URL", "https://afp-exchange-stable.up.railway.app"
+    ),
+    # Blockchain parameters
+    RPC_URL=os.getenv("AFP_RPC_URL", None),
+    CHAIN_ID=int(os.getenv("AFP_CHAIN_ID", 65000000)),
+    GAS_LIMIT=_int_or_none(os.getenv("AFP_GAS_LIMIT", None)),
+    MAX_FEE_PER_GAS=_int_or_none(os.getenv("AFP_MAX_FEE_PER_GAS", None)),
+    MAX_PRIORITY_FEE_PER_GAS=_int_or_none(
+        os.getenv("AFP_MAX_PRIORITY_FEE_PER_GAS", None)
+    ),
+    TIMEOUT_SECONDS=int(os.getenv("AFP_TIMEOUT_SECONDS", 10)),
+    # Clearing System parameters
+    CLEARING_DIAMOND_ADDRESS=os.getenv(
+        "AFP_CLEARING_DIAMOND_ADDRESS", "0x5B5411F1548254d25360d71FE40cFc1cC983B2A2"
+    ),
+    MARGIN_ACCOUNT_REGISTRY_ADDRESS=os.getenv(
+        "AFP_MARGIN_ACCOUNT_REGISTRY_ADDRESS",
+        "0x99f4FA9Cdce7AD227eB84907936a8FeF2095D846",
+    ),
+    ORACLE_PROVIDER_ADDRESS=os.getenv(
+        "AFP_ORACLE_PROVIDER_ADDRESS", "0xF2A2A27da33D30B4BF38D7e186E7B0b1e964e55c"
+    ),
+    PRODUCT_REGISTRY_ADDRESS=os.getenv(
+        "AFP_PRODUCT_REGISTRY_ADDRESS", "0x86B3829471929B115367DA0958f56A6AB844b08e"
+    ),
+    SYSTEM_VIEWER_ADDRESS=os.getenv(
+        "AFP_SYSTEM_VIEWER_ADDRESS", "0xfF2DFcC44a95cce96E03EfC33C65c8Be671Bae5B"
+    ),
+)

afp/decorators.py

@@ -45,8 +45,10 @@ def convert_web3_error(*contract_abis: ABI) -> Callable[..., Any]:
                     )
                 if reason == "no data":
                     reason = "Unspecified reason"
+                if reason is None:
+                    reason = "Unknown error"
             raise ClearingSystemError(
-                "Contract call reverted" + f": {reason}" if reason else ""
+                "Contract call reverted" + (f": {reason}" if reason else "")
             ) from contract_error
         except Web3RPCError as rpc_error:
             reason = None

afp/exceptions.py

@@ -1,12 +1,16 @@
-class BaseException(Exception):
+class AFPException(Exception):
     pass
 
 
-class ClearingSystemError(BaseException):
+class ConfigurationError(AFPException):
     pass
 
 
-class ExchangeError(BaseException):
+class ClearingSystemError(AFPException):
+    pass
+
+
+class ExchangeError(AFPException):
     pass
 
 

afp/exchange.py

@@ -1,10 +1,11 @@
 import json
+import re
 from typing import Any, Generator
 
 import requests
 from requests import Response, Session
 
-from . import config
+from . import constants
 from .exceptions import (
     AuthenticationError,
     AuthorizationError,
@@ -26,11 +27,16 @@ from .schemas import (
 
 
 class ExchangeClient:
+    _base_url: str
     _session: Session
 
-    def __init__(self):
+    def __init__(self, base_url: str):
+        self._base_url = re.sub(r"/$", "", base_url)
         self._session = Session()
 
+    def __repr__(self) -> str:
+        return f"{self.__class__.__name__}(base_url={self._base_url})"
+
     # POST /nonce
     def generate_login_nonce(self) -> str:
         response = self._send_request("GET", "/nonce")
@@ -71,8 +77,10 @@ class ExchangeClient:
         return Order(**response.json())
 
     # GET /orders
-    def get_open_orders(self) -> list[Order]:
-        response = self._send_request("GET", "/orders")
+    def get_open_orders(self, product_id: str | None = None) -> list[Order]:
+        response = self._send_request(
+            "GET", "/orders", params=({"product_id": product_id} if product_id else {})
+        )
         return [Order(**item) for item in response.json()["orders"]]
 
     # GET /orders/{order_id}
@@ -121,19 +129,19 @@ class ExchangeClient:
         endpoint: str,
         *,
         stream: bool = False,
-        api_version: int = config.DEFAULT_EXCHANGE_API_VERSION,
+        api_version: int = constants.DEFAULT_EXCHANGE_API_VERSION,
         **kwargs: Any,
     ) -> Response:
         kwargs["headers"] = {
             "Content-Type": "application/json",
             "Accept": "application/x-ndjson" if stream else "application/json",
-            "User-Agent": config.USER_AGENT,
+            "User-Agent": constants.USER_AGENT,
         }
 
         try:
             response = self._session.request(
                 method,
-                f"{config.EXCHANGE_URL}/v{api_version}{endpoint}",
+                f"{self._base_url}/v{api_version}{endpoint}",
                 stream=stream,
                 **kwargs,
             )

afp/{signing.py → hashing.py}

@@ -1,13 +1,11 @@
 from typing import Any, cast
 
 from eth_abi.packed import encode_packed
-from eth_account import messages
 from eth_typing.evm import ChecksumAddress
-from eth_account.signers.local import LocalAccount
 from hexbytes import HexBytes
 from web3 import Web3
 
-from . import config
+from . import constants
 from .bindings import clearing_facet
 from .schemas import IntentData, OrderSide
 
@@ -44,7 +42,7 @@ def generate_intent_hash(
         HexBytes(intent_data.product_id),
         int(intent_data.limit_price * 10**tick_size),
         intent_data.quantity,
-        int(intent_data.max_trading_fee_rate * config.FEE_RATE_MULTIPLIER),
+        int(intent_data.max_trading_fee_rate * constants.FEE_RATE_MULTIPLIER),
         int(intent_data.good_until_time.timestamp()),
         ORDER_SIDE_MAPPING[intent_data.side],
     ]
@@ -57,13 +55,7 @@ def generate_order_cancellation_hash(nonce: int, intent_hash: str) -> HexBytes:
     return Web3.keccak(encode_packed(types, values))
 
 
-def generate_product_id(builder: LocalAccount, symbol: str) -> HexBytes:
+def generate_product_id(builder_address: ChecksumAddress, symbol: str) -> HexBytes:
     types = ["address", "string"]
-    values: list[Any] = [builder.address, symbol]
+    values: list[Any] = [builder_address, symbol]
     return Web3.keccak(encode_packed(types, values))
-
-
-def sign_message(account: LocalAccount, message: bytes) -> HexBytes:
-    eip191_message = messages.encode_defunct(message)
-    signed_message = account.sign_message(eip191_message)
-    return signed_message.signature

afp/schemas.py

@@ -66,6 +66,9 @@ class ExchangeProduct(Model):
     tick_size: int
     collateral_asset: str
 
+    def __str__(self) -> str:
+        return self.id
+
 
 class IntentData(Model):
     trading_protocol_id: str
@@ -152,6 +155,12 @@ class MarketDepthData(Model):
 # Clearing API
 
 
+class Transaction(Model):
+    hash: str
+    data: dict[str, Any]
+    receipt: dict[str, Any]
+
+
 class Position(Model):
     id: str
     quantity: int
@@ -184,7 +193,6 @@ class ProductSpecification(Model):
     unit_value: Annotated[Decimal, Field(gt=0)]
     initial_margin_requirement: Annotated[Decimal, Field(gt=0)]
     maintenance_margin_requirement: Annotated[Decimal, Field(gt=0)]
-    offer_price_buffer: Annotated[Decimal, Field(ge=0, lt=1)]
     auction_bounty: Annotated[Decimal, Field(ge=0, le=1)]
     tradeout_interval: Annotated[int, Field(ge=0)]
     extended_metadata: str

afp/validators.py

@@ -22,6 +22,7 @@ def validate_timedelta(value: timedelta) -> timedelta:
 
 
 def validate_hexstr(value: str, length: int | None = None) -> str:
+    value = str(value)
     if not value.startswith("0x"):
         raise ValueError(f"{value} should start with '0x'")
     try: