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

afp/api/trading.py

@@ -5,7 +5,7 @@ from typing import Generator
 
 from web3 import Web3
 
-from .. import signing, validators
+from .. import hashing, validators
 from ..decorators import refresh_token_on_expiry
 from ..enums import OrderType
 from ..schemas import (
@@ -25,20 +25,7 @@ from .base import ExchangeAPI
 
 
 class Trading(ExchangeAPI):
-    """API for trading in the AutEx exchange.
-
-    Authenticates with the exchange on creation.
-
-    Parameters
-    ----------
-    private_key : str
-        The private key of the account that submits intents to the exchange.
-
-    Raises
-    ------
-    afp.exceptions.AuthenticationError
-        If the exchange rejects the login attempt.
-    """
+    """API for trading in the AutEx exchange."""
 
     @staticmethod
     def _generate_nonce() -> int:
@@ -89,7 +76,7 @@ class Trading(ExchangeAPI):
         margin_account_id = (
             validators.validate_address(margin_account_id)
             if margin_account_id is not None
-            else self._account.address
+            else self._authenticator.address
         )
 
         intent_data = IntentData(
@@ -104,17 +91,17 @@ class Trading(ExchangeAPI):
             good_until_time=good_until_time,
             nonce=self._generate_nonce(),
         )
-        intent_hash = signing.generate_intent_hash(
+        intent_hash = hashing.generate_intent_hash(
             intent_data=intent_data,
             margin_account_id=margin_account_id,
-            intent_account_id=self._account.address,
+            intent_account_id=self._authenticator.address,
             tick_size=product.tick_size,
         )
-        signature = signing.sign_message(self._account, intent_hash)
+        signature = self._authenticator.sign_message(intent_hash)
         return Intent(
             hash=Web3.to_hex(intent_hash),
             margin_account_id=margin_account_id,
-            intent_account_id=self._account.address,
+            intent_account_id=self._authenticator.address,
             signature=Web3.to_hex(signature),
             data=intent_data,
         )
@@ -160,12 +147,12 @@ class Trading(ExchangeAPI):
             If the exchange rejects the cancellation.
         """
         nonce = self._generate_nonce()
-        cancellation_hash = signing.generate_order_cancellation_hash(nonce, intent_hash)
-        signature = signing.sign_message(self._account, cancellation_hash)
+        cancellation_hash = hashing.generate_order_cancellation_hash(nonce, intent_hash)
+        signature = self._authenticator.sign_message(cancellation_hash)
         cancellation_data = OrderCancellationData(
             intent_hash=intent_hash,
             nonce=nonce,
-            intent_account_id=self._account.address,
+            intent_account_id=self._authenticator.address,
             signature=Web3.to_hex(signature),
         )
         submission = OrderSubmission(
@@ -174,7 +161,6 @@ class Trading(ExchangeAPI):
         )
         return self._exchange.submit_order(submission)
 
-    @refresh_token_on_expiry
     def products(self) -> list[ExchangeProduct]:
         """Retrieves the products approved for trading on the exchange.
 
@@ -184,7 +170,6 @@ class Trading(ExchangeAPI):
         """
         return self._exchange.get_approved_products()
 
-    @refresh_token_on_expiry
     def product(self, product_id: str) -> ExchangeProduct:
         """Retrieves a product for trading by its ID.
 
@@ -266,7 +251,7 @@ class Trading(ExchangeAPI):
         list of afp.schemas.OrderFill
         """
         filter = OrderFillFilter(
-            intent_account_id=self._account.address,
+            intent_account_id=self._authenticator.address,
             product_id=product_id,
             margin_account_id=margin_account_id,
             intent_hash=intent_hash,
@@ -302,7 +287,7 @@ class Trading(ExchangeAPI):
         afp.schemas.OrderFill
         """
         filter = OrderFillFilter(
-            intent_account_id=self._account.address,
+            intent_account_id=self._authenticator.address,
             product_id=product_id,
             margin_account_id=margin_account_id,
             intent_hash=intent_hash,
@@ -312,7 +297,6 @@ class Trading(ExchangeAPI):
         )
         yield from self._exchange.iter_order_fills(filter)
 
-    @refresh_token_on_expiry
     def market_depth(self, product_id: str) -> MarketDepthData:
         """Retrieves the depth of market for the given product.
 
@@ -332,7 +316,6 @@ class Trading(ExchangeAPI):
         value = validators.validate_hexstr32(product_id)
         return self._exchange.get_market_depth_data(value)
 
-    @refresh_token_on_expiry
     def iter_market_depth(
         self, product_id: str
     ) -> Generator[MarketDepthData, None, None]:

afp/auth.py

@@ -0,0 +1,66 @@
+import json
+import os
+from typing import Protocol, cast
+
+from eth_account.account import Account
+from eth_account.datastructures import SignedTransaction
+from eth_account.messages import encode_defunct
+from eth_account.signers.local import LocalAccount
+from eth_account.types import TransactionDictType
+from eth_typing.evm import ChecksumAddress
+from hexbytes import HexBytes
+from web3.types import TxParams
+
+
+class Authenticator(Protocol):
+    address: ChecksumAddress
+
+    def sign_message(self, message: bytes) -> HexBytes: ...
+
+    def sign_transaction(self, params: TxParams) -> SignedTransaction: ...
+
+
+class PrivateKeyAuthenticator(Authenticator):
+    """Authenticates with a private key specified in a constructor argument.
+
+    Parameters
+    ----------
+    private_key: str
+        The private key of a blockchain account.
+    """
+
+    _account: LocalAccount
+
+    def __init__(self, private_key: str) -> None:
+        self._account = Account.from_key(private_key)
+        self.address = self._account.address
+
+    def sign_message(self, message: bytes) -> HexBytes:
+        eip191_message = encode_defunct(message)
+        signed_message = self._account.sign_message(eip191_message)
+        return signed_message.signature
+
+    def sign_transaction(self, params: TxParams) -> SignedTransaction:
+        return self._account.sign_transaction(cast(TransactionDictType, params))
+
+    def __repr__(self):
+        return f"{self.__class__.__name__}(address='{self.address}')"
+
+
+class KeyfileAuthenticator(PrivateKeyAuthenticator):
+    """Authenticates with a private key read from an encrypted keyfile.
+
+    Parameters
+    ----------
+    keyfile : str
+        The path to the keyfile.
+    password : str
+        The password for decrypting the keyfile.
+    """
+
+    def __init__(self, key_file: str, password: str) -> None:
+        with open(os.path.expanduser(key_file), encoding="utf8") as f:
+            key_data = json.load(f)
+
+        private_key = Account.decrypt(key_data, password=password)
+        super().__init__(private_key.to_0x_hex())

afp/bindings/facade.py

@@ -1,8 +1,9 @@
 from itertools import chain
 
+from eth_typing.evm import ChecksumAddress
+
 from web3 import Web3
 
-from .. import config
 from . import (
     auctioneer_facet,
     bankruptcy_facet,
@@ -14,6 +15,7 @@ from . import (
     product_registry,
     system_viewer,
 )
+from ..constants import defaults
 
 # In order to include a facet in the ClearingDiamond facade:
 # 1. Add its ABI to CLEARING_DIAMOND_ABI
@@ -46,10 +48,10 @@ class ClearingDiamond(
     w3 : web3.Web3
     """
 
-    def __init__(self, w3: Web3):
-        self._contract = w3.eth.contract(
-            address=config.CLEARING_DIAMOND_ADDRESS, abi=CLEARING_DIAMOND_ABI
-        )
+    def __init__(
+        self, w3: Web3, address: ChecksumAddress = defaults.CLEARING_DIAMOND_ADDRESS
+    ):
+        self._contract = w3.eth.contract(address=address, abi=CLEARING_DIAMOND_ABI)
 
 
 class MarginAccountRegistry(margin_account_registry.MarginAccountRegistry):
@@ -60,8 +62,12 @@ class MarginAccountRegistry(margin_account_registry.MarginAccountRegistry):
     w3 : web3.Web3
     """
 
-    def __init__(self, w3: Web3):
-        super().__init__(w3, config.MARGIN_ACCOUNT_REGISTRY_ADDRESS)
+    def __init__(
+        self,
+        w3: Web3,
+        address: ChecksumAddress = defaults.MARGIN_ACCOUNT_REGISTRY_ADDRESS,
+    ):
+        super().__init__(w3, address)
 
 
 class OracleProvider(oracle_provider.OracleProvider):
@@ -72,8 +78,10 @@ class OracleProvider(oracle_provider.OracleProvider):
     w3 : web3.Web3
     """
 
-    def __init__(self, w3: Web3):
-        super().__init__(w3, config.ORACLE_PROVIDER_ADDRESS)
+    def __init__(
+        self, w3: Web3, address: ChecksumAddress = defaults.ORACLE_PROVIDER_ADDRESS
+    ):
+        super().__init__(w3, address)
 
 
 class ProductRegistry(product_registry.ProductRegistry):
@@ -84,8 +92,10 @@ class ProductRegistry(product_registry.ProductRegistry):
     w3 : web3.Web3
     """
 
-    def __init__(self, w3: Web3):
-        super().__init__(w3, config.PRODUCT_REGISTRY_ADDRESS)
+    def __init__(
+        self, w3: Web3, address: ChecksumAddress = defaults.PRODUCT_REGISTRY_ADDRESS
+    ):
+        super().__init__(w3, address)
 
 
 class SystemViewer(system_viewer.SystemViewer):
@@ -96,5 +106,7 @@ class SystemViewer(system_viewer.SystemViewer):
     w3 : web3.Web3
     """
 
-    def __init__(self, w3: Web3):
-        super().__init__(w3, config.SYSTEM_VIEWER_ADDRESS)
+    def __init__(
+        self, w3: Web3, address: ChecksumAddress = defaults.SYSTEM_VIEWER_ADDRESS
+    ):
+        super().__init__(w3, address)

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")
@@ -123,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

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: