VaultForcedSettlementResult

Documentation for eth_defi.vault.deposit_redeem.VaultForcedSettlementResult Python class.

class VaultForcedSettlementResult

Bases: object

Outcome of an Anvil-only forced settlement attempt.

Synchronous managers return a no-op result because their successful request transaction already completes the lifecycle. Asynchronous managers return the ticket status before and after their protocol-specific settlement transaction(s).

Attributes summary

ticket

Ticket progressed by the simulation, or None for synchronous flows.

settlement_required

False when the completed flow does not need a settlement transaction.

status_before

Request status before settlement, when a ticket was supplied.

status_after

Request status after settlement, when a ticket was supplied.

transaction_hashes

Transactions broadcast by the forced settlement helper.

Methods summary

__init__(ticket, settlement_required, ...[, ...])

ticket: Optional[Union[eth_defi.vault.deposit_redeem.DepositTicket, eth_defi.vault.deposit_redeem.RedemptionTicket]]

Ticket progressed by the simulation, or None for synchronous flows.

settlement_required: bool

False when the completed flow does not need a settlement transaction.

status_before: Optional[eth_defi.vault.deposit_redeem.AsyncVaultRequestStatus]

Request status before settlement, when a ticket was supplied.

status_after: Optional[eth_defi.vault.deposit_redeem.AsyncVaultRequestStatus]

Request status after settlement, when a ticket was supplied.

transaction_hashes: tuple[hexbytes.main.HexBytes, ...]

Transactions broadcast by the forced settlement helper.

__init__(ticket, settlement_required, status_before, status_after, transaction_hashes=())
Parameters
Return type

None