UpshiftVaultMetadata

Documentation for eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftVaultMetadata Python class.

class UpshiftVaultMetadata

Bases: TypedDict

Normalised public metadata for one Upshift vault.

The data is sourced from GET /v1/tokenized_vaults/{address}. Upshift’s hardcoded_strategists identifies a strategy brand, not a curator role, so it is represented as strategist_names rather than mislabelled as curator data.

Reference:

• Upshift vault API documentation

Attributes summary

chain_id	EVM chain ID reported by Upshift.
vault_address	Checksummed vault contract address.
name	Display name configured in Upshift, if any.
description	Full strategy description configured in Upshift, if any.
strategist_names	Strategy brands from the API's hardcoded_strategists records.
operator_names	Human-readable names of EOA operator wallets.
status	Vault lifecycle status, such as "active" or "closed".
internal_type	Upshift implementation family, such as "multiAssetVault".
is_visible	Whether Upshift currently displays the vault in its frontend.

Methods summary

__init__(*args, **kwargs)
clear()	Remove all items from the dict.
copy()	Return a shallow copy of the dict.
fromkeys([value])	Create a new dictionary with keys from iterable and values set to value.
get(key[, default])	Return the value for key if key is in the dictionary, else default.
items()	Return a set-like object providing a view on the dict's items.
keys()	Return a set-like object providing a view on the dict's keys.
pop(k[,d])	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem()	Remove and return a (key, value) pair as a 2-tuple.
setdefault(key[, default])	Insert key with a value of default if key is not in the dictionary.
update([E, ]**F)	If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()	Return an object providing a view on the dict's values.

chain_id: int

EVM chain ID reported by Upshift.

vault_address: eth_typing.evm.HexAddress

Checksummed vault contract address.

name: Optional[str]

Display name configured in Upshift, if any.

description: Optional[str]

Full strategy description configured in Upshift, if any.

strategist_names: tuple[str, ...]

Strategy brands from the API’s hardcoded_strategists records.

operator_names: tuple[str, ...]

Human-readable names of EOA operator wallets.

status: Optional[str]

Vault lifecycle status, such as "active" or "closed".

internal_type: Optional[str]

Upshift implementation family, such as "multiAssetVault".

is_visible: Optional[bool]

Whether Upshift currently displays the vault in its frontend.

__init__(*args, **kwargs)

__new__(**kwargs)

clear()

Remove all items from the dict.

copy()

Return a shallow copy of the dict.

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items()

Return a set-like object providing a view on the dict’s items.

keys()

Return a set-like object providing a view on the dict’s keys.

pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()

Return an object providing a view on the dict’s values.