ethereum-gasprice 1.3.0
Tool for fetching actual gasprice in ethereum blockchain
License: MIT
Requires Python: >=3.7,<4.0
Keywords: ethereum,gasprice,web3,etherscan,ethgasstation

<p align="center">
  <a href="https://github.com/elastoo-team/ethereum-gasprice-py">
    <img src="https://raw.githubusercontent.com/elastoo-team/ethereum-gasprice-py/master/docs/_static/readme-logo.jpg">
  </a>
</p>


Ethereum gasprice: Actual gasprice for ethereum blockchain
=======================================

[![PyPI](https://img.shields.io/pypi/v/ethereum-gasprice)](https://pypi.org/project/ethereum-gasprice/)
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FElastoo-Team%2Fethereum-gasprice-py%2Fbadge&style=flat)](https://actions-badge.atrox.dev/Elastoo-Team/ethereum-gasprice-py/goto)
[![Documentation Status](https://readthedocs.org/projects/ethereum-gasprice/badge/?version=latest)](https://ethereum-gasprice.readthedocs.io/en/latest/?badge=latest)

Library for fetching actual ethereum blockchain gasprice from different sources:
[Etherscan Gas Tracker](https://etherscan.io/gastracker), [Eth Gas Station](https://ethgasstation.info/),
[Etherchain Gasprice Oracle](https://www.etherchain.org/tools/gasPriceOracle),
[Web3 RPC Method](https://web3py.readthedocs.io/en/stable/web3.eth.html#web3.eth.Eth.gasPrice).

Read more about gas and fee from [this article](https://ethereum.org/en/developers/docs/gas/)

# Installation

```bash
poetry add ethereum-gasprice
```

or

```bash
pip3 install ethereum-gasprice
```

# Quickstart

```python
from ethereum_gasprice import GaspriceController, GaspriceStrategy, EthereumUnit
from ethereum_gasprice.providers import EtherscanProvider

ETHERSCAN_API_KEY = "..."

# Pass api key to GaspriceController to initialize provider
controller = GaspriceController(
    settings={EtherscanProvider.title: ETHERSCAN_API_KEY},
)

# Get gasprice by one of these strategies:
gasprice = controller.get_gasprice_by_strategy(GaspriceStrategy.FAST)
print(gasprice)  # output: 69
```

# Docs

Read base API references and other part documentation
on [ethereum-gasprice.readthedocs.io](https://ethereum-gasprice.readthedocs.io/en/latest/)

# Usage

### Gasprice controller

Main entrypoint to fetching gasprice from providers. Has sync and async implementations.

It is recommended to initialize controller with `with ... as controller:` method

```python
from ethereum_gasprice import GaspriceController, AsyncGaspriceController
```

Parameters:

* `return_unit` - return gasprice in given ethereum unit. It is recommended to use `EthereumUnit` class
  from `ethereum_gasprice.consts` to choose unit
* `providers` - tuple of providers what will be used in fetching gasprice. Order of providers is important

- gasprice will be fetch in given priority. Providers must be a subclass of `BaseGaspriceProvider`

* `settings` - dict containing secrets for providers. Key is provider title slug, value is a secret for provider.

```python
from ethereum_gasprice.consts import EthereumUnit
from ethereum_gasprice.providers import (
    EtherscanProvider, EthGasStationProvider, AsyncEtherscanProvider, AsyncEthGasStationProvider
)

settings = {
    EtherscanProvider.title: "API_KEY",
    EthGasStationProvider.title: "API_KEY"
}

sync_providers = (EtherscanProvider, EthGasStationProvider)
async_providers = (AsyncEtherscanProvider, AsyncEthGasStationProvider)

with GaspriceStrategy(
        return_unit=EthereumUnit.GWEI,
        providers=sync_providers,
        settings=settings
) as controller:
    # Do something
    pass

async with AsyncGaspriceController(
        return_unit=EthereumUnit.WEI,
        providers=async_providers,
        settings=settings
) as async_controller:
    # Do something
    pass



```

Methods:

* `.get_gasprice_by_strategy()` - get gasprices from first available provider and return only one gasprice strategy.

available strategies: slow (`GaspriceStrategy.SLOW`), regular (`GaspriceStrategy.REGULAR`),
fast (`GaspriceStrategy.FAST`), fastest (`GaspriceStrategy.FASTEST`).

Some providers does not have info for some strategies. For example, Etherscan does not provide gasprice for slow
strategy.

In any case method will return dict with these for strategies. If fail case strategy (when all provides is unavailable)
dict with `None` values will be returned.

```python
from ethereum_gasprice.consts import GaspriceStrategy

gasprice = controller.get_gasprice_by_strategy(GaspriceStrategy.FAST)  # type: int, example: 69
```

* `.get_gasprices()` - gets gasprices for all strategies from first available provider. Returns a dict.

```python
gasprices = await async_controller.get_gasprices()  # type: dict
print(gasprices)

# {'slow': None, 'regular': 17, 'fast': 19, 'fastest': 20}
```

* `.get_gasprice_from_all_sources()` - get gasprices for all strategies from all available provider.

It can be useful to calculate an average gasprice value from all providers to get the most objective gasprice value.

```python

gasprices = controller.get_gasprice_from_all_sources()  # type: dict
print(gasprices)
# {
#   'etherscan': {'slow': None, 'regular': 17, 'fast': 19, 'fastest': 29},
#   'ethgasstation': {'slow': 16, 'regular': 17, 'fast': 19, 'fastest': 20}
# }

```

### Providers

Provider wrapper

```python
from ethereum_gasprice.providers import EtherscanProvider, AsyncEtherscanProvider
```

Parameters:

* `secret` - any secret or api key which will be used in request.
* `client` - sync or async [httpx Client instance](https://www.python-httpx.org/advanced/#client-instances). For async
  provider [httpx AsyncClient](https://www.python-httpx.org/async/) should be used.

Methods:

* `.request()` - make request to api, returns status and response data.
* `.get_gasprice()` - get gasprices from provider, returns gasprices in GWEI.

```python

from httpx import Client

provider = EtherscanProvider(
    secret="API-KEY",
    client=Client()
)
print(provider.get_gasprice())
# {'slow': None, 'regular': 17, 'fast': 19, 'fastest': 20}
```

# TODO

- [x] Initital release
- [x] Async implementation of controller, providers
- [x] Write documentation
- [ ] Write unit tests with pytest
- [ ] Integrate tests, docs and auto publishing to pypi in github pipeline

# Changelog

see CHANGELOG.md file

# License

Ethereum gasprice is licensed under the terms of the MIT License (see the file LICENSE).

# Special thanks

* [Artem Filippov](https://www.behance.net/filippowarfce4)