JSONSerialisableReserveData

Documentation for eth_defi.aave_v3.reserve.JSONSerialisableReserveData Python class.

class JSONSerialisableReserveData

Bases: TypedDict

JSON friendly way to store Aave v3 protocol reserve status.

All ints are converted to JavaScript to avoid BigInt issues.

Note

This data is not useful until JavaScript based formatters from aave-utilities are applied. As writing of this, these formatters are only available as undocumented JavaScript code in this repository. See the repository for more information.

Attributes summary

`chain_id`	Which chain this was one
`block_number`	When this fetch was performed
`block_hash`	When this fetch was performed
`timestamp`	Unix timestamp when this fetch was performed
`reserves`	ERC-20 address -> reserve info mapping.
`base_currency_info`	Chainlink currency conversion multipliers needed by aave-utilities to convert values to USD/useful/human-readable

Methods summary

`__init__`(args, *kwargs)
`clear`()
`copy`()
`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`()
`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`()

chain_id: int: Which chain this was one

block_number: int: When this fetch was performed

block_hash: str: When this fetch was performed

timestamp: int: Unix timestamp when this fetch was performed

reserves: Dict[str, eth_defi.aave_v3.reserve.AggregatedReserveData]

ERC-20 address -> reserve info mapping.

All addresses are lowercased 0x strings

base_currency_info: eth_defi.aave_v3.reserve.BaseCurrencyInfo: Chainlink currency conversion multipliers needed by aave-utilities to convert values to USD/useful/human-readable

__init__(*args, **kwargs)

__new__(**kwargs)

clear() → None. Remove all items from D.

copy() → a shallow copy of D

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() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D'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() → an object providing a view on D's values