afp-sdk 0.3.0__tar.gz → 0.5.0__tar.gz

afp_sdk-0.5.0/CHANGELOG.md

@@ -0,0 +1,28 @@
+## [v0.5.0] - 2025-09-18
+
+### Added
+
+- Add key file authentication. ([#22](https://github.com/autonity/afp-sdk/pull/22))
+
+### Changed
+
+- Complete rework of the API and configuration management with breaking non backwards compatible changes. See the API reference. ([#22](https://github.com/autonity/afp-sdk/pull/22))
+
+## [v0.4.0] - 2025-09-17
+
+### Added
+
+- Add `product_id` argument to `Trading.open_orders()` for filtering orders by product ([#21](https://github.com/autonity/afp-sdk/pull/21))
+- Add new contract events to contract bindings ([#21](https://github.com/autonity/afp-sdk/pull/21))
+
+### Removed
+
+- Remove the `offer_price_buffer` product parameter from `Builder.create_product()` ([#23](https://github.com/autonity/afp-sdk/pull/23))
+
+## [v0.3.0] - 2025-09-05
+
+_First public release for Forecastathon._
+
+[v0.5.0]: https://github.com/autonity/afp-sdk/releases/tag/v0.5.0
+[v0.4.0]: https://github.com/autonity/afp-sdk/releases/tag/v0.4.0
+[v0.3.0]: https://github.com/autonity/afp-sdk/releases/tag/v0.3.0

{afp_sdk-0.3.0 → afp_sdk-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: afp-sdk
-Version: 0.3.0
+Version: 0.5.0
 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.3.0 → afp_sdk-0.5.0}/README.md

@@ -1,5 +1,9 @@
 # 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/)
@@ -9,6 +13,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:
@@ -18,6 +27,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
@@ -28,7 +44,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).
 
@@ -39,57 +56,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.
@@ -144,28 +164,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.0/afp/__init__.py

@@ -0,0 +1,15 @@
+"""Autonomous Futures Protocol Python SDK."""
+
+from . import bindings
+from .afp import AFP
+from .auth import Authenticator, KeyfileAuthenticator, PrivateKeyAuthenticator
+from .exceptions import AFPException
+
+__all__ = (
+    "bindings",
+    "AFP",
+    "AFPException",
+    "Authenticator",
+    "KeyfileAuthenticator",
+    "PrivateKeyAuthenticator",
+)

afp_sdk-0.5.0/afp/afp.py

@@ -0,0 +1,210 @@
+from .auth import Authenticator, KeyfileAuthenticator, PrivateKeyAuthenticator
+from .config import Config
+from .api.admin import Admin
+from .api.margin_account import MarginAccount
+from .api.product import Product
+from .api.trading import Trading
+from .constants import defaults
+from .exceptions import ConfigurationError
+from .validators import validate_address
+
+
+class AFP:
+    """Application object for interacting with the AFP Clearing System and the AutEx
+    exchange.
+
+    Parameters
+    ----------
+    authenticator : afp.Authenticator, optional
+        The default authenticator for signing transactions & messages. Can also be set
+        with environment variables; use `AFP_PRIVATE_KEY` for private key
+        authentication, `AFP_KEYFILE` and `AFP_KEYFILE_PASSWORD` for keyfile
+        authentication.
+    rpc_url : str, optional
+        The URL of an Autonity RPC provider. Can also be set with the `AFP_RPC_URL`
+        environment variable.
+    exchange_url : str, optional
+        The REST API base URL of the exchange. Defaults to the URL of the AutEx
+        exchange. Its default value can be overridden with the `AFP_EXCHANGE_URL`
+        environment variable.
+    chain_id : str, optional
+        The chain ID of the Autonity network. Defauls to the chain ID of Autonity
+        Mainnet. Its default value can be overridden with the `AFP_CHAIN_ID` environment
+        variable.
+    gas_limit : int, optional
+        The `gasLimit` parameter of blockchain transactions. Estimated with the
+        `eth_estimateGas` JSON-RPC call if not specified. Its default value can be
+        overridden with the `AFP_GAS_LIMIT` environment variable.
+    max_fee_per_gas : int, optional
+        The `maxFeePerGas` parameter of blockchain transactions in ton (wei) units.
+        Defaults to `baseFeePerGas` from the return value of the `eth_getBlock` JSON-RPC
+        call. Its default value can be overridden with the `AFP_MAX_FEE_PER_GAS`
+        environment variable.
+    max_priority_fee_per_gas : int, optional
+        The `maxPriorityFeePerGas` parameter of blockchain transactions in ton (wei)
+        units. Defaults to the return value of the `eth_maxPriorityFeePerGas` JSON-RPC
+        call. Its default value can be overridden with the
+        `AFP_MAX_PRIORITY_FEE_PER_GAS` environment variable.
+    timeout_seconds: int, optional
+        The number of seconds to wait for a blockchain transaction to be mined.
+        Defaults to 10 seconds. Its default value can be overridden with the
+        `AFP_TIMEOUT_SECONDS` environment variable.
+    clearing_diamond_address : str, optional
+        The address of the ClearingDiamond contract. Defaults to the Autonity Mainnet
+        deployment address. Its default value can be overridden with the
+        `AFP_CLEARING_DIAMOND_ADDRESS` environment variable.
+    margin_account_registry_address : str, optional
+        The address of the MarginAccountRegistry contract. Defaults to the Autonity
+        Mainnet deployment address. Its default value can be overridden with the
+        `AFP_MARGIN_ACCOUNT_REGISTRY_ADDRESS` environment variable.
+    oracle_provider_address : str, optional
+        The address of the OracleProvider contract. Defaults to the Autonity Mainnet
+        deployment address. Its default value can be overridden with the
+        `AFP_ORACLE_PROVIDER_ADDRESS` environment variable.
+    product_registry_address: str, optional
+        The address of the ProductRegistry contract. Defaults to the Autonity Mainnet
+        deployment address. Its default value can be overridden with the
+        `AFP_PRODUCT_REGISTRY_ADDRESS` environment variable.
+    system_viewer_address: str, optional
+        The address of the SystemViewer contract. Defaults to the Autonity Mainnet
+        deployment address. Its default value can be overridden with the
+        `AFP_SYSTEM_VIEWER_ADDRESS` environment variable.
+    """
+
+    config: Config
+
+    def __init__(
+        self,
+        *,
+        authenticator: Authenticator | None = None,
+        rpc_url: str | None = defaults.RPC_URL,
+        exchange_url: str = defaults.EXCHANGE_URL,
+        chain_id: int = defaults.CHAIN_ID,
+        gas_limit: int | None = defaults.GAS_LIMIT,
+        max_fee_per_gas: int | None = defaults.MAX_FEE_PER_GAS,
+        max_priority_fee_per_gas: int | None = defaults.MAX_PRIORITY_FEE_PER_GAS,
+        timeout_seconds: int = defaults.TIMEOUT_SECONDS,
+        clearing_diamond_address: str = defaults.CLEARING_DIAMOND_ADDRESS,
+        margin_account_registry_address: str = defaults.MARGIN_ACCOUNT_REGISTRY_ADDRESS,
+        oracle_provider_address: str = defaults.ORACLE_PROVIDER_ADDRESS,
+        product_registry_address: str = defaults.PRODUCT_REGISTRY_ADDRESS,
+        system_viewer_address: str = defaults.SYSTEM_VIEWER_ADDRESS,
+    ) -> None:
+        if authenticator is None:
+            authenticator = _default_authenticator()
+
+        self.config = Config(
+            authenticator=authenticator,
+            exchange_url=exchange_url,
+            rpc_url=rpc_url,
+            chain_id=chain_id,
+            gas_limit=gas_limit,
+            max_fee_per_gas=max_fee_per_gas,
+            max_priority_fee_per_gas=max_priority_fee_per_gas,
+            timeout_seconds=timeout_seconds,
+            clearing_diamond_address=validate_address(clearing_diamond_address),
+            margin_account_registry_address=validate_address(
+                margin_account_registry_address
+            ),
+            oracle_provider_address=validate_address(oracle_provider_address),
+            product_registry_address=validate_address(product_registry_address),
+            system_viewer_address=validate_address(system_viewer_address),
+        )
+
+    def __repr__(self) -> str:
+        return f"AFP(config={repr(self.config)})"
+
+    # Clearing APIs
+
+    def MarginAccount(
+        self, authenticator: Authenticator | None = None
+    ) -> MarginAccount:
+        """API for managing margin accounts.
+
+        Parameters
+        ----------
+        authenticator : afp.Authenticator, optional
+            Authenticator for signing transactions sent to the Clearing System.
+            Defaults to the authenticator specified in the `AFP` constructor.
+        """
+        return MarginAccount(self.config, authenticator=authenticator)
+
+    def Product(self, authenticator: Authenticator | None = None) -> Product:
+        """API for managing products.
+
+        Parameters
+        ----------
+        authenticator : afp.Authenticator, optional
+            Authenticator for signing transactions sent to the Clearing System.
+            Defaults to the authenticator specified in the `AFP` constructor.
+        """
+        return Product(self.config, authenticator=authenticator)
+
+    # Exchange APIs
+
+    def Admin(
+        self,
+        authenticator: Authenticator | None = None,
+        exchange_url: str | None = None,
+    ) -> Admin:
+        """API for AutEx administration, restricted to AutEx admins.
+
+        Authenticates with the exchange on creation.
+
+        Parameters
+        ----------
+        authenticator : afp.Authenticator, optional
+            Authenticator for authenticating with the AutEx exchange. Defaults to the
+            authenticator specified in the `AFP` constructor.
+        exchange_url: str, optional
+            The REST API base URL of the exchange. Defaults to the value specified in
+            the `AFP` constructor.
+
+        Raises
+        ------
+        afp.exceptions.AuthenticationError
+            If the exchange rejects the login attempt.
+        """
+        return Admin(
+            self.config, authenticator=authenticator, exchange_url=exchange_url
+        )
+
+    def Trading(
+        self,
+        authenticator: Authenticator | None = None,
+        exchange_url: str | None = None,
+    ) -> Trading:
+        """API for trading in the AutEx exchange.
+
+        Authenticates with the exchange on creation.
+
+        Parameters
+        ----------
+        authenticator : afp.Authenticator, optional
+            Authenticator for signing intents and authenticating with the AutEx
+            exchange. Defaults to the authenticator specified in the `AFP` constructor.
+        exchange_url: str, optional
+            The REST API base URL of the exchange. Defaults to the value specified in
+            the `AFP` constructor.
+
+        Raises
+        ------
+        afp.exceptions.AuthenticationError
+            If the exchange rejects the login attempt.
+        """
+        return Trading(
+            self.config, authenticator=authenticator, exchange_url=exchange_url
+        )
+
+
+def _default_authenticator() -> Authenticator | None:
+    if defaults.PRIVATE_KEY is not None and defaults.KEYFILE is not None:
+        raise ConfigurationError(
+            "Only one of AFP_PRIVATE_KEY and AFP_KEYFILE environment "
+            "variables should be specified"
+        )
+    if defaults.PRIVATE_KEY is not None:
+        return PrivateKeyAuthenticator(defaults.PRIVATE_KEY)
+    if defaults.KEYFILE is not None:
+        return KeyfileAuthenticator(defaults.KEYFILE, defaults.KEYFILE_PASSWORD)
+    return None

{afp_sdk-0.3.0 → afp_sdk-0.5.0}/afp/api/admin.py

@@ -5,20 +5,7 @@ from .base import ExchangeAPI
 
 
 class Admin(ExchangeAPI):
-    """API for AutEx administration, restricted to AutEx admins.
-
-    Authenticates with the exchange on creation.
-
-    Parameters
-    ----------
-    private_key : str
-        The private key of the exchange adminstrator account.
-
-    Raises
-    ------
-    afp.exceptions.AuthenticationError
-        If the exchange rejects the login attempt.
-    """
+    """API for AutEx administration, restricted to AutEx admins."""
 
     @refresh_token_on_expiry
     def approve_product(self, product_id: str) -> None: