WSTGBPVault

Documentation for eth_defi.wstgbp.vault.WSTGBPVault Python class.

class WSTGBPVault

Bases: eth_defi.vault.base.VaultBase

Scan-only adapter for Wren Staked tGBP contracts.

The wstGBP contract itself is the share token. It reports a WAD-scaled NAV/share and the actual asset used for minting and redemption. The adapter reads these values, but leaves generic transaction construction unsupported because the contract uses bespoke flows.

Create a Wren Staked tGBP vault adapter.

Parameters

web3 – Web3 connection.
spec – Chain and wstGBP token address.
token_cache – Token metadata cache used by fetch_erc20_details().
features – Shared pipeline feature flags. Expected to contain ERC4626Feature.wstgbp_like.
default_block_identifier – Default block for metadata reads.
require_denomination_token – Whether a failed gem() lookup should raise through VaultBase.denomination_token.

Attributes summary

`address`	Return the Wren Staked tGBP token and vault address.
`chain_id`	Return the EVM chain identifier.
`denomination_token`	Get the token which denominates the vault valuation
`deposit_manager`	Deposit manager assocaited with this vault
`description`	Return the product description.
`flow_manager`	Flow manager associated with this vault
`info`	Get info dictionary related to this vault deployment.
`manager_name`	Return the protocol display name.
`name`	Return the ERC-20 share token name.
`share_token`	ERC-20 that presents vault shares.
`short_description`	Return a listing-friendly product summary.
`symbol`	Return the ERC-20 share token symbol.
`vault_address`	Return the scanner compatibility vault-address alias.
`whitelist_notes`	Optional qualification for the exported whitelist status.
`wstgbp_contract`	Return the wstGBP contract interface.

Methods summary

`__init__`(web3, spec[, token_cache, ...])	Create a Wren Staked tGBP vault adapter.
`fetch_available_liquidity`([block_identifier])	Get the amount of denomination token available for immediate withdrawal.
`fetch_denomination_token`()	Fetch metadata for the wstGBP `gem()` token.
`fetch_denomination_token_address`()	Read the wstGBP purchase token through `gem()`.
`fetch_deposit_closed_reason`()	Get human-readable reason why deposits are closed.
`fetch_deposit_next_open`()	Get when deposits will next be open.
`fetch_info`()	Return Wren Staked tGBP metadata and NAV source.
`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 Wren Staked tGBP NAV.
`fetch_portfolio`(universe[, block_identifier])	Return an empty portfolio for the scan-only adapter.
`fetch_redemption_closed_reason`()	Get human-readable reason why redemptions are closed.
`fetch_redemption_next_open`()	Get when withdrawals/redemptions will next be open.
`fetch_scan_record_extra_data`()	Return Wren Staked tGBP-specific scanner diagnostics.
`fetch_share_price`([block_identifier])	Read Wren Staked tGBP NAV/share from `navprice()`.
`fetch_share_token`()	Fetch Wren Staked tGBP ERC-20 token metadata.
`fetch_share_token_address`([block_identifier])	Return the Wren Staked tGBP share-token address.
`fetch_total_assets`([block_identifier])	Calculate Wren Staked tGBP TVL from supply and NAV/share.
`fetch_total_supply`([block_identifier])	Read the outstanding Wren Staked tGBP share supply.
`fetch_utilisation_percent`([block_identifier])	Get the percentage of assets currently lent out.
`get_deposit_fee`(block_identifier)	Calculate the mint spread above NAV/share.
`get_deposit_manager`()	Reject generic Wren Staked tGBP transaction construction.
`get_deposit_manager_capability`()	Return static public transaction-adapter support, if any.
`get_estimated_lock_up`()	What is the estimated lock-up period for this vault.
`get_fee_data`()	Return current Wren Staked tGBP mint and redemption spread fees.
`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 generic Wren Staked tGBP flow accounting.
`get_historical_reader`(stateful)	Create a Wren Staked tGBP historical reader.
`get_link`([referral])	Return the Wren Staked tGBP homepage.
`get_management_fee`(block_identifier)	Return the unknown annual management fee.
`get_notes`()	Return the wstGBP product description for vault exports.
`get_performance_fee`(block_identifier)	Return the unknown performance fee.
`get_protocol_name`()	Return the name of the vault protocol.
`get_risk`()	Get risk profile of this vault.
`get_share_price_source`()	Return the Wren Staked tGBP NAV source classification.
`get_spec`()
`get_whitelist_notes`()	Return an export caveat for the vault-wide whitelist status.
`get_withdraw_fee`(block_identifier)	Calculate the redemption spread below NAV/share.
`has_block_range_event_support`()	Return whether standard vault-flow event reading is supported.
`has_custom_fees`()	Does this vault have fees outside the shared fee model.
`has_deposit_distribution_to_all_positions`()	Return whether deposits distribute directly to positions.
`is_account_whitelisted`(address)	Determine whether an account has completed the vault's KYC policy.
`is_whitelisted_deposit`()	Determine whether deposits require KYC or identity approval.

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

Create a Wren Staked tGBP vault adapter.

Parameters

web3 (web3.main.Web3) – Web3 connection.
spec (eth_defi.vault.base.VaultSpec) – Chain and wstGBP token address.
token_cache (Optional[dict]) – Token metadata cache used by fetch_erc20_details().
features (Optional[set[eth_defi.erc_4626.core.ERC4626Feature]]) – Shared pipeline feature flags. Expected to contain ERC4626Feature.wstgbp_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]]) – Default block for metadata reads.
require_denomination_token (bool) – Whether a failed gem() lookup should raise through VaultBase.denomination_token.

property chain_id: int

Return the EVM chain identifier.

Returns: Chain id associated with this deployment.

property address: eth_typing.evm.HexAddress

Return the Wren Staked tGBP token and vault address.

Returns: Checksummed wstGBP contract address.

property vault_address: eth_typing.evm.HexAddress

Return the scanner compatibility vault-address alias.

Returns: The wstGBP contract address.

property wstgbp_contract: web3.contract.contract.Contract

Return the wstGBP contract interface.

Returns: Contract bound to this asset’s primary address.

property name: str

Return the ERC-20 share token name.

Returns: Human-readable Wren Staked tGBP product name.

property symbol: str

Return the ERC-20 share token symbol.

Returns: Wren Staked tGBP share-token symbol.

property description: str

Return the product description.

Returns: Short explanation of the Wren Staked tGBP product shape.

property short_description: str

Return a listing-friendly product summary.

Returns: Short product description.

get_notes()

Return the wstGBP product description for vault exports.

Unlike manual vault notes, this description applies to the sole Wren Staked tGBP deployment and is part of its native metadata.

Returns: Human-readable wstGBP product and redemption information.
Return type: str

property manager_name: str

Return the protocol display name.

Returns: Wren Staked tGBP protocol name.

fetch_share_token_address(block_identifier='latest')

Return the Wren Staked tGBP 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]) – Accepted for shared scanner compatibility.
Returns: wstGBP contract address.
Return type: eth_typing.evm.HexAddress

fetch_share_token()

Fetch Wren Staked tGBP ERC-20 token metadata.

Returns: Share token details.
Return type: eth_defi.token.TokenDetails

fetch_denomination_token_address()

Read the wstGBP purchase token through gem().

Returns: Checksummed ERC-20 token address used for minting and redemption.
Return type: eth_typing.evm.HexAddress

fetch_denomination_token()

Fetch metadata for the wstGBP gem() token.

Returns: Purchase and redemption token details.
Return type: eth_defi.token.TokenDetails

get_share_price_source()

Return the Wren Staked tGBP NAV source classification.

The adapter reads navprice() from the product contract at the requested block.

Returns: Smart-contract state source.
Return type: eth_defi.vault.price_source.PriceSource

fetch_share_price(block_identifier='latest')

Read Wren Staked tGBP NAV/share from navprice().

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: NAV of one share in the gem() denomination.
Return type: decimal.Decimal

fetch_total_supply(block_identifier='latest')

Read the outstanding Wren Staked tGBP 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]) – Historical block identifier.
Returns: Human-readable share supply.
Return type: decimal.Decimal

fetch_total_assets(block_identifier='latest')

Calculate Wren Staked tGBP TVL from supply and NAV/share.

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: TVL in the gem() denomination.
Return type: decimal.Decimal

fetch_nav(block_identifier='latest')

Return Wren Staked tGBP NAV.

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: TVL in the gem() denomination.
Return type: decimal.Decimal

fetch_info()

Return Wren Staked tGBP metadata and NAV source.

Returns: Onchain denomination token and NAV-source data.
Return type: eth_defi.wstgbp.vault.WSTGBPVaultInfo

fetch_scan_record_extra_data()

Return Wren Staked tGBP-specific scanner diagnostics.

Returns: NAV source and mint/redemption information.
Return type: dict[str, object]

fetch_portfolio(universe, block_identifier=None)

Return an empty portfolio for the scan-only adapter.

The Wren Staked tGBP contract can route surplus gem liquidity to its conduit, so its ERC-20 balance is not a canonical representation of the tokenised asset’s portfolio.

Parameters

universe (eth_defi.vault.base.TradingUniverse) – Ignored.
block_identifier (Optional[Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]]) – Ignored.

Returns

Empty spot portfolio.

Return type

eth_defi.vault.base.VaultPortfolio

has_block_range_event_support()

Return whether standard vault-flow event reading is supported.

Returns: False because Wren Staked tGBP uses bespoke lifecycle events.
Return type: bool

has_deposit_distribution_to_all_positions()

Return whether deposits distribute directly to positions.

Returns: False because the adapter does not model Wren Staked tGBP flows.
Return type: bool

get_flow_manager()

Reject generic Wren Staked tGBP flow accounting.

Raises: NotImplementedError – Wren Staked tGBP events are not currently mapped to generic flows.
Return type: eth_defi.vault.base.VaultFlowManager

get_deposit_manager()

Reject generic Wren Staked tGBP transaction construction.

Raises: NotImplementedError – The contract’s mint/redeem functions use bespoke transaction methods.
Return type: eth_defi.vault.deposit_redeem.VaultDepositManager

get_historical_reader(stateful)

Create a Wren Staked tGBP historical reader.

Parameters: stateful (bool) – Whether to attach adaptive reader state.
Returns: Historical reader for supply and NAV/share.
Return type: eth_defi.vault.base.VaultHistoricalReader

get_fee_data()

Return current Wren Staked tGBP mint and redemption spread fees.

Returns: Externalised entry and exit fees derived from onchain prices.
Return type: eth_defi.vault.fee.FeeData

get_management_fee(block_identifier)

Return the unknown annual 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 because no annual fee is exposed by the token surface.
Returns: None.
Return type: Optional[float]

get_performance_fee(block_identifier)

Return the unknown 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 because no performance fee is exposed by the token surface.
Returns: None.
Return type: Optional[float]

get_deposit_fee(block_identifier)

Calculate the mint spread above NAV/share.

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: Mint fee as a fraction, or None when NAV is zero.
Return type: Optional[float]

get_withdraw_fee(block_identifier)

Calculate the redemption spread below NAV/share.

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: Redemption fee as a fraction, or None when NAV is zero.
Return type: Optional[float]

get_link(referral=None)

Return the Wren Staked tGBP homepage.

Parameters: referral (Optional[str]) – Ignored because Wren Staked tGBP links do not use referral parameters.
Returns: Public wstGBP homepage 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_closed_reason()

Get human-readable reason why deposits are closed.

Override in protocol-specific subclasses
Default behaviour: assume deposits are always open (return None)

Returns

Human-readable string explaining why deposits are closed, or None if deposits are open.

Example reasons:

”Epoch redemption window closed (opens in 14h)”
”Vault paused by admin”
”Max deposit cap reached”
”Vault utilisation too high”

Return type

Optional[str]

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

Get human-readable reason why redemptions are closed.

Override in protocol-specific subclasses
Default behaviour: assume redemptions are always open (return None)

Returns

Human-readable string explaining why redemptions are closed, or None if redemptions are open.

Example reasons:

”Epoch funding phase in progress (opens in 2d 5h)”
”Vault paused by admin”
”Vault utilisation too high - insufficient liquidity”

Return type

Optional[str]

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

What is the estimated lock-up period for this vault.

Returns: None if not know
Return type: Optional[datetime.timedelta]

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_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_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]

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_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: True when the account has the required KYC/identity approval.
Raises: NotImplementedError – If the adapter cannot safely query account membership.
Return type: bool

is_whitelisted_deposit()

Determine whether deposits require KYC or identity approval.

Protocol adapters override this predicate only when the deployed contract version has verified implementation source or a canonical application ABI that proves a reliable vault-wide policy read. An explicitly documented operating assumption may also override it, but must set whitelist_notes so consumers can distinguish it from a source-proven result. True means the vault requires KYC or comparable manual identity approval; False means its policy is permissionless. An open date, lock-up, epoch, pause, cap, token balance, or other non-identity eligibility condition must not affect the result. A source-proven override requires a fixed-block adapter test for every supported implementation generation. An operating assumption requires a unit test that asserts both its classification and its caveat. This is independent of a caller’s current balance, allowance, pause state, capacity, and request lifecycle.

Returns: True when deposits require KYC/identity approval and False when they do not.
Raises: NotImplementedError – If the adapter cannot safely determine the policy.
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