VaultRedemptionPreflight

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

class VaultRedemptionPreflight

Bases: object

Amount-aware immediate-redemption guidance from a vault manager.

The result is advisory because capacity can change before a transaction is mined. The manager’s request constructor must repeat an available-capacity check before broadcasting. It is currently returned only by adapters that have an owner-specific immediate-capacity query, such as cSigma’s ERC-4626 maxRedeem.

Note

Trade-executor integrations must map an unavailable result, or a matching VaultFlowUnavailable from request construction, to a capacity result before their generic receipt-analysis error handling.

Parameters

  • available – Whether the requested raw shares can be redeemed immediately.

  • requested_raw_shares – Requested vault-share amount in native units.

  • available_raw_shares – Current immediate capacity in native share units, when the adapter can determine it.

  • reason – Stable adapter reason when the request is unavailable.

Attributes summary

available

requested_raw_shares

available_raw_shares

reason

Methods summary

__init__(available, requested_raw_shares[, ...])

__init__(available, requested_raw_shares, available_raw_shares=None, reason=None)
Parameters
Return type

None