VaultDepositEvent

Documentation for eth_defi.hyperliquid.deposit.VaultDepositEvent Python class.

class VaultDepositEvent

Bases: object

Represents a vault deposit, withdrawal, or related event.

This dataclass captures vault-related ledger events from the userNonFundingLedgerUpdates API endpoint.

Attributes summary

`event_type`	Type of event
`vault_address`	Vault address
`user_address`	User address (for withdrawals and commissions)
`usdc`	USDC amount (positive for deposits/inflows, negative for withdrawals/outflows)
`timestamp`	Event timestamp
`hash`	Transaction hash
`requested_usd`	Requested USD amount (for withdrawals)
`commission`	Commission amount (for withdrawals)
`closing_cost`	Closing cost (for withdrawals)
`basis`	Basis amount (for withdrawals)
`net_withdrawn_usd`	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: str | None: Transaction hash

requested_usd: decimal.Decimal | None: Requested USD amount (for withdrawals)

commission: decimal.Decimal | None: Commission amount (for withdrawals)

closing_cost: decimal.Decimal | None: Closing cost (for withdrawals)

basis: decimal.Decimal | None: Basis amount (for withdrawals)

net_withdrawn_usd: decimal.Decimal | None: 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) –
hash (str | None) –
requested_usd (decimal.Decimal | None) –
commission (decimal.Decimal | None) –
closing_cost (decimal.Decimal | None) –
basis (decimal.Decimal | None) –
net_withdrawn_usd (decimal.Decimal | None) –

Return type

None