UpshiftComposabilityIntegration

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

class UpshiftComposabilityIntegration

Bases: TypedDict

External protocol integration for an Upshift receipt token.

Example response: {"name": "Uniswap", "earning_multiplier": 0.0, "description": "Provide liquidity to UniswapV4 AUSD-earnAUSD 0.01%"}.

Attributes summary

name	Integrated protocol name.
description	Human-readable integration description.
earning_multiplier	Additional earning multiplier.
protocol_url	External protocol URL.
logo_url	External protocol logo URL.
tokenized_vault_id	Parent vault UUID.
id	Integration UUID.

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.

name: str

Integrated protocol name. Example: "Uniswap".

description: Optional[str]

Human-readable integration description. Example: "Provide liquidity to UniswapV4 AUSD-earnAUSD 0.01%".

earning_multiplier: float

Additional earning multiplier. Example: 0.0.

protocol_url: Optional[str]

External protocol URL. Example: "https://app.merkl.xyz/opportunities/...".

logo_url: Optional[str]

External protocol logo URL. Example: "https://upload.wikimedia.org/.../Uniswap_Logo.svg.png".

tokenized_vault_id: str

Parent vault UUID. Example: "672db4d8-72cd-46cb-bde3-746d1dd973a8".

id: str

Integration UUID. Example: "1f0bddff-84da-4b08-b528-daafb17d8ec9".

__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.