DeriveV3Vault
Documentation for eth_defi.derive.v3_vaults.DeriveV3Vault Python class.
- class DeriveV3Vault
Bases:
objectOne public native vault record.
The vault subaccount ID is unique only within the chosen Derive v3 deployment. Monetary values are decimal strings in the source API.
Attributes summary
Native vault subaccount ID.
Curator-supplied display name.
Curator-supplied strategy description.
Curator wallet address.
Derive spot asset address accepted for deposits.
Live mark-to-market NAV in USD, if priceable.
Live USD price per share, assuming accrued fees were settled now.
Outstanding native shares.
Annual management fee in basis points.
Performance fee in basis points.
Minimum holder withdrawal cooldown in seconds.
Whether deposits are limited to the vault whitelist.
Whether the vault has entered its terminal closed state.
Deposit currency symbol resolved from
public/get_all_currencies.Underlying ERC-20 decimal count, when the spot asset provides one.
Complete source record, retained for future metadata fields.
Methods summary
__init__(subaccount_id, name, description, ...)from_api(value)Parse a public vault record without rounding decimal amounts.
- subaccount_id: int
Native vault subaccount ID.
- name: str
Curator-supplied display name.
- description: str
Curator-supplied strategy description.
- curator: eth_typing.evm.HexAddress
Curator wallet address.
- deposit_spot_asset: eth_typing.evm.HexAddress
Derive spot asset address accepted for deposits.
- nav_usd: Optional[decimal.Decimal]
Live mark-to-market NAV in USD, if priceable.
- share_price_usd: Optional[decimal.Decimal]
Live USD price per share, assuming accrued fees were settled now.
- total_shares: decimal.Decimal
Outstanding native shares.
- management_fee_bps: int
Annual management fee in basis points.
- performance_fee_bps: int
Performance fee in basis points.
- cooldown_sec: int
Minimum holder withdrawal cooldown in seconds.
- whitelist_only: bool
Whether deposits are limited to the vault whitelist.
- closed: bool
Whether the vault has entered its terminal closed state.
- deposit_symbol: Optional[str]
Deposit currency symbol resolved from
public/get_all_currencies.
- deposit_decimals: Optional[int]
Underlying ERC-20 decimal count, when the spot asset provides one.
- raw_metadata: Optional[dict]
Complete source record, retained for future metadata fields.
- classmethod from_api(value)
Parse a public vault record without rounding decimal amounts.
- Parameters
value (dict) –
Vaultobject frompublic/get_vaults.- Returns
Parsed vault metadata.
- Return type
- __init__(subaccount_id, name, description, curator, deposit_spot_asset, nav_usd, share_price_usd, total_shares, management_fee_bps, performance_fee_bps, cooldown_sec, whitelist_only, closed, deposit_symbol=None, deposit_decimals=None, raw_metadata=None)
- Parameters
subaccount_id (int) –
name (str) –
description (str) –
curator (eth_typing.evm.HexAddress) –
deposit_spot_asset (eth_typing.evm.HexAddress) –
nav_usd (Optional[decimal.Decimal]) –
share_price_usd (Optional[decimal.Decimal]) –
total_shares (decimal.Decimal) –
management_fee_bps (int) –
performance_fee_bps (int) –
cooldown_sec (int) –
whitelist_only (bool) –
closed (bool) –
- Return type
None