RedemptionRequest

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

class RedemptionRequest

Bases: object

Wrap the different redeem functions async vaults implement.

Attributes summary

vault

Vault we are dealing with

owner

Owner of the shares

to

Receiver of underlying asset

shares

Human-readable shares

raw_shares

Raw amount of shares

funcs

Transactions we need to perform in order to open a redemption

web3

Methods summary

__init__(vault, owner, to, shares, ...)

broadcast([from_, gas])

Broadcast all the transactions in this request.

parse_redeem_transaction(tx_hashes)

Parse the transaction receipt to get the actual shares redeemed.
vault: VaultBase

Vault we are dealing with

owner: eth_typing.evm.HexAddress

Owner of the shares

to: eth_typing.evm.HexAddress

Receiver of underlying asset

shares: decimal.Decimal

Human-readable shares

raw_shares: int

Raw amount of shares

funcs: list[web3.contract.contract.ContractFunction]

Transactions we need to perform in order to open a redemption

It’s a list because for Gains we need 2 tx

parse_redeem_transaction(tx_hashes)

Parse the transaction receipt to get the actual shares redeemed.

  • Assumes only one redemption request per vault per transaction

Raises

CannotParseRedemptionTransaction – If we did not know how to parse the transaction

Parameters

tx_hashes (list[hexbytes.main.HexBytes]) –

Return type

eth_defi.vault.deposit_redeem.RedemptionTicket

broadcast(from_=None, gas=1000000)

Broadcast all the transactions in this request.

Parameters
Returns

List of transaction hashes

Return type

list[hexbytes.main.HexBytes]

__init__(vault, owner, to, shares, raw_shares, funcs)
Parameters
Return type

None