typed-aster 0.1.0__py3-none-any.whl

typed_aster/__init__.py

@@ -0,0 +1,14 @@
+"""A fully typed, validated async client for the Aster API.
+
+Examples:
+  ```python
+  from typed_aster import Aster
+
+  async with Aster.new(public=True) as client:
+    server_time = await client.futures.market.time()
+  ```
+"""
+
+import lazy_loader as lazy
+
+__getattr__, __dir__, __all__ = lazy.attach_stub(__name__, __file__)

typed_aster/__init__.pyi

@@ -0,0 +1,23 @@
+from .main import Aster
+from .core import (
+  Error,
+  NetworkError,
+  ValidationError,
+  ApiError,
+  BadRequest,
+  AuthError,
+  RateLimited,
+  LogicError,
+)
+
+__all__ = [
+  'Aster',
+  'Error',
+  'NetworkError',
+  'ValidationError',
+  'ApiError',
+  'BadRequest',
+  'AuthError',
+  'RateLimited',
+  'LogicError',
+]

typed_aster/chain/__init__.py

@@ -0,0 +1,71 @@
+# Generated by typed-dev — see CONTRIBUTING.md.
+from functools import cached_property
+from .account import Account
+from .perp import Perp
+from .rpc import ChainRpc
+from .spot import Spot
+from .staking import Staking
+from .wallet import Wallet
+from typed_aster.core.base import ChainBase
+
+
+class Chain(ChainBase):
+  """Aster Chain: REST (account privacy, staking, deposits, withdrawals and transfers) and the read-only JSON-RPC. Mainnet only.
+
+  References:
+    - [Upstream docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/)
+  """
+
+  @cached_property
+  def account(self) -> Account:
+    """Aster Chain account: privacy mode (PUBLIC/PRIVATE) and transfers to another Aster Chain address.
+
+    References:
+      - [Upstream docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/#aster-chain-account-endpoints)
+    """
+    return Account(client=self.client)
+
+  @cached_property
+  def perp(self) -> Perp:
+    """Aster Chain perp account: withdrawals (EVM and Solana), withdraw limits, deposit/withdraw history and spot/perp transfers.
+
+    References:
+      - [Upstream docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/#aster-chain-perp-withdraw-transfer-endpoints)
+    """
+    return Perp(client=self.client)
+
+  @cached_property
+  def rpc(self) -> ChainRpc:
+    """Aster Chain read-only JSON-RPC 2.0 (`POST /info`): balances, positions, staking summary, open orders and fills of any address, honouring account privacy mode.
+
+    References:
+      - [Upstream docs](https://asterdex.github.io/aster-api-website/rpc/endpoints/)
+    """
+    return ChainRpc(client=self.rpc_client)
+
+  @cached_property
+  def spot(self) -> Spot:
+    """Aster Chain spot account: withdrawals (EVM and Solana), spot/perp transfers and the SUI deposit address.
+
+    References:
+      - [Upstream docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/#aster-chain-spot-withdraw-transfer-endpoints)
+    """
+    return Spot(client=self.client)
+
+  @cached_property
+  def staking(self) -> Staking:
+    """ASTER staking on Aster Chain: staking position reads, stake/add/extend/claim actions and the network-wide locked total.
+
+    References:
+      - [Upstream docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/#aster-chain-staking-endpoints)
+    """
+    return Staking(client=self.client)
+
+  @cached_property
+  def wallet(self) -> Wallet:
+    """Aster Chain withdrawal helpers: public withdrawal fee estimates.
+
+    References:
+      - [Upstream docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/#aster-chain-withdraw-endpoints)
+    """
+    return Wallet(client=self.client)

typed_aster/chain/account/__init__.py

@@ -0,0 +1,12 @@
+# Generated by typed-dev — see CONTRIBUTING.md.
+from .modify_status import ModifyStatus
+from .status import Status
+from .transfer import Transfer
+
+
+class Account(ModifyStatus, Status, Transfer):
+  """Aster Chain account: privacy mode (PUBLIC/PRIVATE) and transfers to another Aster Chain address.
+
+  References:
+    - [Upstream docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/#aster-chain-account-endpoints)
+  """

typed_aster/chain/account/modify_status.py

@@ -0,0 +1,44 @@
+# Generated by typed-dev — see CONTRIBUTING.md.
+from typing_extensions import Literal, TypedDict
+from typed_aster.core.endpoint.rpc import RpcEndpoint
+
+
+class AccountPrivacyStatus(TypedDict):
+  """Account privacy mode after the change."""
+
+  status: Literal['PUBLIC', 'PRIVATE']
+  """Account privacy mode."""
+
+
+class Request(TypedDict):
+  status: Literal['PUBLIC', 'PRIVATE']
+  """New privacy mode: `PUBLIC` or `PRIVATE`."""
+
+
+class ModifyStatus(RpcEndpoint):
+  """Set the account's privacy mode. The change is broadcast to Aster Chain."""
+
+  async def modify_status(
+    self,
+    status: Literal['PUBLIC', 'PRIVATE'],
+    *,
+    validate: bool | None = None,
+  ) -> AccountPrivacyStatus:
+    """Set the account's privacy mode. The change is broadcast to Aster Chain.
+
+    Args:
+      status: New privacy mode: `PUBLIC` or `PRIVATE`.
+      validate: Override this call's response validation; falls back to the client-level default when omitted.
+
+    References:
+      - [Official docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/#modify-account-status-trade)
+    """
+    return await self.request(
+      Request(status=status),
+      method='POST',
+      path='account/modify-status',
+      meta={},
+      validate=validate,
+      request_type=Request,
+      response_type=AccountPrivacyStatus,
+    )

typed_aster/chain/account/status.py

@@ -0,0 +1,36 @@
+# Generated by typed-dev — see CONTRIBUTING.md.
+from typing_extensions import Literal, TypedDict
+from typed_aster.core.endpoint.rpc import RpcEndpoint
+
+
+class AccountPrivacyStatus(TypedDict):
+  """Account privacy mode."""
+
+  status: Literal['PUBLIC', 'PRIVATE']
+  """Account privacy mode."""
+
+
+class Request(TypedDict): ...
+
+
+class Status(RpcEndpoint):
+  """Get the account's privacy mode."""
+
+  async def status(self, *, validate: bool | None = None) -> AccountPrivacyStatus:
+    """Get the account's privacy mode.
+
+    Args:
+      validate: Override this call's response validation; falls back to the client-level default when omitted.
+
+    References:
+      - [Official docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/#get-account-status-user_data)
+    """
+    return await self.request(
+      Request(),
+      method='GET',
+      path='account/status',
+      meta={},
+      validate=validate,
+      request_type=Request,
+      response_type=AccountPrivacyStatus,
+    )

typed_aster/chain/account/transfer.py

@@ -0,0 +1,74 @@
+# Generated by typed-dev — see CONTRIBUTING.md.
+from decimal import Decimal
+from typing_extensions import Literal, NotRequired, TypedDict
+from typed_aster.core import TimestampMillis
+from typed_aster.core.endpoint.rpc import RpcEndpoint
+
+
+class ChainTransfer(TypedDict):
+  """Accepted transfer."""
+
+  transferId: NotRequired[str]
+  """Transfer id."""
+  asset: NotRequired[str]
+  """Asset name."""
+  amount: NotRequired[Decimal]
+  """Transferred amount."""
+  toAddress: NotRequired[str]
+  """Recipient address."""
+  timestamp: NotRequired[TimestampMillis]
+  """Transfer time."""
+  status: NotRequired[Literal['SUCCESS', 'PENDING']]
+  """Transfer status."""
+
+
+class Request(TypedDict):
+  asset: str
+  """Asset name, e.g. `USDT`."""
+  amount: Decimal
+  """Transfer amount, greater than 0."""
+  toAddress: str
+  """Recipient's Aster Chain wallet address."""
+  clientTranId: NotRequired[str]
+  """Client-defined transfer id; generated by Aster when omitted."""
+
+
+class Transfer(RpcEndpoint):
+  """Transfer an asset to another Aster Chain address. The recipient must be a registered Aster Chain user."""
+
+  async def transfer(
+    self,
+    *,
+    asset: str,
+    amount: Decimal,
+    to_address: str,
+    client_tran_id: str | None = None,
+    validate: bool | None = None,
+  ) -> ChainTransfer:
+    """Transfer an asset to another Aster Chain address. The recipient must be a registered Aster Chain user.
+
+    Args:
+      asset: Asset name, e.g. `USDT`.
+      amount: Transfer amount, greater than 0.
+      to_address: Recipient's Aster Chain wallet address.
+      client_tran_id: Client-defined transfer id; generated by Aster when omitted.
+      validate: Override this call's response validation; falls back to the client-level default when omitted.
+
+    References:
+      - [Official docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/#transfer-to-address-withdraw)
+    """
+    request: Request = Request(asset=asset, amount=amount, toAddress=to_address)
+    if client_tran_id is not None:
+      request['clientTranId'] = client_tran_id
+    return await self.request(
+      request,
+      method='POST',
+      path='transfer',
+      meta={
+        'sign': 'main',
+        'order': ['asset', 'amount', 'toAddress', 'clientTranId', 'nonce', 'user'],
+      },
+      validate=validate,
+      request_type=Request,
+      response_type=ChainTransfer,
+    )

typed_aster/chain/perp/__init__.py

@@ -0,0 +1,16 @@
+# Generated by typed-dev — see CONTRIBUTING.md.
+from .deposit_withdraw_history import DepositWithdrawHistory
+from .solana_withdraw import SolanaWithdraw
+from .transfer import Transfer
+from .withdraw import Withdraw
+from .withdraw_info import WithdrawInfoEndpoint
+
+
+class Perp(
+  DepositWithdrawHistory, SolanaWithdraw, Transfer, Withdraw, WithdrawInfoEndpoint
+):
+  """Aster Chain perp account: withdrawals (EVM and Solana), withdraw limits, deposit/withdraw history and spot/perp transfers.
+
+  References:
+    - [Upstream docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/#aster-chain-perp-withdraw-transfer-endpoints)
+  """

typed_aster/chain/perp/deposit_withdraw_history.py

@@ -0,0 +1,68 @@
+# Generated by typed-dev — see CONTRIBUTING.md.
+from decimal import Decimal
+from typing_extensions import Literal, NotRequired, TypedDict
+from typed_aster.core import TimestampMillis
+from typed_aster.core.endpoint.rpc import RpcEndpoint
+
+
+class ChainDepositWithdrawal(TypedDict):
+  """One deposit or withdrawal."""
+
+  id: NotRequired[str]
+  """Record id."""
+  type: NotRequired[Literal['DEPOSIT', 'WITHDRAW']]
+  """Record type."""
+  asset: NotRequired[str]
+  """Asset name."""
+  amount: NotRequired[Decimal]
+  """Amount."""
+  state: NotRequired[str]
+  """Record state, e.g. `COMPLETED`."""
+  txHash: NotRequired[str]
+  """On-chain transaction hash."""
+  time: NotRequired[TimestampMillis]
+  """Record time."""
+  chainId: NotRequired[int]
+  """Chain id."""
+  accountType: NotRequired[str]
+  """Account type, e.g. `perp`."""
+
+
+class Request(TypedDict):
+  chainId: NotRequired[str]
+  """Filter by chain id (sent as a string)."""
+
+
+Response = list[ChainDepositWithdrawal]
+
+
+class DepositWithdrawHistory(RpcEndpoint):
+  """Get the deposit and withdrawal history of the user's perp account."""
+
+  async def deposit_withdraw_history(
+    self,
+    chain_id: str | None = None,
+    *,
+    validate: bool | None = None,
+  ) -> Response:
+    """Get the deposit and withdrawal history of the user's perp account.
+
+    Args:
+      chain_id: Filter by chain id (sent as a string).
+      validate: Override this call's response validation; falls back to the client-level default when omitted.
+
+    References:
+      - [Official docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/#depositwithdraw-history-user_data)
+    """
+    request: Request = Request()
+    if chain_id is not None:
+      request['chainId'] = chain_id
+    return await self.request(
+      request,
+      method='GET',
+      path='perp/deposit-withdraw-history',
+      meta={},
+      validate=validate,
+      request_type=Request,
+      response_type=Response,
+    )

typed_aster/chain/perp/solana_withdraw.py

@@ -0,0 +1,55 @@
+# Generated by typed-dev — see CONTRIBUTING.md.
+from decimal import Decimal
+from typing_extensions import TypedDict
+from typed_aster.core.endpoint.rpc import RpcEndpoint
+from typed_aster.schemas import Withdrawal
+
+
+class Request(TypedDict):
+  asset: str
+  """Asset name, e.g. `USDT`."""
+  chainId: int
+  """Target chain id (`101`, Solana)."""
+  amount: Decimal
+  """Withdrawal amount."""
+  fee: Decimal
+  """Withdrawal fee (see `wallet.estimate_withdraw_fee`)."""
+  receiver: str
+  """Recipient Solana address."""
+
+
+class SolanaWithdraw(RpcEndpoint):
+  """Withdraw from the perp account to a Solana address."""
+
+  async def solana_withdraw(
+    self,
+    *,
+    asset: str,
+    chain_id: int,
+    amount: Decimal,
+    fee: Decimal,
+    receiver: str,
+    validate: bool | None = None,
+  ) -> Withdrawal:
+    """Withdraw from the perp account to a Solana address.
+
+    Args:
+      asset: Asset name, e.g. `USDT`.
+      chain_id: Target chain id (`101`, Solana).
+      amount: Withdrawal amount.
+      fee: Withdrawal fee (see `wallet.estimate_withdraw_fee`).
+      receiver: Recipient Solana address.
+      validate: Override this call's response validation; falls back to the client-level default when omitted.
+
+    References:
+      - [Official docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/#user-solana-withdraw-withdraw)
+    """
+    return await self.request(
+      Request(asset=asset, chainId=chain_id, amount=amount, fee=fee, receiver=receiver),
+      method='POST',
+      path='perp/user-solana-withdraw',
+      meta={},
+      validate=validate,
+      request_type=Request,
+      response_type=Withdrawal,
+    )

typed_aster/chain/perp/transfer.py

@@ -0,0 +1,56 @@
+# Generated by typed-dev — see CONTRIBUTING.md.
+from decimal import Decimal
+from typing_extensions import Literal, TypedDict
+from typed_aster.core.endpoint.rpc import RpcEndpoint
+from typed_aster.schemas import TransferResult
+
+
+class Request(TypedDict):
+  asset: str
+  """Asset name, e.g. `USDT`."""
+  amount: Decimal
+  """Transfer amount, greater than 0."""
+  clientTranId: str
+  """Client-defined transfer id."""
+  kindType: Literal['SPOT_FUTURE', 'FUTURE_SPOT']
+  """Direction: `SPOT_FUTURE` (spot to perp) or `FUTURE_SPOT` (perp to spot)."""
+
+
+class Transfer(RpcEndpoint):
+  """Transfer an asset between the spot wallet and the perp account."""
+
+  async def transfer(
+    self,
+    *,
+    asset: str,
+    amount: Decimal,
+    client_tran_id: str,
+    kind_type: Literal['SPOT_FUTURE', 'FUTURE_SPOT'],
+    validate: bool | None = None,
+  ) -> TransferResult:
+    """Transfer an asset between the spot wallet and the perp account.
+
+    Args:
+      asset: Asset name, e.g. `USDT`.
+      amount: Transfer amount, greater than 0.
+      client_tran_id: Client-defined transfer id.
+      kind_type: Direction: `SPOT_FUTURE` (spot to perp) or `FUTURE_SPOT` (perp to spot).
+      validate: Override this call's response validation; falls back to the client-level default when omitted.
+
+    References:
+      - [Official docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/#wallet-transfer-trade)
+    """
+    return await self.request(
+      Request(
+        asset=asset, amount=amount, clientTranId=client_tran_id, kindType=kind_type
+      ),
+      method='POST',
+      path='perp/wallet/transfer',
+      meta={
+        'sign': 'main',
+        'order': ['asset', 'amount', 'clientTranId', 'kindType', 'nonce', 'user'],
+      },
+      validate=validate,
+      request_type=Request,
+      response_type=TransferResult,
+    )

typed_aster/chain/perp/withdraw.py

@@ -0,0 +1,64 @@
+# Generated by typed-dev — see CONTRIBUTING.md.
+from decimal import Decimal
+from typing_extensions import Literal, NotRequired, TypedDict
+from typed_aster.core.endpoint.rpc import RpcEndpoint
+from typed_aster.schemas import Withdrawal
+
+
+class Request(TypedDict):
+  asset: str
+  """Asset name, e.g. `USDT`."""
+  chainId: int
+  """Target chain id, e.g. `1` (ETH), `56` (BSC), `42161` (Arbitrum)."""
+  amount: Decimal
+  """Withdrawal amount."""
+  fee: Decimal
+  """Withdrawal fee (see `wallet.estimate_withdraw_fee`)."""
+  receiver: str
+  """Recipient on-chain address."""
+  signatureType: NotRequired[Literal['EOA', 'SafeWallet']]
+  """Signature type; `SafeWallet` for a Safe wallet account, which may send several comma-separated signatures. Default `EOA`."""
+
+
+class Withdraw(RpcEndpoint):
+  """Withdraw from the perp account to an EVM address. The main wallet signs the EIP-712 withdraw `Action` (`userNonce`, `userSignature`); the call itself is agent-signed."""
+
+  async def withdraw(
+    self,
+    *,
+    asset: str,
+    chain_id: int,
+    amount: Decimal,
+    fee: Decimal,
+    receiver: str,
+    signature_type: Literal['EOA', 'SafeWallet'] | None = None,
+    validate: bool | None = None,
+  ) -> Withdrawal:
+    """Withdraw from the perp account to an EVM address. The main wallet signs the EIP-712 withdraw `Action` (`userNonce`, `userSignature`); the call itself is agent-signed.
+
+    Args:
+      asset: Asset name, e.g. `USDT`.
+      chain_id: Target chain id, e.g. `1` (ETH), `56` (BSC), `42161` (Arbitrum).
+      amount: Withdrawal amount.
+      fee: Withdrawal fee (see `wallet.estimate_withdraw_fee`).
+      receiver: Recipient on-chain address.
+      signature_type: Signature type; `SafeWallet` for a Safe wallet account, which may send several comma-separated signatures. Default `EOA`.
+      validate: Override this call's response validation; falls back to the client-level default when omitted.
+
+    References:
+      - [Official docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/#user-withdraw-withdraw)
+    """
+    request: Request = Request(
+      asset=asset, chainId=chain_id, amount=amount, fee=fee, receiver=receiver
+    )
+    if signature_type is not None:
+      request['signatureType'] = signature_type
+    return await self.request(
+      request,
+      method='POST',
+      path='perp/user-withdraw',
+      meta={'sign': 'withdraw'},
+      validate=validate,
+      request_type=Request,
+      response_type=Withdrawal,
+    )

typed_aster/chain/perp/withdraw_info.py

@@ -0,0 +1,75 @@
+# Generated by typed-dev — see CONTRIBUTING.md.
+from decimal import Decimal
+from typing_extensions import NotRequired, TypedDict
+from typed_aster.core.endpoint.rpc import RpcEndpoint
+
+
+class ChainWithdrawLimit(TypedDict):
+  """Withdraw limits of one asset on one chain."""
+
+  chainId: NotRequired[int]
+  """Chain id."""
+  spotMaxWithdrawAmount: NotRequired[Decimal]
+  """Maximum withdrawable from the spot account."""
+  perpMaxWithdrawAmount: NotRequired[Decimal]
+  """Maximum withdrawable from the perp account."""
+  chainLimit: NotRequired[Decimal]
+  """Chain withdrawal limit."""
+  withdrawFee: NotRequired[Decimal]
+  """Withdrawal fee."""
+
+
+class Request(TypedDict): ...
+
+
+class AssetWithdrawLimits(TypedDict):
+  """Withdraw limits of one asset."""
+
+  currency: NotRequired[str]
+  """Asset name."""
+  spotTotalWithdrawAmount: NotRequired[Decimal]
+  """Total withdrawn from the spot account."""
+  perpTotalWithdrawAmount: NotRequired[Decimal]
+  """Total withdrawn from the perp account."""
+  dailyLimit: NotRequired[Decimal]
+  """Daily limit for this asset."""
+  chainBalances: NotRequired[dict[str, ChainWithdrawLimit]]
+  """Limits per chain, keyed by chain id."""
+
+
+class WithdrawInfo(TypedDict):
+  """Withdrawal limits."""
+
+  userDailyLimit: NotRequired[Decimal]
+  """User's daily withdrawal limit."""
+  userRemainingDailyLimit: NotRequired[Decimal]
+  """User's remaining daily limit."""
+  totalDailyLimit: NotRequired[Decimal]
+  """Platform daily limit."""
+  totalRemainingDailyLimit: NotRequired[Decimal]
+  """Platform remaining daily limit."""
+  balances: NotRequired[dict[str, AssetWithdrawLimits]]
+  """Limits per asset, keyed by asset name."""
+
+
+class WithdrawInfoEndpoint(RpcEndpoint):
+  """Get the user's withdrawal limits and available balances per asset and chain."""
+
+  async def withdraw_info(self, *, validate: bool | None = None) -> WithdrawInfo:
+    """Get the user's withdrawal limits and available balances per asset and chain.
+
+    Args:
+      validate: Override this call's response validation; falls back to the client-level default when omitted.
+
+    References:
+      - [Official docs](https://asterdex.github.io/aster-api-website/aster-chain/endpoints/#get-withdraw-info-user_data)
+    """
+    return await self.request(
+      Request(),
+      method='GET',
+      path='perp/user-withdraw-info',
+      meta={},
+      validate=validate,
+      request_type=Request,
+      response_type=WithdrawInfo,
+    )

typed_aster/chain/rpc/__init__.py

@@ -0,0 +1,14 @@
+# Generated by typed-dev — see CONTRIBUTING.md.
+from .get_balance import GetBalance
+from .open_orders import OpenOrders
+from .spot_open_orders import SpotOpenOrders
+from .spot_user_fills import SpotUserFills
+from .user_fills import UserFills
+
+
+class ChainRpc(GetBalance, OpenOrders, SpotOpenOrders, SpotUserFills, UserFills):
+  """Aster Chain read-only JSON-RPC 2.0 (`POST /info`): balances, positions, staking summary, open orders and fills of any address, honouring account privacy mode.
+
+  References:
+    - [Upstream docs](https://asterdex.github.io/aster-api-website/rpc/endpoints/)
+  """