VaultDepositEvent
Documentation for eth_defi.hyperliquid.deposit.VaultDepositEvent Python class.
- class VaultDepositEvent
Bases:
objectRepresents a vault deposit, withdrawal, or related event.
This dataclass captures vault-related ledger events from the
userNonFundingLedgerUpdatesAPI endpoint.Attributes summary
Type of event
Vault address
User address (for withdrawals and commissions)
USDC amount (positive for deposits/inflows, negative for withdrawals/outflows)
Event timestamp
Transaction hash
Requested USD amount (for withdrawals)
Commission amount (for withdrawals)
Closing cost (for withdrawals)
Basis amount (for withdrawals)
Net withdrawn USD (for withdrawals)
Methods summary
__init__(event_type, vault_address, ...[, ...])- event_type: eth_defi.hyperliquid.deposit.VaultEventType
Type of event
- vault_address: eth_typing.evm.HexAddress
Vault address
- user_address: Optional[eth_typing.evm.HexAddress]
User address (for withdrawals and commissions)
- usdc: decimal.Decimal
USDC amount (positive for deposits/inflows, negative for withdrawals/outflows)
- timestamp: datetime.datetime
Event timestamp
- hash: Optional[str]
Transaction hash
- requested_usd: Optional[decimal.Decimal]
Requested USD amount (for withdrawals)
- commission: Optional[decimal.Decimal]
Commission amount (for withdrawals)
- closing_cost: Optional[decimal.Decimal]
Closing cost (for withdrawals)
- basis: Optional[decimal.Decimal]
Basis amount (for withdrawals)
- net_withdrawn_usd: Optional[decimal.Decimal]
Net withdrawn USD (for withdrawals)
- __init__(event_type, vault_address, user_address, usdc, timestamp, hash=None, requested_usd=None, commission=None, closing_cost=None, basis=None, net_withdrawn_usd=None)
- Parameters
event_type (eth_defi.hyperliquid.deposit.VaultEventType) –
vault_address (eth_typing.evm.HexAddress) –
user_address (Optional[eth_typing.evm.HexAddress]) –
usdc (decimal.Decimal) –
timestamp (datetime.datetime) –
requested_usd (Optional[decimal.Decimal]) –
commission (Optional[decimal.Decimal]) –
closing_cost (Optional[decimal.Decimal]) –
basis (Optional[decimal.Decimal]) –
net_withdrawn_usd (Optional[decimal.Decimal]) –
- Return type
None