LighterEquity

Documentation for eth_defi.lighter.valuation.LighterEquity Python class.

class LighterEquity

Bases: object

Equity breakdown for a Lighter trading account.

See fetch_lighter_total_equity().

Attributes summary

`account_index`
`collateral`
`unrealised_pnl`
`total_asset_value`
`available_balance`
`initial_margin_requirement`
`maintenance_margin_requirement`
`position_count`

Methods summary

`__init__`(account_index, collateral, ...)
`calculate_total_from_parts`()	Calculate account NAV from collateral and unrealised PnL.
`get_total`()	Return canonical Lighter account NAV.

__init__(account_index, collateral, unrealised_pnl, total_asset_value, available_balance, initial_margin_requirement, maintenance_margin_requirement, position_count)

Parameters

account_index (int) –
collateral (decimal.Decimal) –
unrealised_pnl (decimal.Decimal) –
total_asset_value (decimal.Decimal) –
available_balance (decimal.Decimal) –
initial_margin_requirement (decimal.Decimal) –
maintenance_margin_requirement (decimal.Decimal) –
position_count (int) –

Return type

None

calculate_total_from_parts()

Calculate account NAV from collateral and unrealised PnL.

Returns: collateral + unrealised_pnl in USDC.
Return type: decimal.Decimal

get_total()

Return canonical Lighter account NAV.

Lighter exposes total_asset_value directly, so this method returns the API value instead of recomputing it locally. Use calculate_total_from_parts() for a collateral plus PnL sanity check.

Returns: Account net asset value in USDC.
Return type: decimal.Decimal