UpshiftReward

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

class UpshiftReward

Bases: TypedDict

Reward programme associated with an Upshift vault.

Example response: {"text": "Upshift Points", "multiplier": 5.0, "end_datetime": None}.

Attributes summary

tokenizedvault_id	Parent vault UUID.
created_at	Reward record creation timestamp.
id	Reward UUID.
img_url	Reward image URL.
start_datetime	Reward programme start timestamp.
updated_at	Reward record update timestamp.
text	Human-readable reward description.
multiplier	Reward multiplier.
end_datetime	Optional reward programme end timestamp.

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.

tokenizedvault_id: str

Parent vault UUID. Example: "5dd9319f-9f32-4bfe-a9cb-e12899f48ee0".

created_at: str

Reward record creation timestamp. Example: "2026-05-14T19:18:14.429000".

id: str

Reward UUID. Example: "2fe7671c-a857-4676-af72-8aad8ce47b82".

img_url: Optional[str]

Reward image URL. Example: "".

start_datetime: Optional[str]

Reward programme start timestamp. Example: "2026-05-03T20:00:00".

updated_at: str

Reward record update timestamp. Example: "2026-05-14T19:18:14.429000".

text: str

Human-readable reward description. Example: "Upshift Points".

multiplier: float

Reward multiplier. Example: 5.0.

end_datetime: Optional[str]

Optional reward programme end timestamp. Example: None.

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