# The MIT License (MIT)
# Copyright © 2024 Opentensor Foundation
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
# documentation files (the “Software”), to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all copies or substantial portions of
# the Software.
#
# THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
# THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from abc import ABC, abstractmethod
from typing import Any, Union, Optional, TYPE_CHECKING
from bittensor.core.axon import Axon
from bittensor.core.dendrite import Dendrite
from bittensor.utils.btlogging import logging
# For annotation purposes
if TYPE_CHECKING:
from bittensor_wallet import Wallet
from bittensor.core.synapse import Synapse
# Community uses this class
[docs]
class SubnetsAPI(ABC):
"""This class is not used within the bittensor package, but is actively used by the community."""
def __init__(self, wallet: "Wallet"):
self.wallet = wallet
self.dendrite = Dendrite(wallet=wallet)
[docs]
async def __call__(self, *args, **kwargs):
return await self.query_api(*args, **kwargs)
[docs]
@abstractmethod
def prepare_synapse(self, *args, **kwargs) -> Any:
"""Prepare the synapse-specific payload."""
[docs]
@abstractmethod
def process_responses(self, responses: list[Union["Synapse", Any]]) -> Any:
"""Process the responses from the network."""
[docs]
async def query_api(
self,
axons: Union["Axon", list["Axon"]],
deserialize: Optional[bool] = False,
timeout: Optional[int] = 12,
**kwargs,
) -> Any:
"""
Queries the API nodes of a subnet using the given synapse and bespoke query function.
Args:
axons (Union[bt.axon, list[bt.axon]]): The list of axon(s) to query.
deserialize (Optional[bool]): Whether to deserialize the responses. Defaults to False.
timeout (Optional[int]): The timeout in seconds for the query. Defaults to 12.
**kwargs: Keyword arguments for the prepare_synapse_fn.
Returns:
Any: The result of the process_responses_fn.
"""
synapse = self.prepare_synapse(**kwargs)
logging.debug(f"Querying validator axons with synapse {synapse.name}...")
responses = await self.dendrite(
axons=axons,
synapse=synapse,
deserialize=deserialize,
timeout=timeout,
)
return self.process_responses(responses)
