Source code for stellar_sdk.call_builder.claimable_balances_call_builder

from typing import Union

from ..asset import Asset
from ..call_builder.base_call_builder import BaseCallBuilder
from ..client.base_async_client import BaseAsyncClient
from ..client.base_sync_client import BaseSyncClient
from ..utils import convert_assets_to_horizon_param

__all__ = ["ClaimableBalancesCallBuilder"]

[docs]class ClaimableBalancesCallBuilder(BaseCallBuilder): """Creates a new :class:`ClaimableBalancesCallBuilder` pointed to server defined by horizon_url. Do not create this object directly, use :func:`stellar_sdk.server.Server.claimable_balance`. :param horizon_url: Horizon server URL. :param client: The client instance used to send request. """ def __init__( self, horizon_url, client: Union[BaseAsyncClient, BaseSyncClient] ) -> None: super().__init__(horizon_url, client) self.endpoint: str = "claimable_balances"
[docs] def claimable_balance( self, claimable_balance_id: str ) -> "ClaimableBalancesCallBuilder": """Returns information and links relating to a single claimable balance. See `Claimable Balances <>`_ :param claimable_balance_id: claimable balance id :return: current AccountCallBuilder instance """ self.endpoint = f"claimable_balances/{claimable_balance_id}" return self
[docs] def for_sponsor(self, sponsor: str) -> "ClaimableBalancesCallBuilder": """Returns all claimable balances which are sponsored by the given account ID. See `Claimable Balances <>`_ :param sponsor: the sponsor id, for example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD` :return: current ClaimableBalancesCallBuilder instance """ self._add_query_param("sponsor", sponsor) return self
[docs] def for_asset(self, asset: Asset) -> "ClaimableBalancesCallBuilder": """Returns all claimable balances which provide a balance for the given asset. See `Account Details <>`_ :param asset: an asset :return: current ClaimableBalancesCallBuilder instance """ assets_param = convert_assets_to_horizon_param([asset]) self._add_query_param("asset", assets_param) return self
[docs] def for_claimant(self, claimant: str) -> "ClaimableBalancesCallBuilder": """Returns all claimable balances which can be claimed by the given account ID. See `Account Details <>`_ :param claimant: the account id, for example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD` :return: current ClaimableBalancesCallBuilder instance """ self._add_query_param("claimant", claimant) return self