Source code for helium_py.api.rewards

"""Rewards client for Helium Blockchain API."""

from typing import Optional

from .api import API
from .decorators import bucket_api, time_filterable_api


class Rewards(API):
    """Rewards client class for Helium Blockchain API.

    https://docs.helium.com/api/blockchain/rewards
    """

    base_path = 'rewards'

    @bucket_api
    @time_filterable_api
    def get_total(self, params: Optional[dict]) -> dict:
        """Return total network rewards for given bucket and time params."""
        return self.client.get(path='/sum', params=params)