ERC7540DepositManager

Documentation for eth_defi.erc_4626.vault_protocol.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_max_deposit(owner)

How much we can deposit

get_redemption_delay_over(address)

Get the redemption timer left for an address.

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.
__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
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

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
Return type

decimal.Decimal

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

How many denomination tokens we get for a redeem.

Parameters
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
Return type

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
Return type

eth_defi.vault.deposit_redeem.DepositRedeemEventAnalysis | eth_defi.vault.deposit_redeem.DepositRedeemEventFailure

get_max_deposit(owner)

How much we can deposit

Parameters

owner (eth_typing.evm.HexAddress) –

Return type

decimal.Decimal | None