Add aggregate_price_status which takes care of becoming stale #21
Conversation
pythclient/pythaccounts.py
Outdated
| @@ -501,6 +502,18 @@ def aggregate_price_confidence_interval(self) -> Optional[float]: | |||
| """the aggregate price confidence interval""" | |||
| return self.aggregate_price_info and self.aggregate_price_info.confidence_interval | |||
|
|
|||
| async def get_aggregate_price_status(self, commitment: str = SolanaCommitment.CONFIRMED) -> Optional[PythPriceStatus]: | |||
There was a problem hiding this comment.
I think it would be better to pass in the current slot as an argument. If someone has a list of accounts and they want to get the status of each one, it will be expensive to query the API for the current slot multiple times. Also, it means that they can't get the status of all the accounts at a single instant in time, because the API might return different slots each time it is queried.
There was a problem hiding this comment.
I agree, but on the other hand it'll become a bit harder for people to use it.
I might create another normal (not async) function for it.
There was a problem hiding this comment.
i think it would be reasonable to have a non-async version where the caller passes in the slot, and also an async version that calls the non-async version.
There was a problem hiding this comment.
I removed async entirely as I realized using the provided slot when object is created is more efficient.
|
Please read the updated description above. |
ali-bahjati
changed the title
Adds
aggregate_price_statusproperty in Price Account which returns the aggregate price status considering the latest fetch slot to make sure price is not stale.get_aggregate_price_status_with_slotis also added so users can give latest solana slot for checking that price is not stale.Additional Changes:
slotfield is renamed topub_slot:slotis used in other objects within the pyth client with a different meaning (fetch slot).pub_slotis also consistent with other clients.aggregate_priceandaggregate_price_confidence_intervalwill use status and return None if price is not available (status != trading). Comments have been added to guide how to get these values if needed regardless of availability. This is more consistent with our Rust client api and will prevent incautious users to rely on price if it's not available.get_commitment_slotis renamed toget_slotto be more consistent with the rest of its interface. Also the return type is updated.breakon ws update handling logic.