OndoVault

Documentation for eth_defi.tokenised_fund.ondo.vault.OndoVault Python class.

class OndoVault

Bases: eth_defi.vault.base.VaultBase

Read token supply and official on-chain NAV for Ondo funds.

Create an Ondo tokenised-fund adapter.

Parameters

web3 – Ethereum connection.
spec – Chain and registered Ondo share-token address.
token_cache – Optional ERC-20 metadata cache.
features – Shared classification features.
default_block_identifier – Optional default archive block.
require_denomination_token – Retained for shared adapter compatibility.

Attributes summary

`address`	Return the checksum share-token address.
`chain_id`	Return the registered EVM chain id.
`denomination_token`	Get the token which denominates the vault valuation
`deposit_manager`	Deposit manager assocaited with this vault
`description`	Return the reviewed product description.
`flow_manager`	Flow manager associated with this vault
`info`	Get info dictionary related to this vault deployment.
`manager_name`	Return the protocol-managed fund curator name.
`name`	Return the on-chain token name with registered fallback.
`oracle_contract`	Return the product's issuer-published NAV oracle contract.
`share_token`	ERC-20 that presents vault shares.
`short_description`	Return a compact product description.
`symbol`	Return the on-chain token symbol with registered fallback.
`vault_address`	Return the scanner-compatible share-token address.

Methods summary

`__init__`(web3, spec[, token_cache, ...])	Create an Ondo tokenised-fund adapter.
`fetch_available_liquidity`([block_identifier])	Get the amount of denomination token available for immediate withdrawal.
`fetch_denomination_token`()	Return no generic ERC-20 denomination token.
`fetch_denomination_token_address`()	Return no single ERC-20 denomination token for issuer fund NAV.
`fetch_deposit_closed_reason`()	Explain why generic public subscriptions are unavailable.
`fetch_deposit_next_open`()	Get when deposits will next be open.
`fetch_info`()	Export product and NAV-source metadata.
`fetch_nav`([block_identifier])	Return USD NAV for the tokenised fund.
`fetch_oracle_call`()	Construct the canonical NAV call for the registered product.
`fetch_portfolio`(universe[, block_identifier])	Return an empty portfolio because fund holdings are not on-chain vault positions.
`fetch_redemption_closed_reason`()	Explain why generic public redemptions are unavailable.
`fetch_redemption_next_open`()	Get when withdrawals/redemptions will next be open.
`fetch_scan_record_extra_data`()	Export scanner metadata for permissioning and NAV provenance.
`fetch_share_price`([block_identifier])	Fetch official USD NAV/share from the configured issuer oracle.
`fetch_share_token`()	Fetch token metadata for the registered ERC-20 share token.
`fetch_share_token_address`([block_identifier])	Return the ERC-20 share-token address.
`fetch_total_assets`([block_identifier])	Calculate USD NAV from share supply and issuer NAV/share.
`fetch_total_supply`([block_identifier])	Fetch outstanding share-token supply.
`fetch_utilisation_percent`([block_identifier])	Get the percentage of assets currently lent out.
`get_deposit_fee`(block_identifier)	Deposit fee is set to zero by default as vaults usually do not have deposit fees.
`get_deposit_manager`()	Reject public transaction management for permissioned issuer flows.
`get_deposit_manager_capability`()	Return static public transaction-adapter support, if any.
`get_estimated_lock_up`()	Return no fixed lock-up because eligibility and terms are product-specific.
`get_fee_data`()	Return documented fund management fee where available.
`get_fee_mode`()	Get how this vault accounts its fees.
`get_flags`()	Get various vault state flags from the smart contract.
`get_flow_manager`()	Reject unsupported generic flow accounting.
`get_historical_reader`(stateful)	Create the product's supply-and-NAV historical reader.
`get_link`([referral])	Return the official product page.
`get_management_fee`(block_identifier)	Return the documented annual fund management fee, if published.
`get_notes`()	Get a human readable message if we know somethign special is going on with this vault.
`get_performance_fee`(block_identifier)	Return no documented performance fee.
`get_protocol_name`()	Return the name of the vault protocol.
`get_risk`()	Get risk profile of this vault.
`get_spec`()
`get_withdraw_fee`(block_identifier)	Withdraw fee is set to zero by default as vaults usually do not have withdraw fees.
`has_block_range_event_support`()	Return `False` because public fund-flow accounting is unsupported.
`has_custom_fees`()	Does this vault have fees outside the shared fee model.
`has_deposit_distribution_to_all_positions`()	Return `False` because portfolio holdings are issuer-managed.

__init__(web3, spec, token_cache=None, features=None, default_block_identifier=None, require_denomination_token=False)

Create an Ondo tokenised-fund adapter.

Parameters

web3 (web3.main.Web3) – Ethereum connection.
spec (eth_defi.vault.base.VaultSpec) – Chain and registered Ondo share-token address.
token_cache (Optional[dict]) – Optional ERC-20 metadata cache.
features (Optional[set[eth_defi.erc_4626.core.ERC4626Feature]]) – Shared classification features.
default_block_identifier (Optional[Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]]) – Optional default archive block.
require_denomination_token (bool) – Retained for shared adapter compatibility.

property chain_id: int: Return the registered EVM chain id.

property address: eth_typing.evm.HexAddress: Return the checksum share-token address.

property vault_address: eth_typing.evm.HexAddress: Return the scanner-compatible share-token address.

property oracle_contract: web3.contract.contract.Contract: Return the product’s issuer-published NAV oracle contract.

property name: str: Return the on-chain token name with registered fallback.

property symbol: str: Return the on-chain token symbol with registered fallback.

property description: str: Return the reviewed product description.

property short_description: str: Return a compact product description.

property manager_name: str: Return the protocol-managed fund curator name.

fetch_share_token_address(block_identifier='latest')

Return the ERC-20 share-token address.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) –
Return type: eth_typing.evm.HexAddress

fetch_share_token()

Fetch token metadata for the registered ERC-20 share token.

Return type: eth_defi.token.TokenDetails

fetch_denomination_token_address()

Return no single ERC-20 denomination token for issuer fund NAV.

Return type: Optional[eth_typing.evm.HexAddress]

fetch_denomination_token()

Return no generic ERC-20 denomination token.

Return type: Optional[eth_defi.token.TokenDetails]

fetch_oracle_call()

Construct the canonical NAV call for the registered product.

Return type: web3.contract.contract.ContractFunction

fetch_share_price(block_identifier='latest')

Fetch official USD NAV/share from the configured issuer oracle.

Parameters: 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

fetch_total_supply(block_identifier='latest')

Fetch outstanding share-token supply.

Parameters: 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

fetch_total_assets(block_identifier='latest')

Calculate USD NAV from share supply and issuer NAV/share.

Parameters: 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

fetch_nav(block_identifier='latest')

Return USD NAV for the tokenised fund.

Parameters: 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

fetch_info()

Export product and NAV-source metadata.

Return type: eth_defi.tokenised_fund.ondo.vault.OndoVaultInfo

fetch_scan_record_extra_data()

Export scanner metadata for permissioning and NAV provenance.

Return type: dict[str, object]

fetch_portfolio(universe, block_identifier=None)

Return an empty portfolio because fund holdings are not on-chain vault positions.

Parameters

universe (eth_defi.vault.base.TradingUniverse) –
block_identifier (Optional[Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]]) –

Return type

eth_defi.vault.base.VaultPortfolio

has_block_range_event_support()

Return False because public fund-flow accounting is unsupported.

Return type: bool

has_deposit_distribution_to_all_positions()

Return False because portfolio holdings are issuer-managed.

Return type: bool

get_flow_manager()

Reject unsupported generic flow accounting.

Return type: eth_defi.vault.base.VaultFlowManager

get_deposit_manager()

Reject public transaction management for permissioned issuer flows.

Return type: eth_defi.vault.deposit_redeem.VaultDepositManager

fetch_deposit_closed_reason()

Explain why generic public subscriptions are unavailable.

Return type: str

fetch_redemption_closed_reason()

Explain why generic public redemptions are unavailable.

Return type: str

get_historical_reader(stateful)

Create the product’s supply-and-NAV historical reader.

Parameters: stateful (bool) –
Return type: eth_defi.vault.base.VaultHistoricalReader

get_fee_data()

Return documented fund management fee where available.

Return type: eth_defi.vault.fee.FeeData

get_management_fee(block_identifier)

Return the documented annual fund management fee, if published.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) –
Return type: Optional[float]

get_performance_fee(block_identifier)

Return no documented performance fee.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) –
Return type: Optional[float]

get_estimated_lock_up()

Return no fixed lock-up because eligibility and terms are product-specific.

Return type: Optional[datetime.timedelta]

get_link(referral=None)

Return the official product page.

Parameters: referral (Optional[str]) –
Return type: str

property denomination_token: Optional[eth_defi.token.TokenDetails]

Get the token which denominates the vault valuation

Used in deposits and redemptions
Used in NAV calculation
Used in profit benchmarks
Usually USDC

Returns

Token wrapper instance.

Maybe None for broken vaults like https://arbiscan.io/address/0x9d0fbc852deccb7dcdd6cb224fa7561efda74411#code

Note

None results are not cached — the next access will retry the on-chain call. This avoids permanently caching a transient RPC failure.

property deposit_manager: eth_defi.vault.deposit_redeem.VaultDepositManager: Deposit manager assocaited with this vault

fetch_available_liquidity(block_identifier='latest')

Get the amount of denomination token available for immediate withdrawal.

Only applicable to lending protocol vaults (IPOR, Euler, Morpho, Gearbox, etc.). Non-lending protocols should leave this method unimplemented.

Note: maxRedeem(address(0)) does NOT work as a proxy for available liquidity because it requires a specific address that has already deposited shares. For address(0), balanceOf is always 0, so maxRedeem returns 0 regardless of actual liquidity.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Block to query. Defaults to “latest”.
Raises: NotImplementedError – For non-lending protocol vaults.
Returns: Amount in denomination token units (human-readable Decimal).
Return type: Optional[decimal.Decimal]

fetch_deposit_next_open()

Get when deposits will next be open.

For epoch-based vaults (Ostium, D2), return calculated window open time
For non-epoch vaults (Plutus, IPOR, Morpho), return None
Override in protocol-specific subclasses

Returns

Naive UTC datetime when deposits will next be available, or None if:

Deposits are currently open
Timing is unpredictable (manually controlled)
Protocol does not support timing information

Return type

Optional[datetime.datetime]

fetch_redemption_next_open()

Get when withdrawals/redemptions will next be open.

For epoch-based vaults (Ostium, D2), return calculated window open time
For non-epoch vaults (Plutus, IPOR, Morpho), return None
Override in protocol-specific subclasses

Returns

Naive UTC datetime when withdrawals will next be available, or None if:

Withdrawals are currently open
Timing is unpredictable (manually controlled)
Protocol does not support timing information

Return type

Optional[datetime.datetime]

fetch_utilisation_percent(block_identifier='latest')

Get the percentage of assets currently lent out.

Only applicable to lending protocol vaults (IPOR, Euler, Morpho, Gearbox, etc.). Non-lending protocols should leave this method unimplemented.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Block to query. Defaults to “latest”.
Raises: NotImplementedError – For non-lending protocol vaults.
Returns: Utilisation as float between 0.0 and 1.0 (0% to 100%).
Return type: Optional[float]

property flow_manager: eth_defi.vault.base.VaultFlowManager: Flow manager associated with this vault

get_deposit_fee(block_identifier)

Deposit fee is set to zero by default as vaults usually do not have deposit fees.

Internal: Use get_fee_data().

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) –
Return type: Optional[float]

get_deposit_manager_capability()

Return static public transaction-adapter support, if any.

This method deliberately does not attempt to construct a manager or query live pause, cap, epoch, balance, allow-list, or liquidity state. Adapters opt in only after their complete deposit and redemption lifecycles have focused coverage. None is therefore the safe default for unknown and protocol-specific vaults.

Returns: Adapter-specific capability object, or None when unsupported.
Return type: Optional[eth_defi.vault.deposit_redeem.VaultDepositManagerCapability]

get_fee_mode()

Get how this vault accounts its fees.

Return type: Optional[eth_defi.vault.fee.VaultFeeMode]

get_flags()

Get various vault state flags from the smart contract.

Override to add status flags
Also add flags from our manual flag list in eth_defi.vault.flag

Returns

Flag set.

Do not modify in place.

Return type

set[eth_defi.vault.flag.VaultFlag]

get_notes()

Get a human readable message if we know somethign special is going on with this vault.

Return type: Optional[str]

get_protocol_name()

Return the name of the vault protocol.

Return type: str

get_risk()

Get risk profile of this vault.

Return type: Optional[eth_defi.vault.risk.VaultTechnicalRisk]

get_withdraw_fee(block_identifier)

Withdraw fee is set to zero by default as vaults usually do not have withdraw fees.

Internal: Use get_fee_data().

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) –
Return type: float

has_custom_fees()

Does this vault have fees outside the shared fee model.

Custom fees cause risk in vault comparison because the shared management/performance/deposit/withdraw fee fields cannot describe the full fee structure.

Do not return True merely because a vault implements custom accessors for ordinary management, performance, deposit, or withdraw fees. Return True only when some vault fee cannot be reflected in those standard fields as a fee-like value.

Returns: True if the vault has fees outside the shared fee model.
Return type: bool

property info: eth_defi.vault.base.VaultInfo

Get info dictionary related to this vault deployment.

Get cached data on the various vault parameters

Returns: Vault protocol specific information dictionary

property share_token: eth_defi.token.TokenDetails

ERC-20 that presents vault shares.

User gets shares on deposit and burns them on redemption