OstiumDepositRequest

Documentation for eth_defi.erc_4626.vault_protocol.gains.deposit_redeem.OstiumDepositRequest Python class.

class OstiumDepositRequest

Bases: eth_defi.vault.deposit_redeem.DepositRequest

Wraps Ostium V1.5 requestDeposit(uint256 assets) call.

After broadcasting, parse the transaction to extract the settlement_id from the DepositRequestedV2 event.

Attributes summary

vault
owner
to
amount
raw_amount
funcs
gas
value
web3

Methods summary

__init__(vault, owner, to, amount, ...[, ...])
broadcast([from_, gas, check_value])	Broadcast all the transactions in this request.
parse_deposit_transaction(tx_hashes)	Parse the DepositRequestedV2 event from requestDeposit() transaction.

__init__(vault, owner, to, amount, raw_amount, funcs, gas=None, value=None)

Parameters

• vault (VaultBase) –

• owner (eth_typing.evm.HexAddress) –

• to (eth_typing.evm.HexAddress) –

• amount (decimal.Decimal) –

• raw_amount (int) –

• funcs (list[web3.contract.contract.ContractFunction]) –

• gas (Optional[int]) –

• value (Optional[decimal.Decimal]) –

Return type

None

broadcast(from_=None, gas=None, check_value=True)

Broadcast all the transactions in this request.

Parameters

• from – Address to send the transactions from

• gas (Optional[int]) – Gas limit to use for each transaction

• from_ (eth_typing.evm.HexAddress) –

Returns

List of transaction hashes

Raises

TransactionAssertionError – If any of the transactions revert

Return type

eth_defi.vault.deposit_redeem.RedemptionTicket

parse_deposit_transaction(tx_hashes)

Parse the DepositRequestedV2 event from requestDeposit() transaction.

DepositRequestedV2(address indexed owner, uint32 indexed settlementId, uint256 assets)

Parameters

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

Return type

eth_defi.erc_4626.vault_protocol.gains.deposit_redeem.OstiumDepositTicket