-
Notifications
You must be signed in to change notification settings - Fork 171
/
operations_call_builder.py
91 lines (69 loc) · 3.86 KB
/
operations_call_builder.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
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"
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 = "operations/{operation_id}".format(operation_id=operation_id)
return self
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: str = "accounts/{account_id}/operations".format(
account_id=account_id
)
return self
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: str = "ledgers/{sequence}/operations".format(sequence=sequence)
return self
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:
:return: this OperationCallBuilder instance
"""
self.endpoint: str = "transactions/{transaction_hash}/operations".format(
transaction_hash=transaction_hash
)
return self
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
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