tokenised_fund.sygnum.vault
Documentation for eth_defi.tokenised_fund.sygnum.vault Python module.
Read-only adapter for Sygnum Desygnate FILQ fund shares.
FILQ is a permissioned SygToken ERC-20, not an ERC-4626 vault. Authoritative sources: https://www.sygnum.com/filq/ and the exact verified implementation https://sourcify.dev/server/v2/contract/1/0x7030fe438be6ed196b8886616bbf5a245c267339?fields=all.
NAV/share is published by Chainlink bundle feeds. Their accepted reports are
available as BundleReportUpdated events from the shared DataFeedsCache.
Functions
|
Export non-transferable USD accounting metadata. |
Classes
Read-only adapter for reviewed Sygnum FILQ share classes. |
|
FILQ scan metadata. |
- class SygnumVaultInfo
Bases:
eth_defi.vault.base.VaultInfoFILQ scan 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_sygnum_usd_denomination(chain_id)
Export non-transferable USD accounting metadata.
- class SygnumVault
Bases:
eth_defi.tokenised_fund.vault.TokenisedFundVaultRead-only adapter for reviewed Sygnum FILQ share classes.
ERC-20 supply is combined with the reviewed FILQ Chainlink bundle NAV. Public dealing flows remain unavailable because every transfer and settlement is subject to the Sygnum permission manager.
Create a FILQ adapter.
- Parameters
web3 – Web3 connection to Ethereum.
spec – Chain and FILQ share-token address.
token_cache – Shared token metadata cache.
features – Classification flags.
default_block_identifier – Default metadata block.
require_denomination_token – Retained for
VaultBasecompatibility.
- __init__(web3, spec, token_cache=None, features=None, default_block_identifier=None, require_denomination_token=False)
Create a FILQ adapter.
- Parameters
web3 (web3.main.Web3) – Web3 connection to Ethereum.
spec (eth_defi.vault.base.VaultSpec) – Chain and FILQ share-token address.
features (Optional[set[eth_defi.erc_4626.core.ERC4626Feature]]) – Classification 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.
require_denomination_token (bool) – Retained for
VaultBasecompatibility.
- first_seen_at_block: int | None
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.
- property address: eth_typing.evm.HexAddress
Return the checksum FILQ share-token address.
- property vault_address: eth_typing.evm.HexAddress
Return the scanner-compatible share-token address.
- property price_feed_address: eth_typing.evm.HexAddress
Return the reviewed FILQ Chainlink bundle proxy address.
- property price_feed_contract: web3.contract.contract.Contract
Return the FILQ Chainlink bundle proxy contract.
Return the FILQ ERC-20 address.
Fetch FILQ ERC-20 metadata.
- Returns
Token details for the share class.
- Return type
- fetch_denomination_token_address()
Return no ERC-20 asset because FILQ is not ERC-4626.
- Returns
Always
None.- Return type
- fetch_denomination_token()
Return no transferable denomination token.
- Returns
Always
None.- Return type
- fetch_total_supply(block_identifier='latest')
Read outstanding FILQ shares.
Decode FILQ NAV/share from its reviewed bundle schema.
Both FILQ feeds place NAV in the second fixed-width word. FILQ-A uses four decimals and FILQ-D two decimals, as returned by their respective
bundleDecimals()methods.- Parameters
- Returns
USD NAV per FILQ share.
- Return type
- fetch_validated_bundle_decimals(block_identifier='latest')
Fetch and validate the FILQ bundle schema at a block.
Historical callers use the schema from the same block as the bundle instead of assuming that the proxy’s current layout applies to all earlier reports.
- Parameters
block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Current or historical Ethereum block.
- Returns
Reviewed decimal layout at
block_identifier.- Raises
ValueError – If the proxy implementation or decimals do not match the reviewed FILQ feed.
- Return type
Fetch FILQ NAV/share from the official Chainlink bundle feed.
- Parameters
block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Current or historical Ethereum block.
- Returns
USD NAV per FILQ share.
- Raises
ValueError – If the configured feed no longer matches the reviewed schema.
- Return type
- fetch_total_assets(block_identifier='latest')
Fetch FILQ TVL as outstanding supply multiplied by NAV/share.
Fetch total FILQ NAV.
- fetch_info()
Return conservative FILQ scan metadata.
- Returns
Token, chain and NAV-availability metadata.
- Return type
- fetch_scan_record_extra_data()
Export explicit restrictions and price-data diagnostics.
- fetch_portfolio(universe, block_identifier=None)
Return no on-chain asset portfolio for the off-chain fund.
- Parameters
universe (eth_defi.vault.base.TradingUniverse) – Ignored trading universe.
block_identifier (Optional[Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]]) – Ignored block identifier.
- Returns
Empty spot portfolio.
- Return type
- has_block_range_event_support()
Return whether public flow accounting is supported.
- Return type
- has_deposit_distribution_to_all_positions()
Return whether ERC-4626 position distribution is supported.
- Return type
- get_flow_manager()
Reject unsupported public flow accounting.
- Raises
NotImplementedError – Always.
- Return type
- fetch_deposit_closed_reason()
Return why public subscription is unavailable.
- fetch_redemption_closed_reason()
Return why public redemption is unavailable.
- get_historical_reader(stateful)
Create a bundle-priced historical reader.
- Parameters
stateful (bool) – Retained for reader compatibility.
- Returns
FILQ supply and Chainlink bundle NAV reader.
- Return type
- get_fee_data()
Return unknown fee data because the token has no fee surface.
- Returns
Broken fee-data sentinel.
- Return type
- get_management_fee(block_identifier)
Return unknown product management fee.
- get_performance_fee(block_identifier)
Return unknown product performance fee.
- get_estimated_lock_up()
Return unknown dealing lock-up.
- Returns
None.- Return type
- get_link(referral=None)
Return the official FILQ 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_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
Return the source used for share-price observations.
Vault integrations override this method when they expose a share price. Returning
Nonedistinguishes unsupported or unknown pricing from a known source classification.- Returns
Share-price source, or
Nonewhen the adapter does not provide one.- 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