docs: 更新 lighter-python-main 文档，添加示例代码和 API 说明，重构部分内容以提高可读性

2026-09-10 00:38:07 +00:00 · 2025-09-30 18:35:14 +08:00
parent d6533733c9
commit e83bdfccf9
337 changed files with 50410 additions and 0 deletions
@@ -0,0 +1,70 @@
+import asyncio
+import logging
+import lighter
+
+logging.basicConfig(level=logging.DEBUG)
+
+# The API_KEY_PRIVATE_KEY provided belongs to a dummy account registered on Testnet.
+# It was generated using the setup_system.py script, and servers as an example.
+# Alternatively, you can go to https://app.lighter.xyz/apikeys for mainnet api keys
+BASE_URL = "https://testnet.zklighter.elliot.ai"
+API_KEY_PRIVATE_KEY = "0xed636277f3753b6c0275f7a28c2678a7f3a95655e09deaebec15179b50c5da7f903152e50f594f7b"
+ACCOUNT_INDEX = 65
+API_KEY_INDEX = 1
+
+
+def trim_exception(e: Exception) -> str:
+    return str(e).strip().split("\n")[-1]
+
+
+async def main():
+    api_client = lighter.ApiClient(configuration=lighter.Configuration(host=BASE_URL))
+
+    client = lighter.SignerClient(
+        url=BASE_URL,
+        private_key=API_KEY_PRIVATE_KEY,
+        account_index=ACCOUNT_INDEX,
+        api_key_index=API_KEY_INDEX,
+    )
+
+    err = client.check_client()
+    if err is not None:
+        print(f"CheckClient error: {trim_exception(err)}")
+        return
+
+    # create order
+    tx, tx_hash, err = await client.create_order(
+        market_index=0,
+        client_order_index=123,
+        base_amount=100000,
+        price=405000,
+        is_ask=True,
+        order_type=lighter.SignerClient.ORDER_TYPE_LIMIT,
+        time_in_force=lighter.SignerClient.ORDER_TIME_IN_FORCE_GOOD_TILL_TIME,
+        reduce_only=0,
+        trigger_price=0,
+    )
+    print(f"Create Order {tx=} {tx_hash=} {err=}")
+    if err is not None:
+        raise Exception(err)
+
+    auth, err = client.create_auth_token_with_expiry(lighter.SignerClient.DEFAULT_10_MIN_AUTH_EXPIRY)
+    print(f"{auth=}")
+    if err is not None:
+        raise Exception(err)
+
+    # cancel order
+    tx, tx_hash, err = await client.cancel_order(
+        market_index=0,
+        order_index=123,
+    )
+    print(f"Cancel Order {tx=} {tx_hash=} {err=}")
+    if err is not None:
+        raise Exception(err)
+
+    await client.close()
+    await api_client.close()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())