GMXLiquidityVault
Documentation for eth_defi.gmx.vault.GMXLiquidityVault Python class.
- class GMXLiquidityVault
Bases:
eth_defi.gmx.vault.GMXVaultBaseOne GMX V2 GLV multi-market liquidity-provider vault.
Create a GMX share-token adapter.
- Parameters
web3 – Arbitrum One or Avalanche connection.
spec – Chain and GM/GLV token address.
token_cache – Optional shared token metadata cache.
features – Persisted GMX product features. The adapter also adds its common AMM-pool and share-price-equivalence features.
default_block_identifier – Retained shared-adapter compatibility option.
require_denomination_token – Retained shared-adapter compatibility option.
Attributes summary
Return the checksum GM or GLV share-token address.
Return the EVM deployment chain.
Get the token which denominates the vault valuation
Deposit manager assocaited with this vault
Return the reviewed description of a known product.
Select GLV multi-market handling.
Flow manager associated with this vault
Get info dictionary related to this vault deployment.
Protocol-supplied vault manager or curator display name.
Return the onchain share-token name.
Protocol-native product kind.
redemption_recovery_max_fee_bpsExplicit execution authorisation for a public liquidity recovery step.
ERC-20 that presents vault shares.
Return the reviewed one-sentence summary of a known product.
Return the onchain share-token symbol.
synthetic_usd_denominationWhether NAV and historical total_assets already use synthetic USD units.
unsupported_protocol_reasonExplicit data-only integration decision; blocks new investment without RPC.
Return the scanner-compatible share-token address.
whitelist_notesOptional qualification for the exported whitelist status.
Methods summary
__init__(web3, spec[, token_cache, ...])Create a GMX share-token adapter.
fetch_available_liquidity([block_identifier])Read the adapter's available denomination-token liquidity.
Fetch native USDC metadata for the catalogue display denomination.
Return native USDC as the catalogue display denomination.
Get human-readable reason why deposits are closed.
Get when deposits will next be open.
Return unknown for enabled markets whose dynamic caps can still reject a deposit.
Return scanner-compatible GMX product metadata.
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])Reject an isolated live NAV read outside the historical pipeline.
fetch_portfolio(universe[, block_identifier])Return no generic spot portfolio for protocol-managed liquidity.
Get human-readable reason why redemptions are closed.
Get when withdrawals/redemptions will next be open.
Export USDC display denomination and GMX product metadata.
fetch_share_price([block_identifier])Reject an isolated live share-price read outside the historical pipeline.
Fetch GM or GLV ERC-20 metadata.
fetch_share_token_address([block_identifier])Return the GM or GLV ERC-20 token address.
fetch_total_assets([block_identifier])Reject an isolated live TVL read outside the historical pipeline.
fetch_total_supply([block_identifier])Read decimal-scaled GM or GLV outstanding shares.
fetch_utilisation_percent([block_identifier])Read the adapter's lending or capital-deployment utilisation.
get_deposit_fee(block_identifier)Deposit fee is set to zero by default as vaults usually do not have deposit fees.
Reject unsupported asynchronous transaction construction.
Return static public transaction-adapter support, if any.
Return no fixed lock-up period.
get_fee_data([block_identifier])Get fee data structure for this vault.
Get how this vault accounts its fees.
Return GMX market-making and liquidity-provision flags.
Reject unsupported generic flow accounting.
get_historical_reader(stateful)Return the sparse GMX event reader.
get_link([referral])Return the direct GMX pool-details page for this share token.
get_management_fee(block_identifier)Return the zero depositor-facing management fee.
Get a human readable message if we know somethign special is going on with this vault.
get_performance_fee(block_identifier)Return the zero depositor-facing performance fee.
Return the name of the vault protocol.
get_risk()Get risk profile of this vault.
Return the source used for share-price observations.
get_spec()Return the maintained classifications for this reviewed deployment.
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.
Describe GMX's asynchronous, keeper-executed redemption lifecycle.
Return whether generic vault flow events are supported.
Does this vault have fees outside the shared fee model.
Return whether generic automatic position distribution applies.
is_account_whitelisted(address)Determine whether an account has completed the vault's KYC policy.
is_permissionless(owner)Inspect the required deposit and exit route without investing capital.
Return whether GMX LP access is allowlisted.
- feature: ERC4626Feature = 'gmx_glv'
Select GLV multi-market handling.
- product_type: str = 'glv'
Protocol-native product kind.
- __init__(web3, spec, token_cache=None, features=None, default_block_identifier=None, require_denomination_token=False)
Create a GMX share-token adapter.
- Parameters
web3 (web3.main.Web3) – Arbitrum One or Avalanche connection.
spec (eth_defi.vault.base.VaultSpec) – Chain and GM/GLV token address.
token_cache (Optional[dict]) – Optional shared token metadata cache.
features (Optional[set[eth_defi.erc_4626.core.ERC4626Feature]]) – Persisted GMX product features. The adapter also adds its common AMM-pool and share-price-equivalence features.
default_block_identifier (Optional[Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]]) – Retained shared-adapter compatibility option.
require_denomination_token (bool) – Retained shared-adapter compatibility option.
- Return type
None
- property address: eth_typing.evm.HexAddress
Return the checksum GM or GLV share-token address.
- property chain_id: int
Return the EVM deployment chain.
- 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
- property description: Optional[str]
Return the reviewed description of a known product.
The catalogue synchroniser generates descriptions for all other products from their onchain composition, because this adapter cannot name index markets without the GMX token registry.
- Returns
Handwritten Markdown, or
Nonewhen the product has no reviewed copy.
- fetch_available_liquidity(block_identifier='latest')
Read the adapter’s available denomination-token liquidity.
Single-market adapters report market liquidity. Multi-market adapters such as Morpho and IPOR currently report idle vault assets, which can understate redeemable liquidity in their underlying markets. A user’s withdrawal can also be limited by share ownership or protocol restrictions. Non-lending adapters should leave this method unimplemented.
maxRedeem(address(0))cannot measure market-wide liquidity because ERC-4626 caps redemptions by the owner’s share balance. The zero address normally holds no shares, so a zero result says nothing about 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_denomination_token()
Fetch native USDC metadata for the catalogue display denomination.
- Return type
- fetch_denomination_token_address()
Return native USDC as the catalogue display denomination.
- Return type
- fetch_deposit_closed_reason()
Get human-readable reason why deposits are closed.
Override in protocol-specific subclasses
Default behaviour: no closure reason is known (return None)
- Returns
Human-readable string explaining why deposits are closed, or None if deposits are open or the adapter cannot determine a closure reason. Use
fetch_deposit_open()for explicit tri-state availability metadata.Example reasons:
”Epoch redemption window closed (opens in 14h)”
”Vault paused by admin”
”Max deposit cap reached”
”Vault utilisation too high”
- 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_deposit_open()
Return unknown for enabled markets whose dynamic caps can still reject a deposit.
The catalogue synchroniser exports
Falsewhen GMX disables a product. For enabled markets, a successful deposit can still depend on dynamic pool caps and the deposit PnL-factor limit, so the adapter must not report an unconditionalTrue.
- fetch_info()
Return scanner-compatible GMX product metadata.
- 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_nav(block_identifier='latest')
Reject an isolated live NAV read outside the historical pipeline.
- fetch_portfolio(universe, block_identifier=None)
Return no generic spot portfolio for protocol-managed liquidity.
- Parameters
universe (eth_defi.vault.base.TradingUniverse) –
block_identifier (Optional[Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]]) –
- Return type
- 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)
- 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_scan_record_extra_data()
Export USDC display denomination and GMX product metadata.
- fetch_share_price(block_identifier='latest')
Reject an isolated live share-price read outside the historical pipeline.
- fetch_share_token()
Fetch GM or GLV ERC-20 metadata.
- Return type
- fetch_share_token_address(block_identifier='latest')
Return the GM or GLV ERC-20 token address.
- fetch_total_assets(block_identifier='latest')
Reject an isolated live TVL read outside the historical pipeline.
- fetch_total_supply(block_identifier='latest')
Read decimal-scaled GM or GLV outstanding shares.
- fetch_utilisation_percent(block_identifier='latest')
Read the adapter’s lending or capital-deployment utilisation.
Single-market adapters measure borrower utilisation. Multi-market adapters such as Morpho and IPOR currently measure allocation outside the vault, rather than aggregate utilisation by underlying borrowers. Non-lending adapters 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()
Reject unsupported asynchronous transaction construction.
- 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.
Noneis therefore the safe default for unknown and protocol-specific vaults.- Returns
Adapter-specific capability object, or
Nonewhen unsupported.- Return type
Optional[eth_defi.vault.deposit_redeem.VaultDepositManagerCapability]
- get_estimated_lock_up()
Return no fixed lock-up period.
- Return type
- get_fee_data(block_identifier='latest')
Get fee data structure for this vault.
Component fee reads share the requested block. Existing no-argument callers retain latest-state behaviour.
- Parameters
block_identifier (Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, int]) – Common fee source block, default latest.
- Returns
Fee mode and component fractions.
- Raises
ValueError – In the case of broken or unimplemented fee reading methods in the smart contract
- Return type
- get_fee_mode()
Get how this vault accounts its fees.
- Return type
- get_flags()
Return GMX market-making and liquidity-provision flags.
GM and GLV holders provide the inventory against which GMX trading is settled. Their pool claim receives part of protocol fees and trader losses, and bears trader profits.
- Returns
Manual flags plus the two strategy classifications.
- Return type
- get_flow_manager()
Reject unsupported generic flow accounting.
- Return type
- get_historical_reader(stateful)
Return the sparse GMX event reader.
- Parameters
stateful (bool) –
- Return type
- get_link(referral=None)
Return the direct GMX pool-details page for this share token.
Both GM and GLV products use GMX’s
marketURL query parameter. The link includes the deployment chain so the GMX interface selects the correct network before resolving the product address.- Parameters
referral (Optional[str]) – Ignored because GMX’s pool-details route does not accept the common vault referral parameter.
- Returns
Direct GMX pool-details URL with the deposit view selected.
- Return type
See also
- get_management_fee(block_identifier)
Return the zero depositor-facing 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 the zero depositor-facing performance fee.
- get_protocol_name()
Return the name of the vault protocol.
- Return type
- get_risk()
Get risk profile of this vault.
- Return type
- get_share_price_source()
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_strategy_tags()
Return the maintained classifications for this reviewed deployment.
Only source-backed address entries are classified; an unreviewed deployment retains the explicit missing-information result.
- Returns
A fresh set of strategy tags, or
Nonewhen information is missing.- 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().
- get_withdrawal_period()
Describe GMX’s asynchronous, keeper-executed redemption lifecycle.
GMX liquidity withdrawals are submitted as requests and execute after a keeper supplies the required oracle prices. The official architecture documentation describes this as typically taking a few seconds, but the protocol does not provide a binding completion deadline: liquidity, oracle availability, gas prices and keeper execution can extend the wait. We therefore expose a one-minute non-binding estimate for the website while leaving the contractual minimum and maximum unset.
- Returns
Asynchronous withdrawal type with a one-minute settlement estimate.
- Return type
See also
- has_block_range_event_support()
Return whether generic vault flow events are supported.
- Return type
- 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
- has_deposit_distribution_to_all_positions()
Return whether generic automatic position distribution applies.
- 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, manual identity approval, or recipient allowlist 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 pre-approval.- Raises
NotImplementedError – If the adapter cannot safely query account membership.
- Return type
- is_permissionless(owner)
Inspect the required deposit and exit route without investing capital.
This opt-in policy check is independent of whether an admitted account can trade. Adapters must verify the complete route before returning true. Unsupported policy remains unknown; ordinary trading is unaffected.
- Parameters
owner (eth_typing.evm.HexAddress) – Intended asset sender, share owner and payout recipient.
- Returns
Whether the supported route is permissionless.
- Raises
NotImplementedError – If complete-route policy is not established.
- Return type
- is_whitelisted_deposit()
Return whether GMX LP access is allowlisted.
- Return type
- property manager_name: Optional[str]
Protocol-supplied vault manager or curator display name.
Used when the vault name itself does not contain the curator brand
Returns None if the protocol does not expose separate manager metadata
Override in subclasses that support manager or operator metadata
- property name: str
Return the onchain share-token name.
- property share_token: eth_defi.token.TokenDetails
ERC-20 that presents vault shares.
User gets shares on deposit and burns them on redemption
- property short_description: Optional[str]
Return the reviewed one-sentence summary of a known product.
- Returns
Handwritten plain text, or
Nonewhen the product has no reviewed copy.
- property symbol: str
Return the onchain share-token symbol.
- property vault_address: eth_typing.evm.HexAddress
Return the scanner-compatible share-token address.