Source code for stellar_sdk.call_builder.operations_call_builder

from typing import Union

from ..call_builder.base_call_builder import BaseCallBuilder
from ..client.base_async_client import BaseAsyncClient
from ..client.base_sync_client import BaseSyncClient

__all__ = ["OperationsCallBuilder"]


[docs]class OperationsCallBuilder(BaseCallBuilder): """Creates a new :class:`OperationsCallBuilder` pointed to server defined by horizon_url. Do not create this object directly, use :func:`stellar_sdk.server.Server.operations`. See `All Operations <https://www.stellar.org/developers/horizon/reference/endpoints/operations-all.html>`_ :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 = "operations"
[docs] def operation(self, operation_id: Union[int, str]) -> "OperationsCallBuilder": """The operation details endpoint provides information on a single operation. The operation ID provided in the id argument specifies which operation to load. See `Operation Details <https://www.stellar.org/developers/horizon/reference/endpoints/operations-single.html>`_ :param operation_id: Operation ID :return: this OperationCallBuilder instance """ self.endpoint = f"operations/{operation_id}" return self
[docs] def for_account(self, account_id: str) -> "OperationsCallBuilder": """This endpoint represents all operations that were included in valid transactions that affected a particular account. See `Operations for Account <https://www.stellar.org/developers/horizon/reference/endpoints/operations-for-account.html>`_ :param account_id: Account ID :return: this OperationCallBuilder instance """ self.endpoint = f"accounts/{account_id}/operations" return self
[docs] def for_ledger(self, sequence: Union[int, str]) -> "OperationsCallBuilder": """This endpoint returns all operations that occurred in a given ledger. See `Operations for Ledger <https://www.stellar.org/developers/horizon/reference/endpoints/operations-for-ledger.html>`_ :param sequence: Sequence ID :return: this OperationCallBuilder instance """ self.endpoint = f"ledgers/{sequence}/operations" return self
[docs] def for_transaction(self, transaction_hash: str) -> "OperationsCallBuilder": """This endpoint represents all operations that are part of a given transaction. See `Operations for Transaction <https://www.stellar.org/developers/horizon/reference/endpoints/operations-for-transaction.html>`_ :param transaction_hash: Transaction Hash :return: this OperationCallBuilder instance """ self.endpoint = f"transactions/{transaction_hash}/operations" return self
[docs] def for_claimable_balance( self, claimable_balance_id: str ) -> "OperationsCallBuilder": """This endpoint represents successful operations referencing a given claimable balance and can be used in streaming mode. See `Claimable Balances - Retrieve related Operations <https://developers.stellar.org/api/resources/claimablebalances/operations/>`_ :param claimable_balance_id: This claimable balance’s id encoded in a hex string representation. :return: this OperationCallBuilder instance """ self.endpoint = f"claimable_balances/{claimable_balance_id}/operations" return self
[docs] def for_liquidity_pool(self, liquidity_pool_id: str) -> "OperationsCallBuilder": """This endpoint represents all operations that are part of a given liquidity pool. TODO: docs link :param liquidity_pool_id: The ID of the liquidity pool in hex string. :return: this OperationCallBuilder instance """ self.endpoint = f"liquidity_pools/{liquidity_pool_id}/operations" return self
[docs] def include_failed(self, include_failed: bool) -> "OperationsCallBuilder": """Adds a parameter defining whether to include failed transactions. By default only operations of successful transactions are returned. :param include_failed: Set to `True` to include operations of failed transactions. :return: current OperationsCallBuilder instance """ self._add_query_param("include_failed", include_failed) return self
[docs] def join(self, join: str) -> "OperationsCallBuilder": """join represents `join` param in queries, currently only supports `transactions` :param join: join represents `join` param in queries, currently only supports `transactions` :return: current OperationsCallBuilder instance """ self._add_query_param("join", join) return self