WisdomTreeVault
Documentation for eth_defi.tokenised_fund.wisdomtree.vault.WisdomTreeVault Python class.
- class WisdomTreeVault
Bases:
eth_defi.vault.base.VaultBaseRead WTGXX supply and issuer-published NAV without public flow support.
Create a product adapter.
- Parameters
web3 – Ethereum Web3 connection.
spec – Chain and WTGXX token address.
token_cache – Optional ERC-20 metadata cache.
features – Routing features.
default_block_identifier – Retained shared-adapter setting.
require_denomination_token – Retained shared-adapter setting.
Attributes summary
Return the checksum share-token address.
Return the deployment chain id.
Get the token which denominates the vault valuation
Deposit manager assocaited with this vault
Return product description.
Flow manager associated with this vault
Get info dictionary related to this vault deployment.
Return the issuer and asset manager.
Return the token name with product fallback.
ERC-20 that presents vault shares.
Return concise product description.
Return the token symbol.
Return the scanner-compatible vault address.
Methods summary
__init__(web3, spec[, token_cache, ...])Create a product adapter.
fetch_available_liquidity([block_identifier])Get the amount of denomination token available for immediate withdrawal.
Return no denomination ERC-20 metadata.
Return no ERC-20 denomination token.
Explain why public deposits are unavailable.
Get when deposits will next be open.
Return adapter diagnostics.
fetch_nav([block_identifier])Return calculated tokenised-share NAV.
fetch_portfolio(universe[, block_identifier])Return no on-chain portfolio holdings.
Explain why public redemptions are unavailable.
Get when withdrawals/redemptions will next be open.
Return explicit read-only and NAV provenance diagnostics.
fetch_share_price([block_identifier])Fetch the issuer-published NAV matching an on-chain block.
fetch_share_price_at(timestamp)Return the latest official NAV on or before a timestamp.
Fetch WTGXX ERC-20 metadata.
fetch_share_token_address([block_identifier])Return the ERC-20 share token address.
fetch_total_assets([block_identifier])Calculate NAV from official share NAV and on-chain supply.
fetch_total_supply([block_identifier])Fetch total ERC-20 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.
Reject incomplete public subscription/redemption support.
Return static public transaction-adapter support, if any.
Return unknown lock-up duration.
Return the published fund expense ratio.
Get how this vault accounts its fees.
Get various vault state flags from the smart contract.
Reject incomplete public flow support.
get_historical_reader(stateful)Get the official-NAV historical reader.
get_link([referral])Return the official WTGXX page.
get_management_fee(block_identifier)Return the published annual expense ratio.
Get a human readable message if we know somethign special is going on with this vault.
get_performance_fee(block_identifier)Return the separate performance fee.
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.
Return whether flow-event accounting is implemented.
Does this vault have fees outside the shared fee model.
Return whether deposits are distributed on-chain.
- __init__(web3, spec, token_cache=None, features=None, default_block_identifier=None, require_denomination_token=False)
Create a product adapter.
- Parameters
web3 (web3.main.Web3) – Ethereum Web3 connection.
spec (eth_defi.vault.base.VaultSpec) – Chain and WTGXX token address.
token_cache (Optional[dict]) – Optional ERC-20 metadata cache.
features (Optional[set[eth_defi.erc_4626.core.ERC4626Feature]]) – Routing 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]]) – Retained shared-adapter setting.
require_denomination_token (bool) – Retained shared-adapter setting.
- property chain_id: int
Return the deployment 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 vault address.
- property name: str
Return the token name with product fallback.
- property symbol: str
Return the token symbol.
- property description: Optional[str]
Return product description.
- property short_description: Optional[str]
Return concise product description.
- property manager_name: Optional[str]
Return the issuer and asset manager.
- fetch_share_token_address(block_identifier='latest')
Return the ERC-20 share token address.
- fetch_share_token()
Fetch WTGXX ERC-20 metadata.
- Returns
Token details for WTGXX.
- Return type
- fetch_denomination_token_address()
Return no ERC-20 denomination token.
- Returns
Nonebecause subscriptions settle through WisdomTree.- Return type
- fetch_denomination_token()
Return no denomination ERC-20 metadata.
- Returns
Always
None.- Return type
- fetch_share_price_at(timestamp)
Return the latest official NAV on or before a timestamp.
- Parameters
timestamp (datetime.datetime) – Naive UTC target time.
- Returns
Official USD NAV per WTGXX share.
- Raises
RuntimeError – If no issuer NAV exists at the requested time.
- Return type
- fetch_share_price(block_identifier='latest')
Fetch the issuer-published NAV matching an on-chain block.
The WisdomTree API is date-based rather than block-based. Historical block reads therefore resolve the block timestamp before selecting the latest official NAV published on or before that time.
- Parameters
block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Block whose timestamp selects the NAV observation.
- Returns
Official NAV per share matching the requested block.
- Return type
- fetch_total_supply(block_identifier='latest')
Fetch total ERC-20 supply.
- fetch_total_assets(block_identifier='latest')
Calculate NAV from official share NAV and on-chain supply.
- fetch_nav(block_identifier='latest')
Return calculated tokenised-share NAV.
- fetch_info()
Return adapter diagnostics.
- Returns
Token and NAV-source metadata.
- Return type
eth_defi.tokenised_fund.wisdomtree.vault.WisdomTreeVaultInfo
- fetch_scan_record_extra_data()
Return explicit read-only and NAV provenance diagnostics.
- fetch_portfolio(universe, block_identifier=None)
Return no on-chain portfolio holdings.
- Parameters
universe (eth_defi.vault.base.TradingUniverse) – Ignored.
block_identifier (Optional[Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]]) – Ignored.
- Returns
Empty spot portfolio.
- Return type
- has_block_range_event_support()
Return whether flow-event accounting is implemented.
- Return type
- has_deposit_distribution_to_all_positions()
Return whether deposits are distributed on-chain.
- Return type
- get_flow_manager()
Reject incomplete public flow support.
- Raises
NotImplementedError – Always.
- Return type
- get_deposit_manager()
Reject incomplete public subscription/redemption support.
- Raises
NotImplementedError – Always.
- Return type
- fetch_deposit_closed_reason()
Explain why public deposits are unavailable.
- fetch_redemption_closed_reason()
Explain why public redemptions are unavailable.
- get_historical_reader(stateful)
Get the official-NAV historical reader.
- Parameters
stateful (bool) – Accepted shared-adapter setting.
- Returns
Historical reader.
- Return type
- get_fee_data()
Return the published fund expense ratio.
- Returns
Internalised annual expense representation.
- Return type
- get_management_fee(block_identifier)
Return the published annual expense ratio.
- get_performance_fee(block_identifier)
Return the separate performance fee.
- get_estimated_lock_up()
Return unknown lock-up duration.
- Returns
None.- Return type
- get_link(referral=None)
Return the official WTGXX 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_protocol_name()
Return the name of the vault protocol.
- Return type
- 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
- property share_token: eth_defi.token.TokenDetails
ERC-20 that presents vault shares.
User gets shares on deposit and burns them on redemption