# Code generated by protoc-gen-meshpy. DO NOT EDIT.
# source: meshtrade/ledger/transaction/v1/service.proto

"""
TransactionService gRPC service wrapper with authentication, timeouts, and resource management.

This module provides a high-level gRPC service for the TransactionService service that combines
the service interface with resource management capabilities, providing authentication,
timeouts, and proper connection handling.
"""

from collections.abc import Iterator
from datetime import timedelta
from typing import Optional

from meshtrade.common import BaseGRPCClient
from meshtrade.iam.api_user.v1.api_credentials import find_credentials

from meshtrade.common.service_options import ServiceOptions
from .service_pb2 import (
GetTransactionStateRequest,
GetTransactionStateResponse,
MonitorTransactionStateRequest,
MonitorTransactionStateResponse,
)
from .service_pb2_grpc import TransactionServiceStub


def _create_transactionservice_stub(channel):
    """Factory function to create TransactionServiceStub from gRPC channel."""
    return TransactionServiceStub(channel)


class TransactionService(BaseGRPCClient):
    """TransactionService gRPC service with authentication, timeouts, and resource management.

    This service provides a complete implementation of the TransactionService with proper authentication, timeout handling, and automatic resource cleanup.

    Full Service documentation: https://meshtrade.github.io/api/docs/api-reference/ledger/transaction/v1

    Basic service usage with default SDK Configuration:
    ```python
    service = TransactionService()

    with service:   # `with` ensures proper clean up of underlying connection after use
        response = service.get_api_user(request)
    ```
        
    With default configuration API credentials are searched for using the standard discovery hierarchy:
    
    1. MESH_API_CREDENTIALS environment variable
    
    2. Default credential file location:
    
    - Linux:   `$XDG_CONFIG_HOME/mesh/credentials.json` or fallback to `$HOME/.config/mesh/credentials.json`
    - macOS:   `$HOME/Library/Application Support/mesh/credentials.json`
    - Windows: `C:\\Users\\<user>\\AppData\\Roaming\\mesh\\credentials.json`
    
    For more information on authentication: https://meshtrade.github.io/api/docs/architecture/authentication

    The service may also be configured with custom options:
    ```python
    from .service_options_meshpy import ServiceOptions
    from datetime import timedelta

    options = ServiceOptions(
        url="api.staging.example.com",
        port=443,
        api_key="your-api-key",
        group="groups/your-group-id",
        timeout=timedelta(seconds=60)
    )

    service = TransactionService(options)

    with service: # `with` ensures proper clean up of underlying connection after use
        response = service.get_api_user(request)
    ```

    For more information on service configuration: https://meshtrade.github.io/api/docs/architecture/sdk-configuration
    """

    def __init__(self, options: Optional[ServiceOptions] = None):
        """Construct and initialize the TransactionService service.

        Full Service documentation: https://meshtrade.github.io/api/docs/api-reference/ledger/transaction/v1

        Args:
            options: Optional ServiceOptions for configuring the service.
                    If None, service is constructed with default configuration.
                    With default configuration API credentials are searched for using the standard discovery hierarchy:
                    
                    1. MESH_API_CREDENTIALS environment variable
                    
                    2. Default credential file location:
                    
                    - Linux:   `$XDG_CONFIG_HOME/mesh/credentials.json` or fallback to `$HOME/.config/mesh/credentials.json`
                    - macOS:   `$HOME/Library/Application Support/mesh/credentials.json`
                    - Windows: `C:\\Users\\<user>\\AppData\\Roaming\\mesh\\credentials.json`      

                    For more information on authentication: https://meshtrade.github.io/api/docs/architecture/authentication

                    For more information on service configuration: https://meshtrade.github.io/api/docs/architecture/sdk-configuration            

        Example:
        ```python
        # construct with default configuration
        service = TransactionService()

        # construct with custom configuration
        options = ServiceOptions(
            url="api.example.com",
            api_key="your-key",
            group="groups/your-group"
        )
        service = TransactionService(options)
        ```
        """
        if options is None:
            options = ServiceOptions()

        # Initialize the base client with all common functionality
        super().__init__(
            service_name="TransactionService",
            stub_factory=_create_transactionservice_stub,
            find_credentials_func=find_credentials,
            url=options.url,
            port=options.port,
            api_key=options.api_key,
            group=options.group,
            timeout=options.timeout,
            tls=options.tls,
        )

    def get_transaction_state(self, request: GetTransactionStateRequest, timeout: Optional[timedelta] = None) -> GetTransactionStateResponse:
        """GetTransactionState method.

        Args:
            request: The GetTransactionState request message
            timeout: Optional timeout override for this call

        Returns:
            The GetTransactionState response message

        Raises:
            grpc.RpcError: If the gRPC call fails
            ValueError: If authentication credentials are missing
        """
        return self._execute_method("GetTransactionState", request, timeout)

    def monitor_transaction_state(self, request: MonitorTransactionStateRequest, timeout: Optional[timedelta] = None) -> Iterator[MonitorTransactionStateResponse]:
        """MonitorTransactionState server-side streaming method with authentication and validation.

        Args:
            request: The MonitorTransactionState request message
            timeout: Optional timeout override for this call

        Yields:
            MonitorTransactionStateResponse: Stream of response messages

        Raises:
            grpc.RpcError: If the gRPC call fails
            ValueError: If authentication credentials are missing or request validation fails

        Example:
            >>> stream = service.monitor_transaction_state(request)
            >>> for response in stream:
            ...     # Process each response
            ...     print(response)
        """
        return self._execute_streaming_method("MonitorTransactionState", request, timeout)


# Create aliases to match expected exports
TransactionServiceGRPCClient = TransactionService
TransactionServiceGRPCClientInterface = TransactionService
