Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bobthebuidler/ypricemagic
Fetch accurate prices for tokens solely using on-chain data.
https://github.com/bobthebuidler/ypricemagic
erc20-tokens ethereum-contract evm python python3 web3 web3py
Last synced: 1 day ago
JSON representation
Fetch accurate prices for tokens solely using on-chain data.
- Host: GitHub
- URL: https://github.com/bobthebuidler/ypricemagic
- Owner: BobTheBuidler
- License: mit
- Created: 2021-07-09T05:52:19.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-11T23:42:28.000Z (9 months ago)
- Last Synced: 2024-04-12T02:59:16.086Z (9 months ago)
- Topics: erc20-tokens, ethereum-contract, evm, python, python3, web3, web3py
- Language: Python
- Homepage: https://bobthebuidler.github.io/ypricemagic/
- Size: 6.08 MB
- Stars: 58
- Watchers: 3
- Forks: 19
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## Summary
Use this tool to extract historical on-chain price data from an archive node.
ypricemagic is built to work seamlessly with both sync and async Python codebases using the [ez-a-sync framework](https://github.com/BobTheBuidler/ez-a-sync).
## Installation
ypricemagic is published on [PyPI](https://pypi.org/). Simply install it just as you would any other library.
```
pip install ypricemagic
```
##### Known Issues:
Make sure you are using Python >= 3.8 and < 3.12
If you have a PyYaml Issue with 3.4.1 not installing due to an issue with cython, try the following:
```
pip install wheel
pip install --no-build-isolation "Cython<3" "pyyaml==5.4.1"
```
then try again:
```
pip install ypricemagic
```
## Network Configuration
ypricemagic utilizes the Brownie framework for Ethereum smart contract interactions. As such, it's essential that users configure a Brownie network to use their chosen RPC. Ensure you have access to an Ethereum node (e.g., through Infura or Alchemy) and add the provided API endpoint to your Brownie network configuration.
Refer to the [Brownie documentation on network management](https://eth-brownie.readthedocs.io/en/stable/network-management.html) for detailed guidance on setting up your networks. This setup is critical, as without it, ypricemagic will not be able to communicate with your RPC.
## Usage
There are 2 main entrypoints to ypricemagic,
[y.get_price](https://bobthebuidler.github.io/ypricemagic/source/y.html#y.get_price) and [y.get_prices](https://bobthebuidler.github.io/ypricemagic/source/y.html#y.get_prices).
```python
from y import get_price
price = get_price(token,block)
# OR
from y import get_prices
prices = get_prices(tokens, block)
```
You can also use ypricemagic asynchronously:
```python
price = await get_price(token, block, sync=False)
# OR
prices = await get_prices(tokens, block, sync=False)
```
See the [docs](https://bobthebuidler.github.io/ypricemagic) for more usage information.
## Extras
You can also import protocol specific modules. For example:
```python
from ypricemagic import uniswap
uniswap.get_price(token, block)
```
```python
from ypricemagic.compound import get_price
get_price(compoundToken, block)
```
These are not 'supported' per se and are subject to change at any time. But they can come in handy. The [not-very-organized docs site](https://bobthebuidler.github.io/ypricemagic) will be your friend here.
Enjoy!
### Shoutouts
Shoutout to [Banteg](https://github.com/banteg) [(@bantg)](https://twitter.com/bantg) and [nymmrx](https://github.com/nymmrx) [(@nymmrx)](https://twitter.com/nymmrx) for their awesome work on [yearn-exporter](https://github.com/yearn/yearn-exporter) that made this library possible.