HyperliquidVaultDepositStatus

Documentation for eth_defi.hyperliquid.vault.HyperliquidVaultDepositStatus Python class.

class HyperliquidVaultDepositStatus

Bases: object

Deposit permission and the amount allowed by our trading policy.

The price exporter and trade-executor use this result to apply the same low-leader-share rule without labelling an open vault as closed. Callers must check deposits_open as well as max_deposit: an absent amount limit does not imply permission to deposit.

Attributes summary

deposits_open

Permission reported by the API, or unknown if a required flag is absent.

closed_reason

Reason derived from an explicit closed or deposits-disabled API flag.

max_deposit

Maximum new deposit in USDC: zero under the low-share policy, otherwise None.

capacity_warning

Explanation of a low-share policy block, not a closure reason.

Methods summary

__init__(deposits_open[, closed_reason, ...])

deposits_open: Optional[bool]

Permission reported by the API, or unknown if a required flag is absent.

closed_reason: Optional[str]

Reason derived from an explicit closed or deposits-disabled API flag.

max_deposit: Optional[decimal.Decimal]

Maximum new deposit in USDC: zero under the low-share policy, otherwise None. Closure and unknown permission are carried in deposits_open.

capacity_warning: Optional[str]

Explanation of a low-share policy block, not a closure reason.

__init__(deposits_open, closed_reason=None, max_deposit=None, capacity_warning=None)
Parameters
Return type

None