UpshiftInstantRedeemConfig

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

class UpshiftInstantRedeemConfig

Bases: TypedDict

Instant-redemption configuration returned for a vault.

Example response: {"output_asset_symbol": "USDC", "is_paused": False, "available_liquidity": 1000000000000}.

Attributes summary

subaccount_address	Custody subaccount used for instant redemption.
output_asset_symbol	Asset paid to an instant redeemer.
is_paused	Whether instant redemption is paused.
available_liquidity	Raw available output-asset liquidity.
redeemable_assets	Assets that can be redeemed immediately.
id	Upshift instant-redemption configuration UUID.
tokenized_vault_id	Parent vault 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.

subaccount_address: str

Custody subaccount used for instant redemption. Example: "0x1E0e...B4b7".

output_asset_symbol: str

Asset paid to an instant redeemer. Example: "USDC".

is_paused: bool

Whether instant redemption is paused. Example: False.

available_liquidity: Union[int, float]

Raw available output-asset liquidity. Example: 1000000000000.

redeemable_assets: list[eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftInstantRedeemableAsset]

Assets that can be redeemed immediately. Example: one USCC record.

id: str

Upshift instant-redemption configuration UUID. Example: "373efcf4-29de-4c2d-a04c-36607a8a9b90".

tokenized_vault_id: str

Parent vault UUID. Example: "9ae0f5c3-ceb3-4e00-a476-334ccc2c7878".

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