ERC7540DepositManager

Documentation for eth_defi.lagoon.deposit_redeem.ERC7540DepositManager Python class.

class ERC7540DepositManager

Bases: eth_defi.vault.deposit_redeem.VaultDepositManager

ERC-7540 async deposit/redeem flow.

Currently coded for Lagoon, but should work with any vault.

Example:

Attributes summary

web3

Methods summary

`__init__`(vault)
`analyse_deposit`(claim_tx_hash, deposit_ticket)	Analyse the transaction where we claim shares
`analyse_redemption`(claim_tx_hash, ...)	Analyse the transaction where we claim our capital back.
`can_create_deposit_request`(owner)	Can we start depositing now.
`can_create_redemption_request`(owner)	Gains allows request redepetion only two first days of three days epoch.
`can_finish_deposit`(deposit_ticket)	Check if our ticket is ready do finish.
`can_finish_redeem`(redemption_ticket)	Check if the redemption request can be redeemed now.
`create_deposit_request`(owner[, to, amount, ...])
`create_redemption_request`(owner[, to, ...])	Start the process to get shares to money
`estimate_deposit`(owner, amount[, ...])	How many shares we get for a deposit.
`estimate_redeem`(owner, shares[, ...])	How many denomination tokens we get for a redeem.
`estimate_redemption_delay`()	Get the redemption delay for this vault.
`finish_deposit`(deposit_ticket)	Return bound call to claim our shares
`finish_redemption`(redemption_ticket)
`get_deposit_delay_over`(address)	Estimate when a pending async deposit request will settle.
`get_deposit_request_status`(ticket)	Map Lagoon ERC-7540 deposit state to the generic status enum.
`get_max_deposit`(owner)	How much we can deposit
`get_redemption_delay_over`(address)	Get the redemption timer left for an address.
`get_redemption_request_status`(ticket)	Map Lagoon ERC-7540 redemption state to the generic status enum.
`has_synchronous_deposit`()	Does this vault support synchronous deposits?
`has_synchronous_redemption`()	Does this vault support synchronous deposits?
`is_deposit_in_progress`(owner)	Check pending ERC-7540 request.
`is_redemption_in_progress`(owner)	Check if the owner has an active redemption request.
`reclaim_deposit`(ticket)	Return a function to recover funds after a failed async deposit settlement.
`reclaim_withdrawal`(ticket)	Return a function to recover shares after a failed async withdrawal settlement.
`reconstruct_deposit_ticket`(data)	Reconstruct an `ERC7540DepositTicket` from a serialised dict.
`reconstruct_redemption_ticket`(data)	Reconstruct an `ERC7540RedemptionTicket` from a serialised dict.
`serialize_deposit_ticket`(ticket)	Serialise a Lagoon ERC-7540 deposit ticket, including `request_id`.
`serialize_redemption_ticket`(ticket)	Serialise a Lagoon ERC-7540 redemption ticket, including `request_id`.

__init__(vault)

Parameters: vault (eth_defi.erc_7540.vault.ERC7540Vault) –

create_redemption_request(owner, to=None, shares=None, raw_shares=None, check_max_deposit=True, check_enough_token=True)

Start the process to get shares to money

Parameters

owner (eth_typing.evm.HexAddress) –
to (eth_typing.evm.HexAddress) –
shares (decimal.Decimal) –
raw_shares (int) –

Return type

eth_defi.erc_4626.vault_protocol.lagoon.deposit_redeem.ERC7540RedemptionRequest

finish_deposit(deposit_ticket)

Return bound call to claim our shares

Parameters: deposit_ticket (eth_defi.vault.deposit_redeem.DepositTicket) –
Return type: web3.contract.contract.ContractFunction

can_finish_deposit(deposit_ticket)

Check if our ticket is ready do finish.

Function signature: claimableDepositRequest(uint256 requestId, address controller)
If the returned value is > 0, the request is settled and claimable.

Parameters: deposit_ticket (eth_defi.erc_4626.vault_protocol.lagoon.deposit_redeem.ERC7540DepositTicket) –

can_finish_redeem(redemption_ticket)

Check if the redemption request can be redeemed now.

Phase 2 of redemption, after settlement

Parameters: redemption_ticket (eth_defi.erc_4626.vault_protocol.lagoon.deposit_redeem.ERC7540RedemptionTicket) – Redemption redemption_ticket ticket from create_redemption_request()
Returns: True if can be redeemed now

serialize_deposit_ticket(ticket)

Serialise a Lagoon ERC-7540 deposit ticket, including request_id.

Parameters: ticket (eth_defi.erc_4626.vault_protocol.lagoon.deposit_redeem.ERC7540DepositTicket) –
Return type: dict

reconstruct_deposit_ticket(data)

Reconstruct an ERC7540DepositTicket from a serialised dict.

Parameters: data (dict) –
Return type: eth_defi.erc_4626.vault_protocol.lagoon.deposit_redeem.ERC7540DepositTicket

serialize_redemption_ticket(ticket)

Serialise a Lagoon ERC-7540 redemption ticket, including request_id.

Parameters: ticket (eth_defi.erc_4626.vault_protocol.lagoon.deposit_redeem.ERC7540RedemptionTicket) –
Return type: dict

reconstruct_redemption_ticket(data)

Reconstruct an ERC7540RedemptionTicket from a serialised dict.

Parameters: data (dict) –
Return type: eth_defi.erc_4626.vault_protocol.lagoon.deposit_redeem.ERC7540RedemptionTicket

get_deposit_request_status(ticket)

Map Lagoon ERC-7540 deposit state to the generic status enum.

Check the request-specific claimable amount first: an aggregate pendingDepositRequest(0, owner) query lumps together all of the owner’s requests, so probing it first would report an already-settled request as still pending whenever another request is outstanding. Lagoon has no on-chain reclaim, so reclaimable is never returned.

Parameters: ticket (eth_defi.erc_4626.vault_protocol.lagoon.deposit_redeem.ERC7540DepositTicket) –
Return type: eth_defi.vault.deposit_redeem.AsyncVaultRequestStatus

get_redemption_request_status(ticket)

Map Lagoon ERC-7540 redemption state to the generic status enum.

Request-specific claimable is checked before the aggregate pending query for the same reason as get_deposit_request_status().

Parameters: ticket (eth_defi.erc_4626.vault_protocol.lagoon.deposit_redeem.ERC7540RedemptionTicket) –
Return type: eth_defi.vault.deposit_redeem.AsyncVaultRequestStatus

can_create_deposit_request(owner)

Can we start depositing now.

Vault can be full?

Parameters: owner (eth_typing.evm.HexAddress) –
Return type: bool

can_create_redemption_request(owner)

Gains allows request redepetion only two first days of three days epoch.

Returns: True if can create a redemption request now
Parameters: owner (eth_typing.evm.HexAddress) –
Return type: bool

has_synchronous_deposit()

Does this vault support synchronous deposits?

E.g. ERC-7540 vaults

Return type: bool

has_synchronous_redemption()

Does this vault support synchronous deposits?

E.g. ERC-7540 vaults

Return type: bool

estimate_redemption_delay()

Get the redemption delay for this vault.

What is overall redemption delay: not related to the current moment
How long it takes before a redemption request is allowed
This is not specific for any address, but the general vault rule
E.g. you get 0xa592703b is an IPOR Fusion error code AccountIsLocked, if you try to instantly redeem from IPOR vaults

Returns: Redemption delay as a datetime.timedelta
Raises: NotImplementedError – If not implemented for this vault protocoll.
Return type: datetime.timedelta

get_redemption_delay_over(address)

Get the redemption timer left for an address.

How long it takes before a redemption request is allowed
This is not specific for any address, but the general vault rule
E.g. you get 0xa592703b is an IPOR Fusion error code AccountIsLocked, if you try to instantly redeem from IPOR vaults

Returns

UTC timestamp when the account can redeem.

Naive datetime.

Raises

NotImplementedError – If not implemented for this vault protocoll.

Parameters

address (Union[eth_typing.evm.HexAddress, str]) –

Return type

datetime.datetime

is_redemption_in_progress(owner)

Check if the owner has an active redemption request.

Parameters: owner (eth_typing.evm.HexAddress) – Owner of the shares
Returns: True if there is an active redemption request
Return type: bool

is_deposit_in_progress(owner)

Check pending ERC-7540 request.

To check if an address has an unsettled deposit in progress on an ERC-7540 contract without knowing the specific request ID, query the pendingDepositRequest view function from the contract’s interface (IERC7540Vault) using a request ID of 0. According to the ERC-7540 specification, passing requestId=0 aggregates the pending deposit amounts across all requests for the given controller (address), returning the total pending assets as a uint256. A value greater than 0 indicates one or more unsettled deposits in progress that have not yet been fulfilled by the vault operator.

Parameters: owner (eth_typing.evm.HexAddress) –
Return type: bool

estimate_deposit(owner, amount, block_identifier='latest')

How many shares we get for a deposit.

Parameters

owner (eth_typing.evm.HexAddress) –
amount (decimal.Decimal) –
block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) –

Return type

decimal.Decimal

estimate_redeem(owner, shares, block_identifier='latest')

How many denomination tokens we get for a redeem.

Parameters

owner (eth_typing.evm.HexAddress) –
shares (decimal.Decimal) –
block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) –

Return type

decimal.Decimal

analyse_deposit(claim_tx_hash, deposit_ticket)

Analyse the transaction where we claim shares

Return information of the actual executed price for which we got the shares for

Parameters

claim_tx_hash (Union[hexbytes.main.HexBytes, str]) –
deposit_ticket (Optional[eth_defi.vault.deposit_redeem.DepositTicket]) –

Return type

Union[eth_defi.vault.deposit_redeem.DepositRedeemEventAnalysis, eth_defi.vault.deposit_redeem.DepositRedeemEventFailure]

analyse_redemption(claim_tx_hash, redemption_ticket)

Analyse the transaction where we claim our capital back.

Return information of the actual executed price for which we got the shares for

Parameters

claim_tx_hash (Union[hexbytes.main.HexBytes, str]) –
redemption_ticket (Optional[eth_defi.vault.deposit_redeem.RedemptionTicket]) –

Return type

Union[eth_defi.vault.deposit_redeem.DepositRedeemEventAnalysis, eth_defi.vault.deposit_redeem.DepositRedeemEventFailure]

get_deposit_delay_over(address)

Estimate when a pending async deposit request will settle.

Mirror of get_redemption_delay_over() for the deposit side.
Used to show an estimated settlement time for unsettled deposits (e.g. in the trade-executor trade-ui table).
Default returns None: the protocol has no deterministic on-chain settlement schedule (e.g. operator-driven ERC-7540 vaults like Lagoon). Subclasses with a predictable settlement cadence (e.g. Ostium V1.5) override this to return an estimated UTC timestamp.

Parameters: address (Union[eth_typing.evm.HexAddress, str]) – Owner of the pending deposit request.
Returns: Naive UTC timestamp when the deposit is expected to settle, or None when no on-chain estimate is available.
Return type: Optional[datetime.datetime]

get_max_deposit(owner)

How much we can deposit

Parameters: owner (eth_typing.evm.HexAddress) –
Return type: Optional[decimal.Decimal]

reclaim_deposit(ticket)

Return a function to recover funds after a failed async deposit settlement.

Returns None if the protocol does not support reclaim.

Parameters: ticket (eth_defi.vault.deposit_redeem.DepositTicket) –
Return type: Optional[web3.contract.contract.ContractFunction]

reclaim_withdrawal(ticket)

Return a function to recover shares after a failed async withdrawal settlement.

Returns None if the protocol does not support reclaim.

Parameters: ticket (eth_defi.vault.deposit_redeem.RedemptionTicket) –
Return type: Optional[web3.contract.contract.ContractFunction]