ShiftVault

Documentation for eth_defi.tokenised_fund.shift.vault.ShiftVault Python class.

class ShiftVault

Bases: eth_defi.tokenised_fund.vault.TokenisedFundVault

Read a published ShiftVault ERC-20 share contract.

ShiftVault calculates a share price from its TVL feed and mints fee shares to the fee collector. The public interface cannot complete a deposit or a withdrawal without the executor’s request approval and batch resolution, so transaction support remains fail-closed until the complete lifecycle is implemented and tested.

Create an address-scoped ShiftVault reader.

Parameters

web3 – EVM JSON-RPC connection for the reviewed deployment.
spec – Chain and ShiftVault share-token address.
token_cache – Shared ERC-20 metadata cache.
features – Shared classification flags, expected to include shift_like.
default_block_identifier – Optional default metadata block retained for factory compatibility.
require_denomination_token – Whether an unavailable base token is a hard error.

Raises

RuntimeError – If the chain/address is not in Shift’s reviewed registry.

Attributes summary

`address`	Return the checksummed ShiftVault share-token address.
`chain_id`	Return the ShiftVault EVM chain id.
`denomination_token`	Get the token which denominates the vault valuation
`deposit_manager`	Deposit manager assocaited with this vault
`description`	Return the curated strategy and lifecycle description.
`flow_manager`	Flow manager associated with this vault
`info`	Get info dictionary related to this vault deployment.
`manager_name`	Return Shift as the published vault operator.
`name`	Return the onchain share-token name with registry fallback.
`share_token`	ERC-20 that presents vault shares.
`shift_contract`	Return the minimal ShiftVault read interface bound to this vault.
`short_description`	Return the curated product-specific one-line description.
`symbol`	Return the onchain ShiftVault share-token symbol.
`tvl_feed_decimals`	Read the immutable TVL feed's decimal precision.
`vault_address`	Return the scanner-compatible vault identifier.
`whitelist_notes`	Optional qualification for the exported whitelist status.

Methods summary

`__init__`(web3, spec[, token_cache, ...])	Create an address-scoped ShiftVault reader.
`fetch_available_liquidity`([block_identifier])	Get the amount of denomination token available for immediate withdrawal.
`fetch_denomination_token`()	Fetch the underlying base ERC-20 metadata.
`fetch_denomination_token_address`()	Read the base ERC-20 used by ShiftVault.
`fetch_deposit_closed_reason`()	Explain why public deposit transactions are not advertised.
`fetch_deposit_next_open`()	Get when deposits will next be open.
`fetch_info`()	Read public ShiftVault configuration required by scanner consumers.
`fetch_minimum_deposit`([block_identifier])	Fetch a source-proven minimum deposit in decimal token units.
`fetch_minimum_redemption`([block_identifier])	Fetch a source-proven redemption minimum in decimal share units.
`fetch_nav`([block_identifier])	Return the ShiftVault TVL in base-token units.
`fetch_portfolio`(universe[, block_identifier])	Return no inferred ERC-20 portfolio.
`fetch_redemption_closed_reason`()	Explain why public redemption transactions are not advertised.
`fetch_redemption_next_open`()	Get when withdrawals/redemptions will next be open.
`fetch_scan_record_extra_data`()	Return Shift configuration that explains price and flow availability.
`fetch_share_price`([block_identifier])	Read the latest TVL-feed share price in base-token units.
`fetch_share_token`()	Fetch ERC-20 share-token metadata.
`fetch_share_token_address`([block_identifier])	Return the ERC-20 share-token address.
`fetch_total_assets`([block_identifier])	Calculate TVL from the TVL-feed share price and ERC-20 supply.
`fetch_total_supply`([block_identifier])	Read the outstanding ERC-20 share 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.
`get_deposit_manager`()	Return a manager that explicitly refuses public fund operations.
`get_deposit_manager_capability`()	Report explicit lack of public deposit and redemption support.
`get_estimated_lock_up`()	Read the configured withdrawal timelock.
`get_fee_data`()	Return Shift's live fee-share configuration.
`get_fee_mode`()	Get how this vault accounts its fees.
`get_flags`()	Return vault flags including the tokenised fund classification.
`get_flow_manager`()	Reject unimplemented Shift request-and-batch flow accounting.
`get_historical_reader`(stateful)	Return the ShiftVault share-price historical reader.
`get_link`([referral])	Return Shift's public application.
`get_management_fee`(block_identifier)	Read the annualised maintenance fee.
`get_notes`()	Get a human readable message if we know somethign special is going on with this vault.
`get_performance_fee`(block_identifier)	Read the performance fee rate.
`get_protocol_name`()	Return the name of the vault protocol.
`get_risk`()	Get risk profile of this vault.
`get_share_price_source`()	Return the source used for share-price observations.
`get_spec`()
`get_whitelist_notes`()	Return an export caveat for the vault-wide whitelist status.
`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 the request-and-batch event reader is implemented.
`has_custom_fees`()	Does this vault have fees outside the shared fee model.
`has_deposit_distribution_to_all_positions`()	Return whether adapter-level position distribution is implemented.
`is_account_whitelisted`(address)	Reject an unavailable individual allow-list lookup.
`is_whitelisted_deposit`()	Classify tokenised-fund subscriptions as permissioned.

__init__(web3, spec, token_cache=None, features=None, default_block_identifier=None, require_denomination_token=False)

Create an address-scoped ShiftVault reader.

Parameters

web3 (web3.main.Web3) – EVM JSON-RPC connection for the reviewed deployment.
spec (eth_defi.vault.base.VaultSpec) – Chain and ShiftVault share-token address.
token_cache (Optional[dict]) – Shared ERC-20 metadata cache.
features (Optional[set[eth_defi.erc_4626.core.ERC4626Feature]]) – Shared classification flags, expected to include shift_like.
default_block_identifier (Optional[Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]]) – Optional default metadata block retained for factory compatibility.
require_denomination_token (bool) – Whether an unavailable base token is a hard error.

Raises

RuntimeError – If the chain/address is not in Shift’s reviewed registry.

Return type

None

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

property address: eth_typing.evm.HexAddress: Return the checksummed ShiftVault share-token address.

property vault_address: eth_typing.evm.HexAddress: Return the scanner-compatible vault identifier.

property shift_contract: web3.contract.contract.Contract: Return the minimal ShiftVault read interface bound to this vault.

property tvl_feed_decimals: int

Read the immutable TVL feed’s decimal precision.

ShiftVault’s getSharePrice() result is scaled to this precision, which need not equal the deposit token’s decimals.

Returns: Decimal places used by getSharePrice().

property name: str: Return the onchain share-token name with registry fallback.

property symbol: str: Return the onchain ShiftVault share-token symbol.

property description: str: Return the curated strategy and lifecycle description.

property short_description: str: Return the curated product-specific one-line description.

property manager_name: str: Return Shift as the published vault operator.

fetch_share_token_address(block_identifier='latest')

Return the ERC-20 share-token address.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Retained for vault scanner compatibility.
Returns: This ShiftVault’s address.
Return type: eth_typing.evm.HexAddress

fetch_share_token()

Fetch ERC-20 share-token metadata.

Returns: ShiftVault ERC-20 share-token details.
Return type: eth_defi.token.TokenDetails

fetch_denomination_token_address()

Read the base ERC-20 used by ShiftVault.

Returns: Underlying deposit and withdrawal token address.
Return type: eth_typing.evm.HexAddress

fetch_denomination_token()

Fetch the underlying base ERC-20 metadata.

Returns: ShiftVault base-token details.
Return type: eth_defi.token.TokenDetails

fetch_share_price(block_identifier='latest')

Read the latest TVL-feed share price in base-token units.

Shift returns zero when the TVL feed is stale. The value otherwise uses the TVL feed’s decimal precision, as documented in ShiftVault.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Block number or tag at which to read the share price.
Returns: Base-token amount represented by one human-readable share.
Return type: decimal.Decimal

fetch_total_supply(block_identifier='latest')

Read the outstanding ERC-20 share supply.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Block number or tag at which to read the supply.
Returns: Human-readable share supply.
Return type: decimal.Decimal

fetch_total_assets(block_identifier='latest')

Calculate TVL from the TVL-feed share price and ERC-20 supply.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Block number or tag at which to calculate TVL.
Returns: Total assets in base-token units.
Return type: decimal.Decimal

fetch_nav(block_identifier='latest')

Return the ShiftVault TVL in base-token units.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Block number or tag at which to calculate NAV.
Returns: Total assets in base-token units.
Return type: decimal.Decimal

fetch_info()

Read public ShiftVault configuration required by scanner consumers.

Returns: Base token and public lifecycle configuration.
Return type: eth_defi.tokenised_fund.shift.vault.ShiftVaultInfo

fetch_scan_record_extra_data()

Return Shift configuration that explains price and flow availability.

Returns: Private scanner fields for the TVL-feed valuation and unsupported flow.
Return type: dict[str, object]

fetch_portfolio(universe, block_identifier=None)

Return no inferred ERC-20 portfolio.

Shift deposits are transferred to an executor address, rather than held in the share contract. The publicly listed executor is insufficient to reconstruct its cross-chain strategy positions safely.

Parameters

universe (eth_defi.vault.base.TradingUniverse) – Ignored because no complete portfolio is exposed.
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 no complete portfolio is exposed.

Returns

Empty portfolio.

Return type

eth_defi.vault.base.VaultPortfolio

has_block_range_event_support()

Return whether the request-and-batch event reader is implemented.

Returns: False until the complete Shift lifecycle reader exists.
Return type: bool

has_deposit_distribution_to_all_positions()

Return whether adapter-level position distribution is implemented.

Returns: False because executor positions are not reconstructed.
Return type: bool

get_flow_manager()

Reject unimplemented Shift request-and-batch flow accounting.

Raises: NotImplementedError – Always, until executor and cross-chain settlement flow accounting is implemented.
Return type: eth_defi.vault.base.VaultFlowManager

fetch_deposit_closed_reason()

Explain why public deposit transactions are not advertised.

Returns: Stable explanation of the unsupported request/approval lifecycle.
Return type: str

fetch_redemption_closed_reason()

Explain why public redemption transactions are not advertised.

Returns: Stable explanation of the unsupported batch/timelock lifecycle.
Return type: str

get_historical_reader(stateful)

Return the ShiftVault share-price historical reader.

Parameters: stateful (bool) – Whether adaptive reader state should be retained.
Returns: ShiftVault reader using getSharePrice() and totalSupply().
Return type: eth_defi.vault.base.VaultHistoricalReader

get_fee_data()

Return Shift’s live fee-share configuration.

Returns: Annual management and performance fees minted as share dilution.
Return type: eth_defi.vault.fee.FeeData

get_management_fee(block_identifier)

Read the annualised maintenance fee.

maintenanceFeePerSecond18pt is stored as an 18-decimal fractional rate per second and is minted to the fee collector as shares.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Block number or tag at which to read the fee.
Returns: Annual management fee as a fractional percent.
Return type: float

get_performance_fee(block_identifier)

Read the performance fee rate.

Parameters: block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Block number or tag at which to read the fee.
Returns: Performance fee as a fractional percent.
Return type: float

get_estimated_lock_up()

Read the configured withdrawal timelock.

Returns: Current withdrawal timelock, measured from a withdrawal request.
Return type: datetime.timedelta

is_account_whitelisted(address)

Reject an unavailable individual allow-list lookup.

Shift’s published implementation stores this mapping internally without a public getter, so no safe account-level read exists.

Parameters: address (eth_typing.evm.HexAddress) – Address whose membership was requested.
Raises: NotImplementedError – Always.
Return type: bool

get_link(referral=None)

Return Shift’s public application.

Parameters: referral (Optional[str]) – Ignored because Shift does not publish a referral route.
Returns: Shift application 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_minimum_deposit(block_identifier='latest')

Fetch a source-proven minimum deposit in decimal token units.

A None result 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 None when unknown.
Return type: Optional[decimal.Decimal]

fetch_minimum_redemption(block_identifier='latest')

Fetch a source-proven redemption minimum in decimal share units.

A None result 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 None when unknown.
Return type: Optional[decimal.Decimal]

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

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: eth_defi.tokenised_fund.vault.TokenisedFundDepositManager

get_deposit_manager_capability()

Report explicit lack of public deposit and redemption support.

Returns: A two-direction capability with both operations disabled.
Return type: 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()

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: 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_share_price_source()

Return the source used for share-price observations.

Vault integrations override this method when they expose a share price. Returning None distinguishes unsupported or unknown pricing from a known source classification.

Returns: Share-price source, or None when the adapter does not provide one.
Return type: Optional[eth_defi.vault.price_source.PriceSource]

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.

Returns: Export note, or None when the classification needs no caveat.
Return type: Optional[str]

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

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 True because tokenised-fund deposits are permissioned.
Return type: bool

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: 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.