SecuritizeVault
Documentation for eth_defi.tokenised_fund.securitize.vault.SecuritizeVault Python class.
- class SecuritizeVault
Bases:
eth_defi.vault.base.VaultBaseScan-only adapter for Securitize DS Protocol tokenised securities.
The adapter reads share supply from the ERC-20-compatible token. BUIDL has an explicit one-USD NAV estimate; recognised variable-NAV funds read a reviewed RedStone on-chain push feed at the same archive block.
Create a Securitize DSToken adapter.
- Parameters
web3 – Web3 connection.
spec – Chain and DSToken address.
token_cache – ERC-20 token metadata cache.
features – Shared pipeline feature flags.
default_block_identifier – Default metadata block, retained for adapter compatibility.
require_denomination_token – Whether a missing ERC-20 denomination is an error.
Attributes summary
Return the DSToken contract address.
Return the EVM chain id.
Get the token which denominates the vault valuation
Deposit manager assocaited with this vault
Return a registered product description when available.
Flow manager associated with this vault
Get info dictionary related to this vault deployment.
Check whether this token is a supported BUIDL share class.
Return the known product issuer or protocol operator.
Return the token name.
Return the reviewed RedStone feed for this product.
Create the product's RedStone push-feed contract.
ERC-20 that presents vault shares.
Return a compact product description.
Return the DSToken symbol.
Return a scanner-compatible alias for the DSToken address.
Methods summary
__init__(web3, spec[, token_cache, ...])Create a Securitize DSToken adapter.
fetch_available_liquidity([block_identifier])Get the amount of denomination token available for immediate withdrawal.
Return no ERC-20 denomination token.
Return no ERC-20 denomination token.
Return why public subscriptions are unavailable.
Get when deposits will next be open.
Return Securitize product metadata.
fetch_nav([block_identifier])Return the estimated fund NAV.
fetch_portfolio(universe[, block_identifier])Return an empty portfolio for a tokenised fund.
Return why public redemptions are unavailable.
Get when withdrawals/redemptions will next be open.
Return scanner diagnostics for DSToken product assumptions.
fetch_share_price([block_identifier])Fetch the product NAV/share estimate.
Fetch DSToken ERC-20 metadata.
fetch_share_token_address([block_identifier])Return the DSToken address.
fetch_total_assets([block_identifier])Estimate TVL from DSToken supply and NAV/share.
fetch_total_supply([block_identifier])Fetch outstanding DSToken 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 unsupported active subscription and redemption.
Return static public transaction-adapter support, if any.
Return unknown product lock-up.
Return unknown product fee data.
Get how this vault accounts its fees.
Get various vault state flags from the smart contract.
Reject unsupported public flow management.
get_historical_reader(stateful)Create the DSToken historical reader.
get_link([referral])Return the appropriate product or protocol page.
get_management_fee(block_identifier)Return unknown management fee.
Get a human readable message if we know somethign special is going on with this vault.
get_performance_fee(block_identifier)Return unknown 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 public flow accounting is supported.
Does this vault have fees outside the shared fee model.
Return whether deposits distribute to on-chain positions.
- __init__(web3, spec, token_cache=None, features=None, default_block_identifier=None, require_denomination_token=False)
Create a Securitize DSToken adapter.
- Parameters
web3 (web3.main.Web3) – Web3 connection.
spec (eth_defi.vault.base.VaultSpec) – Chain and DSToken address.
features (Optional[set[eth_defi.erc_4626.core.ERC4626Feature]]) – Shared pipeline feature flags.
default_block_identifier (Optional[Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]]) – Default metadata block, retained for adapter compatibility.
require_denomination_token (bool) – Whether a missing ERC-20 denomination is an error.
- property chain_id: int
Return the EVM chain id.
- Returns
Chain id from the vault specification.
- property address: eth_typing.evm.HexAddress
Return the DSToken contract address.
- Returns
Checksum DSToken address.
- property vault_address: eth_typing.evm.HexAddress
Return a scanner-compatible alias for the DSToken address.
- Returns
DSToken address.
- property is_buidl: bool
Check whether this token is a supported BUIDL share class.
- Returns
Truefor a reviewed BUIDL deployment.
- property redstone_feed: Optional[eth_defi.tokenised_fund.securitize.redstone.RedstoneSecuritizeFeed]
Return the reviewed RedStone feed for this product.
- Returns
Feed configuration, or
Nonefor fixed-price and unpriced products.
- property redstone_feed_contract: Optional[web3.contract.contract.Contract]
Create the product’s RedStone push-feed contract.
- Returns
Chainlink-compatible feed contract, or
Nonewhen no reviewed feed is configured.
- property name: str
Return the token name.
- Returns
On-chain token name, registered product name or a DSToken fallback.
- property symbol: str
Return the DSToken symbol.
- Returns
On-chain token symbol.
- property description: Optional[str]
Return a registered product description when available.
- Returns
Product description or a DS Protocol fallback.
- property short_description: Optional[str]
Return a compact product description.
- Returns
Short product description.
- property manager_name: Optional[str]
Return the known product issuer or protocol operator.
- Returns
Registered fund manager, otherwise Securitize.
- fetch_share_token_address(block_identifier='latest')
Return the DSToken address.
- fetch_share_token()
Fetch DSToken ERC-20 metadata.
- Returns
Token details for the DSToken share token.
- Return type
- fetch_denomination_token_address()
Return no ERC-20 denomination token.
- Returns
Nonebecause DSToken product accounting is not ERC-4626.- Return type
- fetch_denomination_token()
Return no ERC-20 denomination token.
- Returns
Nonebecause product subscription assets are off-adapter.- Return type
- fetch_share_price(block_identifier='latest')
Fetch the product NAV/share estimate.
- Parameters
block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Historical or latest block identifier.
- Returns
Registered product NAV/share estimate.
- Raises
NotImplementedError – If the DSToken has no on-chain or static adapter NAV source.
- Return type
- fetch_total_supply(block_identifier='latest')
Fetch outstanding DSToken supply.
- fetch_total_assets(block_identifier='latest')
Estimate TVL from DSToken supply and NAV/share.
- fetch_nav(block_identifier='latest')
Return the estimated fund NAV.
- fetch_info()
Return Securitize product metadata.
- Returns
Token, chain and NAV source metadata.
- Return type
eth_defi.tokenised_fund.securitize.vault.SecuritizeVaultInfo
- fetch_scan_record_extra_data()
Return scanner diagnostics for DSToken product assumptions.
- fetch_portfolio(universe, block_identifier=None)
Return an empty portfolio for a tokenised fund.
- Parameters
universe (eth_defi.vault.base.TradingUniverse) – Ignored because fund assets are off-chain.
block_identifier (Optional[Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]]) – Ignored because fund assets are off-chain.
- Returns
Empty spot portfolio.
- Return type
- has_block_range_event_support()
Return whether public flow accounting is supported.
- Returns
Falsebecause DSToken issuance is permissioned.- Return type
- has_deposit_distribution_to_all_positions()
Return whether deposits distribute to on-chain positions.
- Returns
Falsebecause DSTokens do not expose a vault portfolio.- Return type
- get_flow_manager()
Reject unsupported public flow management.
- Raises
NotImplementedError – Always, because DSToken flows are permissioned.
- Return type
- get_deposit_manager()
Reject unsupported active subscription and redemption.
- Raises
NotImplementedError – Always, because DSToken flows are permissioned.
- Return type
- fetch_deposit_closed_reason()
Return why public subscriptions are unavailable.
- fetch_redemption_closed_reason()
Return why public redemptions are unavailable.
- get_historical_reader(stateful)
Create the DSToken historical reader.
- Parameters
stateful (bool) – Whether to attach adaptive reader state.
- Returns
DSToken historical reader.
- Return type
- get_fee_data()
Return unknown product fee data.
- Returns
Unknown fee data because DSToken does not contain fund fees.
- Return type
- get_management_fee(block_identifier)
Return unknown management fee.
- get_performance_fee(block_identifier)
Return unknown performance fee.
- get_estimated_lock_up()
Return unknown product lock-up.
- Returns
Nonebecause redemption terms are product-specific.- Return type
- get_link(referral=None)
Return the appropriate product or protocol 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
- first_seen_at_block: Optional[int]
Block number hint when this vault was deployed.
Must be set externally, as because of shitty Ethereum RPC we cannot query this. Allows us to avoid unnecessary work when scanning historical price data.