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

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/enums.py

@@ -1,6 +1,12 @@
 from enum import StrEnum
 
 
+class ListingState(StrEnum):
+    PRIVATE = "PRIVATE"
+    PUBLIC = "PUBLIC"
+    DELISTED = "DELISTED"
+
+
 class OrderType(StrEnum):
     LIMIT_ORDER = "LIMIT_ORDER"
     CANCEL_ORDER = "CANCEL_ORDER"

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,
@@ -15,7 +16,8 @@ from .exceptions import (
 from .schemas import (
     ExchangeParameters,
     ExchangeProduct,
-    ExchangeProductSubmission,
+    ExchangeProductListingSubmission,
+    ExchangeProductUpdateSubmission,
     LoginSubmission,
     MarketDepthData,
     Order,
@@ -26,11 +28,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")
@@ -54,14 +61,22 @@ class ExchangeClient:
         return ExchangeProduct(**response.json())
 
     # POST /products
-    def approve_product(self, product_submission: ExchangeProductSubmission) -> None:
+    def list_product(
+        self, listing_submission: ExchangeProductListingSubmission
+    ) -> None:
         self._send_request(
-            "POST", "/products", data=product_submission.model_dump_json()
+            "POST", "/products", data=listing_submission.model_dump_json()
         )
 
-    # DELETE /products
-    def delist_product(self, product_id: str) -> None:
-        self._send_request("DELETE", f"/products/{product_id}")
+    # PATCH /products
+    def update_product_listing(
+        self, product_id: str, update_submission: ExchangeProductUpdateSubmission
+    ) -> None:
+        self._send_request(
+            "PATCH",
+            f"/products/{product_id}",
+            data=update_submission.model_dump_json(),
+        )
 
     # POST /orders
     def submit_order(self, order_submission: OrderSubmission) -> Order:
@@ -123,19 +138,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

@@ -15,7 +15,7 @@ from pydantic import (
 )
 
 from . import validators
-from .enums import OrderSide, OrderState, OrderType, TradeState
+from .enums import ListingState, OrderSide, OrderState, OrderType, TradeState
 
 
 # Use datetime internally but UNIX timestamp in client-server communication
@@ -53,18 +53,29 @@ class ExchangeParameters(Model):
     trading_fee_rate: Decimal
 
 
-# Trading API
+# Admin API
 
 
-class ExchangeProductSubmission(Model):
+class ExchangeProductListingSubmission(Model):
     id: Annotated[str, AfterValidator(validators.validate_hexstr32)]
 
 
+class ExchangeProductUpdateSubmission(Model):
+    listing_state: ListingState
+
+
+# Trading API
+
+
 class ExchangeProduct(Model):
     id: str
     symbol: str
     tick_size: int
     collateral_asset: str
+    listing_state: ListingState
+
+    def __str__(self) -> str:
+        return self.id
 
 
 class IntentData(Model):
@@ -152,6 +163,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
@@ -188,6 +205,9 @@ class ProductSpecification(Model):
     tradeout_interval: Annotated[int, Field(ge=0)]
     extended_metadata: str
 
+    def __str__(self) -> str:
+        return self.id
+
 
 # Liquidation API
 

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:

{afp_sdk-0.4.0.dist-info → afp_sdk-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: afp-sdk
-Version: 0.4.0
+Version: 0.5.1
 Summary: Autonomous Futures Protocol Python SDK
 Keywords: autonity,web3,trading,crypto,prediction,forecast,markets
 License-Expression: MIT
@@ -25,6 +25,10 @@ Description-Content-Type: text/markdown
 
 # Autonomous Futures Protocol Python SDK
 
+Decentralized clearing and creation of Forecast Futures on any timeseries.
+
+![CI](https://github.com/autonity/afp-sdk/actions/workflows/ci.yml/badge.svg)
+
 ## Installation
 
 This library is published on PyPI as the [afp-sdk](https://pypi.org/project/afp-sdk/)
@@ -34,6 +38,11 @@ package. It can be installed in a virtualenv with:
 pip install afp-sdk
 ```
 
+## Documentation
+
+See [afp.autonity.org](https://afp.autonity.org/) for the Autonomous Futures Protocol
+documentation, including the Python SDK reference.
+
 ## Overview
 
 The `afp` package consists of the following:
@@ -43,6 +52,13 @@ The `afp` package consists of the following:
 - `afp.bindings` submodule: Low-level API that provides typed Python bindings
   for the Clearing System smart contracts.
 
+## Configuration
+
+By default the SDK communicates with the AFP Clearing System contracts on
+Autonity Mainnet, and the AutEx Exchange. Connection parameters can be
+overridden via the `afp.AFP` constructor and environment variables; see the
+documentation of the `afp.AFP` class for the available parameters.
+
 ## Usage
 
 ### Preparation
@@ -53,7 +69,8 @@ In order to trade in the AFP system, traders need to prepare the following:
 - The address of the product's collateral token.
 - An Autonity account for managing the margin account. It needs to hold a
   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.
+- An Autonity account for signing intents and submitting trades to the
+  exchange. 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).
 
@@ -64,57 +81,60 @@ import os
 
 PRODUCT_ID = "0x38d502bb683f53ec7c3d7a14b4aa47ac717659e121426131c0189c15bf4b9460"
 COLLATERAL_ASSET = "0xD1A1e4035a164cF42228A8aAaBC2c0Ac9e49687B"
-MARGIN_ACCOUNT_PRIVATE_KEY = os.environ["MARGIN_ACCOUNT_PRIVATE_KEY"]
-INTENT_ACCOUNT_PRIVATE_KEY = os.environ["INTENT_ACCOUNT_PRIVATE_KEY"]
+PRIVATE_KEY = os.environ["PRIVATE_KEY"]
 AUTONITY_RPC_URL = "https://bakerloo.autonity-apis.com"
 ```
 
-Account IDs (addresses) may be retrieved from the private keys with `eth_account`:
+### Configuration
 
-```py
-from eth_account import Account
-
-MARGIN_ACCOUNT_ID = Account.from_key(MARGIN_ACCOUNT_PRIVATE_KEY).address
-INTENT_ACCOUNT_ID = Account.from_key(INTENT_ACCOUNT_PRIVATE_KEY).address
-```
+An application instance can be created with the `afp.AFP()` constructor. An instance
+is associated with a trading venue and a margin account.
 
-### Clearing API
+The required constructor arguments are the RPC provider URL and the authenticator of
+the blockchain account that manages the margin account.
 
-Functions of the Clearing API can be accessed via the `afp.Clearing`
-session object. It connects to the specified Autonity RPC provider and
-communicates with the Clearing System smart contracts.
+An "authenticator" is a service that implements the `afp.Authenticator` protocol.
+Available options are `afp.PrivateKeyAuthenticator` that reads the private key
+from a constructor argument, and `afp.KeyfileAuthenticator` that reads the private
+key from an encrypted keyfile.
 
 ```py
 import afp
 
-clearing = afp.Clearing(MARGIN_ACCOUNT_PRIVATE_KEY, AUTONITY_RPC_URL)
+app = afp.AFP(
+    rpc_url=AUTONITY_RPC_URL,
+    authenticator=afp.PrivateKeyAuthenticator(PRIVATE_KEY),
+)
 ```
 
-Collateral can be deposited into the margin account with
-`clearing.deposit_into_margin_account()`.
+### Margin Account API
 
-```py
-from decimal import Decimal
+Margin accounts can be managed via the `MarginAccount` session object. It
+connects to the specified Autonity RPC provider and communicates with the
+Clearing System smart contracts.
 
-clearing.deposit_into_margin_account(COLLATERAL_ASSET, Decimal("100.00"))
-print(clearing.capital(COLLATERAL_ASSET))
+```py
+margin_account = app.MarginAccount()
 ```
 
-The intent account should be authorized to submit orders. This is only required
-if the intent account and the margin account are different.
+Collateral can be deposited into the margin account with `margin_account.deposit()`.
 
 ```py
-clearing.authorize(COLLATERAL_ASSET, INTENT_ACCOUNT_ID)
+from decimal import Decimal
+
+margin_account.deposit(COLLATERAL_ASSET, Decimal("100.00"))
+print(margin_account.capital(COLLATERAL_ASSET))
 ```
 
 ### Trading API
 
-The functions of the trading API can be accessed via the `afp.Trading` session
-object. It communicates with the AutEx exchange and authenticates on creation with
-the intent account's private key.
+Functions of the trading API can be accessed via the `Trading` session object.
+It communicates with the AutEx exchange and authenticates on creation with the
+intent account's private key. The intent account authenticator is optional, it
+defaults to the authenticator set in the `AFP` constructor.
 
 ```py
-trading = afp.Trading(INTENT_ACCOUNT_PRIVATE_KEY)
+trading = app.Trading()
 ```
 
 To start trading a product, its parameters shall be retrieved from the server.
@@ -169,28 +189,12 @@ 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.
 
-- Dependecies can be installed with the `uv sync` command.
-- Linters can be executed with the `uv run poe lint` command.
-- Tests can be executed with the `uv run poe test` command.
-- Distributions can be checked before release with the `uv run poe check-dist` command.
-- Markdown API documentation can be generated with the `uv run poe doc-gen` command.
+- Install dependencies with the `uv sync` command.
+- Execute linters with the `uv run poe lint` command.
+- Run tests with the `uv run poe test` command.
+- Check distributions before release with the `uv run poe check-dist` command.
+- Generate markdown API documentation with the `uv run poe doc-gen` command.

afp_sdk-0.5.1.dist-info/RECORD

@@ -0,0 +1,37 @@
+afp/__init__.py,sha256=tvvXz4miC3QI8wy4vjAAf_LtL-19eEgBRA6dnrh3LA8,349
+afp/afp.py,sha256=1xpocnWjALP6QlA-Hn7G2znttJ-ikcb2WA9sLueY3zc,9107
+afp/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+afp/api/admin.py,sha256=6TiWCo0SB41CtXYTkTYYGQY7MrdB6OMTyU3-0J0V_7o,2170
+afp/api/base.py,sha256=5X1joEwFX4gxYUDCSTvp_hSFCfLZCktnW-UtZFxDquk,4471
+afp/api/margin_account.py,sha256=sC1DF7J3QTHR7cXcRjTG33oZswVy6qr9xnevQbrQ-ew,15256
+afp/api/product.py,sha256=2N4bPBahuw19GcBbBL20oQ5RFRuUxa5LOZzmN7hs39U,10156
+afp/api/trading.py,sha256=exQQ3LJA6XCbRAUBuYVjSJ5PHFi4COyqDORxC37LLfQ,10379
+afp/auth.py,sha256=sV_9E6CgRWV1xYoppc4IdrnqNo5ZNDBIp6QF3fQbMWE,2055
+afp/bindings/__init__.py,sha256=_n9xoogYi8AAlSx_PE-wjnwP1ujVyDUwoRM0BSm243U,1271
+afp/bindings/auctioneer_facet.py,sha256=4p906zdU2lUsqpWlsiLE3dlxTPrlNpqk8DtjiQUWJ8M,23919
+afp/bindings/bankruptcy_facet.py,sha256=-Kp4Ap5PLAmo_tFrp-1s_yAh0mtHS20z3BC5YIrVjrU,12548
+afp/bindings/clearing_facet.py,sha256=cfyDo-s9_DesbK1Oe-8rfbTCS3HBX9X-L6HbzSydEFk,34898
+afp/bindings/erc20.py,sha256=-jw7ohcEbUL7g3PpK3-a5_7ClUDCDHt1bezm-w7exzo,10822
+afp/bindings/facade.py,sha256=8IehHRqmt9xVe4OJLVAfedprv1fc6mLj7COOjpI_AwA,2588
+afp/bindings/final_settlement_facet.py,sha256=1U5F3WFvf4GUml3gb90YF9RZK_xCwBsX2zRQ8sWSkR0,9470
+afp/bindings/margin_account.py,sha256=hqvHpfM62SAEXSt__NZzAQGu9z7DnIa9LbSgHHkhsKE,45872
+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=-_h786jzMCsaTqqnoxpmVgBkGf45eCUMthp_PkqrET0,42137
+afp/bindings/system_viewer.py,sha256=0FivdhpfXMrBesXcHkfO9uELyr7GiRmGe36xS5sURGE,41094
+afp/bindings/trading_protocol.py,sha256=ZloF3REbjFq9v0UGVsM0_Lk0EhfWJKdeJ0PzVEnyZo0,39573
+afp/config.py,sha256=_WKywiuty8poE1A0v46uBe1JGpfCzRlxCPamKennfpE,699
+afp/constants.py,sha256=XIph4R0Tx-BPw_NZJgWUtb7NdS9sYzEciFRSStm3VMs,1840
+afp/decorators.py,sha256=SEUQtbgPGc4iVPtBQV2eiCejcDAVImmXcI0uPXFhtJA,2774
+afp/enums.py,sha256=U5b_3RteMiVJozp4WYAKzUfPXI1RdJLEK19jAg-LN8Q,588
+afp/exceptions.py,sha256=frdS-EH84K0fOf92RgRgNkTe3VII2m36XNCS8eyXLLM,390
+afp/exchange.py,sha256=MXQ-RhcI76l6bA9_IDTUq0RQGfwxBisrRhl6eC_yH4I,5983
+afp/hashing.py,sha256=gBCWN93-ydRPlgnnorSvDQlylcnglrAypRDb-1K-20I,1949
+afp/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+afp/schemas.py,sha256=M6qr0GhCeT7KevzOso5dIhydYzaYx78Rs66IWdadJO8,5284
+afp/validators.py,sha256=zQvPu3HDu6ADnEE72EJlS5hc1-xfru78Mzd74s1u_EM,1841
+afp_sdk-0.5.1.dist-info/licenses/LICENSE,sha256=ZdaKItgc2ppfqta2OJV0oHpSJiK87PUxmUkUo-_0SB8,1065
+afp_sdk-0.5.1.dist-info/WHEEL,sha256=lh7MMMfiuFQLQaR9J7pNBODdWf-aa5UOeuuDAol3xps,79
+afp_sdk-0.5.1.dist-info/METADATA,sha256=RM6EyQq2W_ZlrkRtYcGf85pZg7S15poSNJq7CUEHz0w,6354
+afp_sdk-0.5.1.dist-info/RECORD,,

{afp_sdk-0.4.0.dist-info → afp_sdk-0.5.1.dist-info}/WHEEL

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

afp/.ruff_cache/.gitignore

@@ -1,2 +0,0 @@
-# Automatically created by ruff.
-*

afp/.ruff_cache/CACHEDIR.TAG

@@ -1 +0,0 @@
-Signature: 8a477f597d28d172789f06886806bc55

afp/api/liquidation.py

@@ -1,167 +0,0 @@
-from decimal import Decimal
-from functools import cache
-from typing import Iterable
-
-from hexbytes import HexBytes
-from web3 import Web3
-
-from .. import validators
-from ..bindings import (
-    BidData,
-    ClearingDiamond,
-    ProductRegistry,
-    Side as OnChainOrderSide,
-)
-from ..bindings.facade import CLEARING_DIAMOND_ABI
-from ..bindings.product_registry import ABI as PRODUCT_REGISTRY_ABI
-from ..decorators import convert_web3_error
-from ..enums import OrderSide
-from ..schemas import AuctionData, Bid
-from .base import ClearingSystemAPI
-
-
-class Liquidation(ClearingSystemAPI):
-    """API for participating in liquidation auctions.
-
-    Parameters
-    ----------
-    private_key : str
-        The private key of the blockchain account that participates in a liquidation
-        auction.
-    autonity_rpc_url : str
-        The URL of a JSON-RPC provider for Autonity. (HTTPS only.)
-    """
-
-    @staticmethod
-    def create_bid(product_id: str, price: Decimal, quantity: int, side: str) -> Bid:
-        """Create a bid to be submitted to a liquidation auction.
-
-        Parameters
-        ----------
-        product_id : str
-        price: Decimal
-        quantity: int
-        side: str
-
-        Returns
-        -------
-        afp.schemas.Bid
-        """
-        return Bid(
-            product_id=product_id,
-            price=price,
-            quantity=quantity,
-            side=getattr(OrderSide, side.upper()),
-        )
-
-    ### Transactions ###
-
-    @convert_web3_error(CLEARING_DIAMOND_ABI)
-    def request_liquidation(self, margin_account_id: str, collateral_asset: str) -> str:
-        """Request a liquidation auction to be started.
-
-        Parameters
-        ----------
-        margin_account_id : str
-            The ID of the margin account to be liquidated.
-        collateral_asset : str
-            The address of the collateral token that the margin account is trading with.
-
-        Returns
-        -------
-        str
-            The hash of the transaction.
-        """
-        margin_account_id = validators.validate_address(margin_account_id)
-        collateral_asset = validators.validate_address(collateral_asset)
-
-        clearing_contract = ClearingDiamond(self._w3)
-        tx_hash = clearing_contract.request_liquidation(
-            margin_account_id, collateral_asset
-        ).transact()
-        self._w3.eth.wait_for_transaction_receipt(tx_hash)
-        return Web3.to_hex(tx_hash)
-
-    @convert_web3_error(CLEARING_DIAMOND_ABI, PRODUCT_REGISTRY_ABI)
-    def submit_bids(
-        self, margin_account_id: str, collateral_asset: str, bids: Iterable[Bid]
-    ) -> str:
-        """Submit bids to a liquidation auction.
-
-        Parameters
-        ----------
-        margin_account_id : str
-            The ID of the margin account that is being liquidated.
-        collateral_asset : str
-            The address of the collateral token that the margin account is trading with.
-        bids: list of afp.schemas.Bid
-
-        Returns
-        -------
-        str
-            The hash of the transaction.
-        """
-        margin_account_id = validators.validate_address(margin_account_id)
-        collateral_asset = validators.validate_address(collateral_asset)
-
-        converted_bids = [
-            BidData(
-                product_id=HexBytes(bid.product_id),
-                price=int(bid.price * 10 ** self._tick_size(bid.product_id)),
-                quantity=bid.quantity,
-                side=getattr(OnChainOrderSide, bid.side.name),
-            )
-            for bid in bids
-        ]
-
-        clearing_contract = ClearingDiamond(self._w3)
-        tx_hash = clearing_contract.bid_auction(
-            margin_account_id, collateral_asset, converted_bids
-        ).transact()
-        self._w3.eth.wait_for_transaction_receipt(tx_hash)
-        return Web3.to_hex(tx_hash)
-
-    ### Views ###
-
-    @convert_web3_error(CLEARING_DIAMOND_ABI)
-    def auction_data(
-        self, margin_account_id: str, collateral_asset: str
-    ) -> AuctionData:
-        """Returns information on a liquidation auction.
-
-        Parameters
-        ----------
-        margin_account_id : str
-            The ID of the margin account to be liquidated.
-        collateral_asset : str
-            The address of the collateral token that the margin account is trading with.
-
-        Returns
-        -------
-        str
-            The hash of the transaction.
-        """
-        margin_account_id = validators.validate_address(margin_account_id)
-        collateral_asset = validators.validate_address(collateral_asset)
-
-        clearing_contract = ClearingDiamond(self._w3)
-        data = clearing_contract.auction_data(margin_account_id, collateral_asset)
-        divisor = 10 ** self._decimals(collateral_asset)
-        return AuctionData(
-            start_block=data.start_block,
-            margin_account_equity_at_initiation=(
-                Decimal(data.mae_at_initiation) / divisor
-            ),
-            maintenance_margin_used_at_initiation=(
-                Decimal(data.mmu_at_initiation) / divisor
-            ),
-            margin_account_equity_now=(Decimal(data.mae_now) / divisor),
-            maintenance_margin_used_now=(Decimal(data.mmu_now) / divisor),
-        )
-
-    ### Internal getters ###
-
-    @cache
-    def _tick_size(self, product_id: str) -> int:
-        product_registry_contract = ProductRegistry(self._w3)
-        return product_registry_contract.tick_size(HexBytes(product_id))