GMXLiquidityVault

Documentation for eth_defi.gmx.vault.GMXLiquidityVault Python class.

class GMXLiquidityVault

Bases: eth_defi.gmx.vault.GMXVaultBase

One 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

`address`	Return the checksum GM or GLV share-token address.
`chain_id`	Return the EVM deployment chain.
`denomination_token`	Get the token which denominates the vault valuation
`deposit_manager`	Deposit manager assocaited with this vault
`description`	Human-readable vault strategy description.
`feature`	Select GLV multi-market handling.
`flow_manager`	Flow manager associated with this vault
`info`	Get info dictionary related to this vault deployment.
`manager_name`	Protocol-supplied vault manager or curator display name.
`name`	Return the onchain share-token name.
`product_type`	Protocol-native product kind.
`share_token`	ERC-20 that presents vault shares.
`short_description`	One-liner vault summary.
`symbol`	Return the onchain share-token symbol.
`synthetic_usd_denomination`	Whether NAV and historical total_assets already use synthetic USD units.
`vault_address`	Return the scanner-compatible share-token address.
`whitelist_notes`	Optional qualification for the exported whitelist status.

Methods summary

`__init__`(web3, spec[, token_cache, ...])	Create a GMX share-token adapter.
`fetch_available_liquidity`([block_identifier])	Get the amount of denomination token available for immediate withdrawal.
`fetch_denomination_token`()	Fetch native USDC metadata for the catalogue display denomination.
`fetch_denomination_token_address`()	Return native USDC as the catalogue display denomination.
`fetch_deposit_closed_reason`()	Get human-readable reason why deposits are closed.
`fetch_deposit_next_open`()	Get when deposits will next be open.
`fetch_deposit_open`()	Return unknown for enabled markets whose dynamic caps can still reject a deposit.
`fetch_info`()	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.
`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`()	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_share_token`()	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])	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 asynchronous transaction construction.
`get_deposit_manager_capability`()	Return static public transaction-adapter support, if any.
`get_estimated_lock_up`()	Return no fixed lock-up period.
`get_fee_data`()	Get fee data structure for this vault.
`get_fee_mode`()	Get how this vault accounts its fees.
`get_flags`()	Return GMX market-making and liquidity-provision flags.
`get_flow_manager`()	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_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.
`get_risk`()	Get risk profile of this vault.
`get_share_price_source`()	Return the source used for share-price observations.
`get_spec`()
`get_strategy_tags`()	Return the maintained classifications for this reviewed deployment.
`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.
`get_withdrawal_period`()	Describe GMX's asynchronous, keeper-executed redemption lifecycle.
`has_block_range_event_support`()	Return whether generic vault flow events are supported.
`has_custom_fees`()	Does this vault have fees outside the shared fee model.
`has_deposit_distribution_to_all_positions`()	Return whether generic automatic position distribution applies.
`is_account_whitelisted`(address)	Determine whether an account has completed the vault's KYC policy.
`is_whitelisted_deposit`()	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

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

property description: Optional[str]

Human-readable vault strategy description.

Fetched from protocol-specific offchain sources (e.g. Euler GitHub labels, Lagoon web app API)
Returns None if the protocol does not provide descriptions or the vault is not in the metadata source
Override in subclasses that support offchain metadata

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

Fetch native USDC metadata for the catalogue display denomination.

Return type: eth_defi.token.TokenDetails

fetch_denomination_token_address()

Return native USDC as the catalogue display denomination.

Return type: eth_typing.evm.HexAddress

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

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

Return unknown for enabled markets whose dynamic caps can still reject a deposit.

The catalogue synchroniser exports False when 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 unconditional True.

Returns: None until a per-market executable deposit quote is available.
Return type: Optional[bool]

fetch_info()

Return scanner-compatible GMX product metadata.

Return type: eth_defi.vault.base.VaultInfo

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_nav(block_identifier='latest')

Reject an isolated live NAV read outside the historical pipeline.

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

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

eth_defi.vault.base.VaultPortfolio

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

Export USDC display denomination and GMX product metadata.

Return type: dict[str, object]

fetch_share_price(block_identifier='latest')

Reject an isolated live share-price read outside the historical pipeline.

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

fetch_share_token()

Fetch GM or GLV ERC-20 metadata.

Return type: eth_defi.token.TokenDetails

fetch_share_token_address(block_identifier='latest')

Return the GM or GLV ERC-20 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]) –
Return type: eth_typing.evm.HexAddress

fetch_total_assets(block_identifier='latest')

Reject an isolated live TVL read outside the historical pipeline.

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

fetch_total_supply(block_identifier='latest')

Read decimal-scaled GM or GLV outstanding shares.

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

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

Reject unsupported asynchronous transaction construction.

Return type: eth_defi.vault.deposit_redeem.VaultDepositManager

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

Return no fixed lock-up period.

Return type: Optional[datetime.timedelta]

get_fee_data()

Get fee data structure for this vault.

Raises: ValueError – In the case of broken or unimplemented fee reading methods in the smart contract
Return type: eth_defi.vault.fee.FeeData

get_fee_mode()

Get how this vault accounts its fees.

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

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: set[eth_defi.vault.flag.VaultFlag]

get_flow_manager()

Reject unsupported generic flow accounting.

Return type: eth_defi.vault.base.VaultFlowManager

get_historical_reader(stateful)

Return the sparse GMX event reader.

Parameters: stateful (bool) –
Return type: eth_defi.vault.base.VaultHistoricalReader

get_link(referral=None)

Return the direct GMX pool-details page for this share token.

Both GM and GLV products use GMX’s market URL 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: str