from decimal import Decimal
from typing import List, Union
from ...asset import Asset
from ...call_builder.base import BaseStrictSendPathsCallBuilder
from ...call_builder.call_builder_sync.base_call_builder import BaseCallBuilder
from ...client.base_sync_client import BaseSyncClient
__all__ = ["StrictSendPathsCallBuilder"]
[docs]
class StrictSendPathsCallBuilder(BaseCallBuilder, BaseStrictSendPathsCallBuilder):
"""Creates a new :class:`StrictSendPathsCallBuilder` pointed to server defined by horizon_url.
Do not create this object directly, use :func:`stellar_sdk.Server.strict_send_paths`.
The Stellar Network allows payments to be made across assets through path
payments. A strict send path payment specifies a series of assets to route a
payment through, from source asset (the asset debited from the payer) to
destination asset (the asset credited to the payee).
A strict send path search is specified using:
- The source asset
- The source amount
- The destination assets or destination account.
As part of the search, horizon will load a list of assets available to the
source address and will find any payment paths from those source assets to
the desired destination asset. The search's source_amount parameter will be
used to determine if there a given path can satisfy a payment of the desired
amount.
See `List Strict Send Payment Paths <https://developers.stellar.org/api/aggregations/paths/strict-send/>`__ for more information.
:param horizon_url: Horizon server URL.
:param client: The client instance used to send request.
:param source_asset: The asset to be sent.
:param source_amount: The amount, denominated in the source asset, that any returned path should be able to satisfy.
:param destination: The destination account or the destination assets.
"""
def __init__(
self,
horizon_url: str,
client: BaseSyncClient,
source_asset: Asset,
source_amount: Union[str, Decimal],
destination: Union[str, List[Asset]],
) -> None:
super().__init__( # type: ignore[call-arg]
horizon_url=horizon_url,
client=client,
source_asset=source_asset,
source_amount=source_amount,
destination=destination,
)
[docs]
def stream(
self,
):
"""This endpoint does not support streaming."""
raise NotImplementedError("Streaming is not supported.")