afp-sdk 0.1.0__py3-none-any.whl

afp_sdk-0.1.0.dist-info/METADATA

@@ -0,0 +1,180 @@
+Metadata-Version: 2.4
+Name: afp-sdk
+Version: 0.1.0
+Summary: Autonity Futures Protocol Python SDK
+Keywords: autonity,web3,trading,crypto,prediction,forecast,markets
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: decorator>=5.2.1
+Requires-Dist: inflection>=0.5.1
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: requests>=2.32.0
+Requires-Dist: siwe>=4.4.0
+Requires-Dist: web3>=7.6.0
+Requires-Python: >=3.11
+Project-URL: Changes, https://github.com/autonity/afp-sdk/blob/master/CHANGELOG.md
+Project-URL: Homepage, https://github.com/autonity/afp-sdk
+Project-URL: Issues, https://github.com/autonity/afp-sdk/issues
+Project-URL: Source, https://github.com/autonity/afp-sdk
+Description-Content-Type: text/markdown
+
+# Autonity Futures Protocol Python SDK
+
+## Installation
+
+This library is published on PyPI as the [afp-sdk](https://pypi.org/project/afp-sdk/)
+package. It can be installed in a virtualenv with:
+
+```py
+pip install afp-sdk
+```
+
+## Overview
+
+The `afp` package consists of the following:
+
+- `afp` top-level module: High-level API for interacting with the Clearing
+  System and the AutEx exchange.
+- `afp.bindings` submodule: Low-level API that provides typed Python bindings
+  for the Clearing System smart contracts.
+
+## Usage
+
+### Preparation
+
+In order to use 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.
+- 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.
+- The address of an Autonity RPC provider. They can be found on
+  [Chainlist](https://chainlist.org/?search=autonity&testnets=true).
+
+We can store those in the following constants (using random example IDs):
+
+```py
+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"]
+AUTONITY_RPC_URL = "https://bakerloo.autonity-apis.com"
+```
+
+Account IDs (addresses) may be retrieved from the private keys with `eth_account`:
+
+```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
+```
+
+### Clearing API
+
+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.
+
+```py
+import afp
+
+clearing = afp.Clearing(MARGIN_ACCOUNT_PRIVATE_KEY, AUTONITY_RPC_URL)
+```
+
+Collateral can be deposited into the margin account with
+`clearing.deposit_into_margin_account()`.
+
+```py
+from decimal import Decimal
+
+clearing.deposit_into_margin_account(COLLATERAL_ASSET, Decimal("100.00"))
+print(clearing.capital(COLLATERAL_ASSET))
+```
+
+The intent account should be authorized to submit orders. This is only required
+if the intent account and the margin account are different.
+
+```py
+clearing.authorize(COLLATERAL_ASSET, INTENT_ACCOUNT_ID)
+```
+
+### 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.
+
+```py
+trading = afp.Trading(INTENT_ACCOUNT_PRIVATE_KEY)
+```
+
+To start trading a product, its parameters shall be retrieved from the server.
+
+```py
+product = trading.product(PRODUCT_ID)
+```
+
+Intents can be created with `trading.create_intent()`. Intent creation involves
+hashing and signing the intent data. (The intent account's address is derived
+from the private key specified in the `Trading` constructor.)
+
+```py
+from datetime import datetime, timedelta
+from decimal import Decimal
+
+intent = trading.create_intent(
+    margin_account_id=MARGIN_ACCOUNT_ID,
+    product=product,
+    side="bid",
+    limit_price=Decimal("1.23"),
+    quantity=2,
+    max_trading_fee_rate=Decimal("0.1"),
+    good_until_time=datetime.now() + timedelta(hours=1),
+)
+```
+
+The intent expressing a limit order can then be submitted to the exchange with
+`trading.submit_limit_order()` that returns the created order object.
+
+```py
+order = trading.submit_limit_order(intent)
+print(order)
+```
+
+The exchange then performs various checks to ensure that the order is valid. To
+ensure that the order has been accepted, its state can be polled with
+`trading.order()`.
+
+```py
+order = trading.order(order.id)
+print(order.state)
+```
+
+Fills of orders submitted by the authenticated intent account can be queried
+with `trading.order_fills()`.
+
+```py
+fills = trading.order_fills(product_id=PRODUCT_ID)
+print(fills)
+```
+
+See further code examples in the [examples](./examples/) directory.
+
+## 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.

afp_sdk-0.1.0.dist-info/RECORD

@@ -0,0 +1,34 @@
+afp/__init__.py,sha256=4C2JZIu-rWZpMnp_rcVjJPI4v_R9GT1ISnlwoawhBjs,323
+afp/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+afp/api/admin.py,sha256=7ymtCloff4UhyS-MAqA8_cndWlfZanjuGgPgkiV5Jhc,1526
+afp/api/base.py,sha256=iS-sjAc9mME2qOMEvnB6T6x9L_8oeJnHY6h79xrbAOE,2632
+afp/api/builder.py,sha256=4Kmulk2f4QAblLgmI0J6YYt-WuBoLSw3l2jY3Q6tNN8,7078
+afp/api/clearing.py,sha256=nMVjayFkf0XYYP3aKAdgR6NaFSG4Cl_QsEuADRuIO7M,12922
+afp/api/liquidation.py,sha256=CtME5524VVW9mXMMpORyUP205sTVqpLnHIPoTy2MGa8,5439
+afp/api/trading.py,sha256=0nD3JnnQwmmFeZYRws1V4rfWCuxgwnY7O5uF-NZ3Mtc,9917
+afp/bindings/__init__.py,sha256=ZkjAhZlasky0fZITtQp_xlgcO5H-8ZnyVWUQh5AZLpE,1153
+afp/bindings/auctioneer_facet.py,sha256=99FmK35trfOIJGqJqyc1NnpG0KavhH0_jNufszZ9VhA,24013
+afp/bindings/bankruptcy_facet.py,sha256=BufV6eE592aCqtTduDD7mHcLp_yuQWNI9d5HFvSTTSc,11344
+afp/bindings/clearing_facet.py,sha256=GLBtquybV1FRvDNlYXgpcvlpgw9pvZ5UJbLOYKayPMU,34168
+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/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/trading_protocol.py,sha256=XN9UbViMhVLIzFCTTgEW65GRF0finTjq-2iHrhtL3P8,39873
+afp/config.py,sha256=3S7k49n4ZaRko3FX6Hw95r5L-sw2XiAjWtqYiX3Omx0,1017
+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/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+afp/schemas.py,sha256=RQ-NkDOgFnoJXHIngiqAJCX88gu5qlkMu6lxnvVyYfI,4899
+afp/signing.py,sha256=7fohnAvoiDA4ems_3OcVnr16OmYLSg9NnnCSzDplg6s,2235
+afp/validators.py,sha256=zhOP0vYS2aXMKLsIVDwD6xwwCg0moIU5IhMlNHihWkM,1329
+afp_sdk-0.1.0.dist-info/licenses/LICENSE,sha256=ZdaKItgc2ppfqta2OJV0oHpSJiK87PUxmUkUo-_0SB8,1065
+afp_sdk-0.1.0.dist-info/WHEEL,sha256=4n27za1eEkOnA7dNjN6C5-O2rUiw6iapszm14Uj-Qmk,79
+afp_sdk-0.1.0.dist-info/METADATA,sha256=DFOCUhdg3ieK_6-bPwUKb48Jg6Cm1s-9oa528Hpck6c,5614
+afp_sdk-0.1.0.dist-info/RECORD,,

afp_sdk-0.1.0.dist-info/WHEEL

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

afp_sdk-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Autonity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.