Redemption

Documentation for eth_defi.enzyme.events.Redemption Python class.

class Redemption[source]

Enzyme deposit event wrapper.

Currently only supports redeemSharesInKind withdrawal method. This means we get the tokens of the undetlying positions directly to the investor wallet without sellign them.

Wraps SharesRedeemed event
See ComptrollerLib.sol
See redeemSharesInKind()

The solidity event:

event SharesRedeemed(
    address indexed redeemer,
    address indexed recipient,
    uint256 sharesAmount,
    address[] receivedAssets,
    uint256[] receivedAssetAmounts
);

Attributes summary

`arguments`	Access the non-indexed Solidity event arguments.
`denomination_token`	Get the denominator token for withdrawal/deposit.
`receiver`	Address of the user who received the assets.
`redeem_amount`	Amount of withdrawal in the number of shares.
`redeemed_assets`	Get the list of assets in this withdrawal.
`redeemer`	Address of the user who did the redemption transaction.
`shares_token`	Get the shares token for withdrawal/deposit.
`timestamp`	Return the block mined at timestamp.
`web3`	Our web3 connection.

Methods summary

`__init__`(vault, event_data)
`wrap`(vault, event_data)	Parse Solidity events to the wrapped format.

property redeem_amount: decimal.Decimal: Amount of withdrawal in the number of shares.

property redeemed_assets: List[Tuple[eth_defi.token.TokenDetails, int]]

Get the list of assets in this withdrawal.

Returns: List of (redeemed token, raw token amount) tuples

property receiver: eth_typing.evm.HexAddress

Address of the user who received the assets.

Can be different from the redeemer.

property redeemer: eth_typing.evm.HexAddress

Address of the user who did the redemption transaction.

Can be different from the receiver.