redemption_asset_per_share

Documentation for eth_defi.yield_basis.metrics.redemption_asset_per_share function.

redemption_asset_per_share(raw_preview_shares, raw_redemption_assets, *, asset_decimals, share_scale=1000000000000000000)

Convert a protocol redemption preview to native asset per LT share.

preview_withdraw returns raw units of the market’s volatile asset, whereas LT shares use the protocol’s 18-decimal fixed-point scale.

Parameters
  • raw_preview_shares (int) – Raw LT units supplied to preview_withdraw.

  • raw_redemption_assets (int) – Raw underlying units returned by the preview.

  • asset_decimals (int) – ERC-20 decimals of the underlying asset.

  • share_scale (int) – LT share fixed-point scale.

Returns

Native-asset redemption value per whole LT share.

Return type

decimal.Decimal