classify_hyperliquid_vault_deposit

Documentation for eth_defi.hyperliquid.vault.classify_hyperliquid_vault_deposit function.

classify_hyperliquid_vault_deposit(is_closed, allow_deposits, relationship_type='normal', leader_fraction=None)

Read deposit permission and apply the 5.5% leader-share trading policy.

Used by the daily and high-frequency exporters, live pricing, and the execution-time deposit check. Explicit closure takes precedence over missing flags. For an open normal vault, an observed leader share below 5.5% sets the allowed deposit to zero. HLP parents ignore allow_deposits and the leader-share policy, but still honour is_closed.

Hyperliquid’s 5% leader requirement restricts leader withdrawals. Whether it also limits follower deposits is unresolved, so the 5.5% boundary remains a conservative trading policy. Recorded historical shares remain usable when a separate observation clock is absent. This function classifies values; it does not refresh their timestamps or infer permission from a missing cap.

Parameters

  • is_closed (Optional[bool]) – Nullable vaultDetails.isClosed source flag.

  • allow_deposits (Optional[bool]) – Nullable vaultDetails.allowDeposits source flag.

  • relationship_type (str) – Vault relationship type; HLP parent ignores allowDeposits.

  • leader_fraction (Optional[float]) – Leader equity as a fraction of vault capital, e.g. 0.06 for 6%. Use None when no recorded value is available.

Returns

API permission, any closure reason, and any trading-policy amount limit.

Return type

eth_defi.hyperliquid.vault.HyperliquidVaultDepositStatus