LighterPoolSummary

Documentation for eth_defi.lighter.vault.LighterPoolSummary Python class.

class LighterPoolSummary

Bases: object

Summary information for a Lighter pool from the bulk listing.

From /api/v1/publicPoolsMetadata.

Attributes summary

account_index	Pool account index (int64 primary identifier)
name	Pool display name (e.g.
l1_address	Operator address from the API's legacy l1_address field
annual_percentage_yield	Annual percentage yield
sharpe_ratio	Risk-adjusted return metric
operator_fee	Operator fee percentage (e.g.
total_asset_value	Total asset value (TVL) in the deployment's collateral currency
total_shares	Total shares outstanding
status	Pool status code (0 = active)
account_type	Account type code (2 = pool)
master_account_index	Master account index (operator's main account)
created_at	Creation timestamp
is_llp	Whether this is the LLP (Lighter Liquidity Pool) protocol pool

Methods summary

__init__(account_index, name, l1_address, ...)

account_index: int

Pool account index (int64 primary identifier)

name: str

Pool display name (e.g. “ETH 3x long”)

l1_address: str

Operator address from the API’s legacy l1_address field

annual_percentage_yield: float

Annual percentage yield

sharpe_ratio: Optional[float]

Risk-adjusted return metric

operator_fee: float

Operator fee percentage (e.g. 10.0 = 10%)

total_asset_value: float

Total asset value (TVL) in the deployment’s collateral currency

total_shares: int

Total shares outstanding

status: int

Pool status code (0 = active)

account_type: int

Account type code (2 = pool)

master_account_index: int

Master account index (operator’s main account)

created_at: Optional[datetime.datetime]

Creation timestamp

is_llp: bool

Whether this is the LLP (Lighter Liquidity Pool) protocol pool

__init__(account_index, name, l1_address, annual_percentage_yield, sharpe_ratio, operator_fee, total_asset_value, total_shares, status, account_type, master_account_index, created_at, is_llp=False)

Parameters

• account_index (int) –

• name (str) –

• l1_address (str) –

• annual_percentage_yield (float) –

• sharpe_ratio (Optional[float]) –

• operator_fee (float) –

• total_asset_value (float) –

• total_shares (int) –

• status (int) –

• account_type (int) –

• master_account_index (int) –

• created_at (Optional[datetime.datetime]) –

• is_llp (bool) –

Return type

None