ScannerServiceCallbackInterface.php

<?php
declare(strict_types=1);

namespace Gared\EtherScan\Service;

use Exception;
use Gared\EtherScan\Service\Scanner\Health\HealthResponseException;
use GuzzleHttp\Exception\GuzzleException;
use JsonException;
use Psr\Http\Message\ResponseInterface;
use Psr\Log\LoggerInterface;
use Throwable;

interface ScannerServiceCallbackInterface
{
    public function onScanApiStart(string $baseUrl): void;

    public function onScanApiResponse(ResponseInterface $response): void;

    public function onScanApiException(GuzzleException|JsonException $e): void;

    public function onScanApiRevision(?string $revision): void;

    /**
     * @param array<mixed> $commit
     */
    public function onScanApiRevisionCommit(array $commit): void;

    public function onScanApiVersion(string $apiVersion): void;

    /**
     * @param array<string, mixed> $plugins
     */
    public function onScanPluginsList(array $plugins): void;

    /**
     * @param array<mixed, mixed> $data
     */
    public function onStatsResult(array $data): void;

    public function onStatsException(GuzzleException|JsonException $e): void;

    /**
     * @param array{status?: string, releaseId?: string} $data
     */
    public function onHealthResult(array $data): void;

    public function onHealthException(HealthResponseException $e): void;

    public function onScanAdminStart(): void;

    public function onScanAdminResult(string $user, string $password, bool $result): void;

    public function onScanPadStart(): void;

    public function onScanPadException(Throwable $e): void;

    public function onScanPadSuccess(): void;

    public function onConnectedTransport(bool $usedWebsocket): void;

    public function onVersionResult(?string $minVersion, ?string $maxVersion): void;

    /**
     * @param array<mixed, mixed> $data
     */
    public function onClientVars(string $version, array $data): void;

    public function getConsoleLogger(): ?LoggerInterface;
}