tokenised_fund.ondo.vault
Documentation for eth_defi.tokenised_fund.ondo.vault Python module.
Read-only Ondo tokenised-fund adapter.
Ondo USDY and OUSG are permissioned ERC-20 share tokens, not ERC-4626 vaults. Their published NAV is supplied by separate issuer oracles.
Functions
|
Export Ondo's non-transferable USD accounting denomination. |
Classes
Read token supply and official on-chain NAV for Ondo funds. |
|
Ondo product and valuation metadata. |
- class OndoVaultInfo
Bases:
eth_defi.vault.base.VaultInfoOndo product and valuation metadata.
- __init__(*args, **kwargs)
- __new__(**kwargs)
- clear()
Remove all items from the dict.
- copy()
Return a shallow copy of the dict.
- fromkeys(value=None, /)
Create a new dictionary with keys from iterable and values set to value.
- get(key, default=None, /)
Return the value for key if key is in the dictionary, else default.
- items()
Return a set-like object providing a view on the dict’s items.
- keys()
Return a set-like object providing a view on the dict’s keys.
- pop(k[, d]) v, remove specified key and return the corresponding value.
If the key is not found, return the default if given; otherwise, raise a KeyError.
- popitem()
Remove and return a (key, value) pair as a 2-tuple.
Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.
- setdefault(key, default=None, /)
Insert key with a value of default if key is not in the dictionary.
Return the value for key if key is in the dictionary, else default.
- update([E, ]**F) None. Update D from mapping/iterable E and F.
If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
- values()
Return an object providing a view on the dict’s values.
- export_ondo_usd_denomination(chain_id)
Export Ondo’s non-transferable USD accounting denomination.
- class OndoVault
Bases:
eth_defi.vault.base.VaultBaseRead 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.
- __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 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.
Return the ERC-20 share-token address.
Fetch token metadata for the registered ERC-20 share token.
- Return type
- fetch_denomination_token_address()
Return no single ERC-20 denomination token for issuer fund NAV.
- Return type
- fetch_denomination_token()
Return no generic ERC-20 denomination token.
- Return type
- fetch_oracle_call()
Construct the canonical NAV call for the registered product.
- Return type
web3.contract.contract.ContractFunction
Fetch official USD NAV/share from the configured issuer oracle.
- fetch_total_supply(block_identifier='latest')
Fetch outstanding share-token supply.
- fetch_total_assets(block_identifier='latest')
Calculate USD NAV from share supply and issuer NAV/share.
Return USD NAV for the tokenised fund.
- fetch_info()
Export product and NAV-source metadata.
- Return type
- fetch_scan_record_extra_data()
Export scanner metadata for permissioning and NAV provenance.
- 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
- has_block_range_event_support()
Return
Falsebecause public fund-flow accounting is unsupported.- Return type
- has_deposit_distribution_to_all_positions()
Return
Falsebecause portfolio holdings are issuer-managed.- Return type
- get_flow_manager()
Reject unsupported generic flow accounting.
- Return type
- get_deposit_manager()
Reject public transaction management for permissioned issuer flows.
- fetch_deposit_closed_reason()
Explain why generic public subscriptions are unavailable.
- Return type
- fetch_redemption_closed_reason()
Explain why generic public redemptions are unavailable.
- Return type
- get_historical_reader(stateful)
Create the product’s supply-and-NAV historical reader.
- Parameters
stateful (bool) –
- Return type
- get_fee_data()
Return documented fund management fee where available.
- Return type
- get_management_fee(block_identifier)
Return the documented annual fund management fee, if published.
- get_performance_fee(block_identifier)
Return no documented performance fee.
- get_estimated_lock_up()
Return no fixed lock-up because eligibility and terms are product-specific.
- Return type
- get_link(referral=None)
Return the official product page.
- 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
Noneresults 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
- 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
- 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
- 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
- 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().
- 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.
Noneis therefore the safe default for unknown and protocol-specific vaults.- Returns
Adapter-specific capability object, or
Nonewhen unsupported.- Return type
Optional[eth_defi.vault.deposit_redeem.VaultDepositManagerCapability]
- get_fee_mode()
Get how this vault accounts its fees.
- Return type
- 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
- get_notes()
Get a human readable message if we know somethign special is going on with this vault.
- get_risk()
Get risk profile of this vault.
- Return type
- 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().
- 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
Truemerely because a vault implements custom accessors for ordinary management, performance, deposit, or withdraw fees. ReturnTrueonly when some vault fee cannot be reflected in those standard fields as a fee-like value.- Returns
Trueif the vault has fees outside the shared fee model.- Return type
- 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
ERC-20 that presents vault shares.
User gets shares on deposit and burns them on redemption