VaultFlowError

Documentation for eth_defi.vault.deposit_redeem.VaultFlowError exception.

exception VaultFlowError

Bases: Exception

Structured failure while preparing or executing a vault flow.

Preflight failures use VaultFlowUnavailable; mined transaction failures use VaultTransactionFailed. The common fields let a caller preserve useful context without treating a rejected request as a transaction that needs receipt handling.

Parameters

• reason – Human-readable reason for the failed flow.

• protocol – Protocol adapter that detected the failure, when known.

• vault_address – Vault address whose flow was attempted, when known.

• caller – Address for which the flow was prepared, when known.

• asset_address – Input asset selected for a multi-asset flow, when known.

• direction – deposit or redeem when known.

• phase – Lifecycle phase such as request or transaction.

• decoded_error – Protocol-specific decoded error name, when available.

• preflight_result – Stable consumer-facing result for a predictable refusal. This is an optional migration field: callers must fall back to decoded_error while supporting older eth-defi releases that do not populate it.

• raw_revert_data – Raw revert payload, when available.

• requested_raw_amount – Requested amount in the contract’s native raw unit, when applicable.

• available_raw_amount – Available amount in the contract’s native raw unit, when applicable.

• minimum_raw_amount – Protocol minimum in the contract’s native raw unit, when applicable.

• function_selector – Four-byte selector of the denied protocol entry point, when known.

• error_selector – Four-byte selector of the expected or decoded custom error, when known.

• access_delay – Access-manager scheduling delay in seconds, when a caller is eligible only after delayed execution.

• next_open – Naive UTC time at which a predictable closed protocol window next opens.

Store structured context for a vault-flow failure.

__init__(reason, *, protocol=None, vault_address=None, caller=None, asset_address=None, direction=None, phase=None, decoded_error=None, preflight_result=None, raw_revert_data=None, requested_raw_amount=None, available_raw_amount=None, minimum_raw_amount=None, function_selector=None, error_selector=None, access_delay=None, next_open=None)

Store structured context for a vault-flow failure.

Parameters

• reason (str) –

• protocol (Optional[str]) –

• vault_address (Optional[eth_typing.evm.HexAddress]) –

• caller (Optional[eth_typing.evm.HexAddress]) –

• asset_address (Optional[eth_typing.evm.HexAddress]) –

• direction (Optional[Literal['deposit', 'redeem']]) –

• phase (Optional[str]) –

• decoded_error (Optional[str]) –

• preflight_result (Optional[str]) –

• raw_revert_data (Optional[hexbytes.main.HexBytes]) –

• requested_raw_amount (Optional[int]) –

• available_raw_amount (Optional[int]) –

• minimum_raw_amount (Optional[int]) –

• function_selector (Optional[hexbytes.main.HexBytes]) –

• error_selector (Optional[hexbytes.main.HexBytes]) –

• access_delay (Optional[int]) –

• next_open (Optional[datetime.datetime]) –

Return type

None

__new__(**kwargs)

add_note(note, /)

Add a note to the exception

with_traceback(tb, /)

Set self.__traceback__ to tb and return self.