tokenised_fund.securitize.vault
Documentation for eth_defi.tokenised_fund.securitize.vault Python module.
Securitize Digital Securities Protocol tokenised-fund adapter.
Module Attributes
Backwards-compatible aliases for the first registered Securitize product. |
|
Map executable Securitize NAV-source families to public classifications. |
Functions
|
Export synthetic USD denomination metadata. |
Classes
Scan-only adapter for Securitize DS Protocol tokenised securities. |
|
Securitize DSToken metadata exposed to scan consumers. |
- BUIDL_ETHEREUM_CHAIN_ID = 1
Backwards-compatible aliases for the first registered Securitize product.
- SECURITIZE_PRICE_SOURCE_PREFIXES: dict[str, eth_defi.vault.price_source.PriceSource] = {'chronicle_': PriceSource.chronicle, 'estimated_': PriceSource.fixed_price, 'redstone_': PriceSource.redstone}
Map executable Securitize NAV-source families to public classifications.
- class SecuritizeVaultInfo
Bases:
eth_defi.vault.base.VaultInfoSecuritize DSToken metadata exposed to scan consumers.
- token: eth_typing.evm.HexAddress
DSToken address.
NAV source identifier.
Whether NAV is estimated.
- __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_securitize_usd_denomination(chain_id)
Export synthetic USD denomination metadata.
- class SecuritizeVault
Bases:
eth_defi.tokenised_fund.vault.TokenisedFundVaultScan-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.
- __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.
Return the reviewed source configured for this Securitize product.
Source identifiers are mapped by family so newly reviewed RedStone, Chronicle or estimated products do not require address-specific branches in the adapter.
- Returns
Product price source, or
Nonewhen NAV is unconfigured.- Return type
- 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 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.
Return the DSToken address.
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 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.
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
- 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_minimum_deposit(block_identifier='latest')
Fetch a source-proven minimum deposit in decimal token units.
A
Noneresult means this adapter does not expose a known minimum; it does not prove the protocol accepts arbitrarily small deposits. A zero result means the adapter positively established that the vault has no minimum deposit.- Parameters
block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Block at which to read the protocol configuration.
- Returns
Decimal denomination-token minimum, or
Nonewhen unknown.- Return type
- fetch_minimum_redemption(block_identifier='latest')
Fetch a source-proven redemption minimum in decimal share units.
A
Noneresult means this adapter does not expose a known minimum; it does not prove the protocol accepts arbitrarily small redemptions. A zero result means the adapter positively established that the vault has no minimum redemption.- Parameters
block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Block at which to read the protocol configuration.
- Returns
Decimal vault-share minimum, or
Nonewhen unknown.- 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()
Return a manager that explicitly refuses public fund operations.
The manager gives runtime callers a typed refusal, while
get_deposit_manager_capability()provides the corresponding report metadata. Concrete issuer integrations must replace both only after implementing their complete permission-aware dealing lifecycle.- Returns
Non-operational tokenised-fund deposit manager.
- Return type
- get_deposit_manager_capability()
Report explicit lack of public deposit and redemption support.
- Returns
A two-direction capability with both operations disabled.
- Return type
- get_fee_mode()
Get how this vault accounts its fees.
- Return type
- get_flags()
Return vault flags including the tokenised fund classification.
Preserve address- and protocol-specific flags supplied by the generic vault implementation, then add the descriptive flag used by tokenised fund listings.
- Returns
A new set containing all generic flags and
VaultFlag.tokenised_fund.- 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_whitelist_notes()
Return an export caveat for the vault-wide whitelist status.
Adapters may attach a concise, stable explanation when a classification is an explicitly requested operating assumption or excludes an integration-specific permission mechanism. The note describes the policy classification only; it must not be used to report temporary deposit availability.
- 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
- is_account_whitelisted(address)
Determine whether an account has completed the vault’s KYC policy.
The result concerns KYC or manual identity-approval membership only. A protocol may still require scheduling, a token balance, an allowance, available capacity, or an open epoch before a deposit can be submitted. Callers must use the relevant deposit manager pre-flight before broadcasting a transaction.
- Parameters
address (eth_typing.evm.HexAddress) – Account whose deposit-policy membership is queried.
- Returns
Truewhen the account has the required KYC/identity approval.- Raises
NotImplementedError – If the adapter cannot safely query account membership.
- Return type
- is_whitelisted_deposit()
Classify tokenised-fund subscriptions as permissioned.
Tokenised-fund adapters model issuer-operated products whose subscriptions require investor eligibility, issuer approval, or both. This is a vault-wide classification: individual adapters may expose different KYC, allow-list, transfer-agent, or offchain settlement mechanisms, so
is_account_whitelisted()remains protocol-specific.- Returns
Always
Truebecause tokenised-fund deposits are permissioned.- Return type
ERC-20 that presents vault shares.
User gets shares on deposit and burns them on redemption