staked_ratio

Documentation for eth_defi.yield_basis.metrics.staked_ratio function.

staked_ratio(raw_effective_supply, raw_staked_supply)

Return staked LT units divided by effective LT supply.

The ratio is contextual market information only; staked gauge returns and YB incentives are outside the base LT performance curve.

Parameters
  • raw_effective_supply (int) – Effective LT supply from updated_balances().

  • raw_staked_supply (int) – Effective LT units held in the staker.

Returns

Ratio from zero to one, or None for zero supply.

Return type

Optional[decimal.Decimal]