OstiumSimulationResult

Documentation for eth_defi.erc_4626.vault_protocol.gains.testing.OstiumSimulationResult Python class.

class OstiumSimulationResult

Bases: object

Result of a simulated Ostium V1.5 deposit/withdrawal cycle.

Attributes summary

deposit_amount	USDC deposited
shares_received	OLP shares received after claim
share_price	Settlement price used
usdc_withdrawn	USDC received after withdrawal claim
settlements_forced	Number of settlements forced

Methods summary

__init__(deposit_amount, shares_received, ...)

deposit_amount: decimal.Decimal

USDC deposited

shares_received: decimal.Decimal

OLP shares received after claim

share_price: decimal.Decimal

Settlement price used

usdc_withdrawn: decimal.Decimal

USDC received after withdrawal claim

settlements_forced: int

Number of settlements forced

__init__(deposit_amount, shares_received, share_price, usdc_withdrawn, settlements_forced)

Parameters

• deposit_amount (decimal.Decimal) –

• shares_received (decimal.Decimal) –

• share_price (decimal.Decimal) –

• usdc_withdrawn (decimal.Decimal) –

• settlements_forced (int) –

Return type

None