SygnumVault

Documentation for eth_defi.tokenised_fund.sygnum.vault.SygnumVault Python class.

class SygnumVault

Bases: eth_defi.vault.base.VaultBase

Scan-only adapter for reviewed Sygnum FILQ share classes.

The public token surface provides ERC-20 supply and price-feed metadata, but not a publicly readable, verified historical NAV. Public dealing flows are deliberately 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 VaultBase compatibility.

Attributes summary

`address`	Return the checksum FILQ share-token address.
`chain_id`	Return the configured EVM chain id.
`denomination_token`	Get the token which denominates the vault valuation
`deposit_manager`	Deposit manager assocaited with this vault
`description`	Return a plain-language product description.
`flow_manager`	Flow manager associated with this vault
`info`	Get info dictionary related to this vault deployment.
`manager_name`	Return the tokenisation platform and settlement operator.
`name`	Return the on-chain FILQ class name.
`nav_unavailable_reason`
`share_token`	ERC-20 that presents vault shares.
`short_description`	Return the compact listing description.
`symbol`	Return the on-chain FILQ class symbol.
`vault_address`	Return the scanner-compatible share-token address.

Methods summary

`__init__`(web3, spec[, token_cache, ...])	Create a FILQ adapter.
`fetch_available_liquidity`([block_identifier])	Get the amount of denomination token available for immediate withdrawal.
`fetch_denomination_token`()	Return no transferable denomination token.
`fetch_denomination_token_address`()	Return no ERC-20 asset because FILQ is not ERC-4626.
`fetch_deposit_closed_reason`()	Return why public subscription is unavailable.
`fetch_deposit_next_open`()	Get when deposits will next be open.
`fetch_info`()	Return conservative FILQ scan metadata.
`fetch_nav`([block_identifier])	Reject NAV calculation without a verified price source.
`fetch_portfolio`(universe[, block_identifier])	Return no on-chain asset portfolio for the off-chain fund.
`fetch_redemption_closed_reason`()	Return why public redemption is unavailable.
`fetch_redemption_next_open`()	Get when withdrawals/redemptions will next be open.
`fetch_scan_record_extra_data`()	Export explicit restrictions and price-data diagnostics.
`fetch_share_price`([block_identifier])	Reject unavailable NAV reads rather than returning a synthetic price.
`fetch_share_token`()	Fetch FILQ ERC-20 metadata.
`fetch_share_token_address`([block_identifier])	Return the FILQ ERC-20 address.
`fetch_total_assets`([block_identifier])	Reject TVL calculation without a verified NAV.
`fetch_total_supply`([block_identifier])	Read outstanding FILQ shares.
`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.
`get_deposit_manager`()	Reject unsupported public subscription/redemption flows.
`get_deposit_manager_capability`()	Return static public transaction-adapter support, if any.
`get_estimated_lock_up`()	Return unknown dealing lock-up.
`get_fee_data`()	Return unknown fee data because the token has no fee surface.
`get_fee_mode`()	Get how this vault accounts its fees.
`get_flags`()	Get various vault state flags from the smart contract.
`get_flow_manager`()	Reject unsupported public flow accounting.
`get_historical_reader`(stateful)	Create a supply-only historical reader.
`get_link`([referral])	Return the official FILQ product page.
`get_management_fee`(block_identifier)	Return unknown product management fee.
`get_notes`()	Get a human readable message if we know somethign special is going on with this vault.
`get_performance_fee`(block_identifier)	Return unknown product performance fee.
`get_protocol_name`()	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.
`has_block_range_event_support`()	Return whether public flow accounting is supported.
`has_custom_fees`()	Does this vault have fees outside the shared fee model.
`has_deposit_distribution_to_all_positions`()	Return whether ERC-4626 position distribution is supported.

__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.
token_cache (Optional[dict]) – Shared token metadata cache.
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 VaultBase compatibility.

property chain_id: int: Return the configured EVM chain id.

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 name: str: Return the on-chain FILQ class name.

property symbol: str: Return the on-chain FILQ class symbol.

property description: Optional[str]: Return a plain-language product description.

property short_description: Optional[str]: Return the compact listing description.

property manager_name: Optional[str]: Return the tokenisation platform and settlement operator.

fetch_share_token_address(block_identifier='latest')

Return the FILQ ERC-20 address.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Ignored compatibility parameter.
Returns: Share-token address.
Return type: eth_typing.evm.HexAddress

fetch_share_token()

Fetch FILQ ERC-20 metadata.

Returns: Token details for the share class.
Return type: eth_defi.token.TokenDetails

fetch_denomination_token_address()

Return no ERC-20 asset because FILQ is not ERC-4626.

Returns: Always None.
Return type: Optional[eth_typing.evm.HexAddress]

fetch_denomination_token()

Return no transferable denomination token.

Returns: Always None.
Return type: Optional[eth_defi.token.TokenDetails]

fetch_total_supply(block_identifier='latest')

Read outstanding FILQ shares.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Historical block identifier.
Returns: Decimal-scaled total supply.
Return type: decimal.Decimal

fetch_share_price(block_identifier='latest')

Reject unavailable NAV reads rather than returning a synthetic price.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Requested block identifier.
Raises: RuntimeError – Always, until a public, verified NAV route exists.
Return type: decimal.Decimal

fetch_total_assets(block_identifier='latest')

Reject TVL calculation without a verified NAV.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Requested block identifier.
Raises: RuntimeError – Always, because NAV is unavailable.
Return type: decimal.Decimal

fetch_nav(block_identifier='latest')

Reject NAV calculation without a verified price source.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Requested block identifier.
Raises: RuntimeError – Always, because NAV is unavailable.
Return type: decimal.Decimal

fetch_info()

Return conservative FILQ scan metadata.

Returns: Token, chain and NAV-availability metadata.
Return type: eth_defi.tokenised_fund.sygnum.vault.SygnumVaultInfo

fetch_scan_record_extra_data()

Export explicit restrictions and price-data diagnostics.

Returns: Private scan columns.
Return type: dict[str, object]

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

eth_defi.vault.base.VaultPortfolio

has_block_range_event_support()

Return whether public flow accounting is supported.

Return type: bool

has_deposit_distribution_to_all_positions()

Return whether ERC-4626 position distribution is supported.

Return type: bool

get_flow_manager()

Reject unsupported public flow accounting.

Raises: NotImplementedError – Always.
Return type: eth_defi.vault.base.VaultFlowManager

get_deposit_manager()

Reject unsupported public subscription/redemption flows.

Raises: NotImplementedError – Always.
Return type: eth_defi.vault.deposit_redeem.VaultDepositManager

fetch_deposit_closed_reason()

Return why public subscription is unavailable.

Return type: Optional[str]

fetch_redemption_closed_reason()

Return why public redemption is unavailable.

Return type: Optional[str]

get_historical_reader(stateful)

Create a supply-only historical reader.

Parameters: stateful (bool) – Retained for reader compatibility.
Returns: FILQ supply-only reader.
Return type: eth_defi.vault.base.VaultHistoricalReader

get_fee_data()

Return unknown fee data because the token has no fee surface.

Returns: Broken fee-data sentinel.
Return type: eth_defi.vault.fee.FeeData

get_management_fee(block_identifier)

Return unknown product management fee.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Ignored block identifier.
Returns: None.
Return type: Optional[float]

get_performance_fee(block_identifier)

Return unknown product performance fee.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Ignored block identifier.
Returns: None.
Return type: Optional[float]

get_estimated_lock_up()

Return unknown dealing lock-up.

Returns: None.
Return type: Optional[datetime.timedelta]

get_link(referral=None)

Return the official FILQ product page.

Parameters: referral (Optional[str]) – Ignored referral.
Returns: Official FILQ URL.
Return type: str

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

None results 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: Optional[decimal.Decimal]

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

Optional[datetime.datetime]

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

Optional[datetime.datetime]

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: Optional[float]

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().

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) –
Return type: Optional[float]

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. None is therefore the safe default for unknown and protocol-specific vaults.

Returns: Adapter-specific capability object, or None when unsupported.
Return type: Optional[eth_defi.vault.deposit_redeem.VaultDepositManagerCapability]

get_fee_mode()

Get how this vault accounts its fees.

Return type: Optional[eth_defi.vault.fee.VaultFeeMode]

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

set[eth_defi.vault.flag.VaultFlag]

get_notes()

Get a human readable message if we know somethign special is going on with this vault.

Return type: Optional[str]

get_protocol_name()

Return the name of the vault protocol.

Return type: str

get_risk()

Get risk profile of this vault.

Return type: Optional[eth_defi.vault.risk.VaultTechnicalRisk]

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().

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) –
Return type: float

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 True merely because a vault implements custom accessors for ordinary management, performance, deposit, or withdraw fees. Return True only when some vault fee cannot be reflected in those standard fields as a fee-like value.

Returns: True if the vault has fees outside the shared fee model.
Return type: bool

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