Add websocket feature

composer.json

@@ -16,7 +16,8 @@
     "require": {
         "php": "^8.1",
         "farzai/support": "^1.2",
-        "farzai/transport": "^1.2"
+        "farzai/transport": "^1.2",
+        "phrity/websocket": "^2.0"
     },
     "require-dev": {
         "pestphp/pest": "^2.15",

example/live-order-book.php

@@ -0,0 +1,22 @@
+<?php
+
+require_once __DIR__.'/../vendor/autoload.php';
+
+use Farzai\Bitkub\ClientBuilder;
+use Farzai\Bitkub\WebSocket\Endpoints\LiveOrderBookEndpoint;
+use Farzai\Bitkub\WebSocket\Message;
+use Farzai\Bitkub\WebSocketClient;
+
+$websocket = new LiveOrderBookEndpoint(
+    new WebSocketClient(
+        ClientBuilder::create()
+            ->setCredentials('YOUR_API_KEY', 'YOUR_SECRET')
+            ->build()
+    )
+);
+
+$websocket->listen('THB_ADA', function (Message $message) {
+    echo $message->json('event').PHP_EOL;
+});
+
+$websocket->run();

example/stream-trade.php

@@ -0,0 +1,17 @@
+<?php
+
+require_once __DIR__.'/../vendor/autoload.php';
+
+$websocket = new \Farzai\Bitkub\WebSocket\Endpoints\MarketEndpoint(
+    new \Farzai\Bitkub\WebSocketClient(
+        \Farzai\Bitkub\ClientBuilder::create()
+            ->setCredentials('YOUR_API_KEY', 'YOUR_SECRET')
+            ->build()
+    )
+);
+
+$websocket->listen('trade.thb_ada', function (Farzai\Bitkub\WebSocket\Message $message) {
+    echo $message->json('sym').PHP_EOL;
+});
+
+$websocket->run();

src/Contracts/WebSocketEngineInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Farzai\Bitkub\Contracts;
+
+interface WebSocketEngineInterface
+{
+    public function handle(array $listeners): void;
+}

src/Endpoints/AbstractEndpoint.php

@@ -2,14 +2,14 @@
 
 namespace Farzai\Bitkub\Endpoints;
 
-use Farzai\Bitkub\Client;
+use Farzai\Bitkub\Contracts\ClientInterface;
 use Farzai\Bitkub\Requests\PendingRequest;
 
 abstract class AbstractEndpoint
 {
-    protected Client $client;
+    protected ClientInterface $client;
 
-    public function __construct(Client $client)
+    public function __construct(ClientInterface $client)
     {
         $this->client = $client;
     }

src/Endpoints/UserEndpoint.php

@@ -63,7 +63,7 @@ public function tradingCredits(): ResponseInterface
      *      }
      * }
      */
-    public function userLimits(): ResponseInterface
+    public function limits(): ResponseInterface
     {
         $config = $this->client->getConfig();
 

src/UriFactory.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Farzai\Bitkub;
+
+use Phrity\Net\Uri;
+use Psr\Http\Message\UriInterface;
+
+class UriFactory
+{
+    public static function createFromUri(string $uri): UriInterface
+    {
+        return new Uri($uri);
+    }
+}

src/WebSocket/Endpoints/AbstractEndpoint.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Farzai\Bitkub\WebSocket\Endpoints;
+
+use Farzai\Bitkub\WebSocketClient;
+
+abstract class AbstractEndpoint
+{
+    protected WebSocketClient $websocket;
+
+    public function __construct(WebSocketClient $websocket)
+    {
+        $this->websocket = $websocket;
+    }
+
+    /**
+     * Run the websocket.
+     */
+    public function run()
+    {
+        $this->websocket->run();
+    }
+
+    protected function getLogger()
+    {
+        return $this->websocket->getLogger();
+    }
+}

src/WebSocket/Endpoints/LiveOrderBookEndpoint.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Farzai\Bitkub\WebSocket\Endpoints;
+
+use Farzai\Bitkub\Endpoints as RestApiEndpoints;
+
+class LiveOrderBookEndpoint extends AbstractEndpoint
+{
+    /**
+     * Add event listener.
+     *
+     * @example $websocket->listen('thb_btc', function (Message $message) {
+     *    echo $message->json('sym').PHP_EOL;
+     * });
+     *
+     * @param  string|int  $symbol Symbol name or id.
+     * @param  callable|array<callable>  $listeners
+     */
+    public function listen($symbol, $listeners)
+    {
+        // Check if symbol is numeric.
+        if (! is_numeric($symbol)) {
+
+            $this->getLogger()->debug('Find symbol id by name: '.$symbol);
+
+            // Find symbol id by name.
+            $market = new RestApiEndpoints\MarketEndpoint($this->websocket->getClient());
+
+            foreach ($market->symbols()->throw()->json('result') as $item) {
+                if ($item['symbol'] === strtoupper(trim($symbol))) {
+                    $symbol = $item['id'];
+
+                    $this->getLogger()->debug('Found symbol id: '.$symbol);
+                    break;
+                }
+            }
+
+            if (! is_numeric($symbol)) {
+                $this->getLogger()->debug('Invalid symbol name. Given: '.$symbol);
+
+                throw new \InvalidArgumentException('Invalid symbol name. Given: '.$symbol);
+            }
+        }
+
+        $this->websocket->addListener('orderbook/'.$symbol, $listeners);
+
+        return $this;
+    }
+}

src/WebSocket/Endpoints/MarketEndpoint.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Farzai\Bitkub\WebSocket\Endpoints;
+
+class MarketEndpoint extends AbstractEndpoint
+{
+    /**
+     * Add event listener.
+     *
+     * @example $websocket->listen('market.trade.thb_btc', function (Message $message) {
+     *    echo $message->json('sym').PHP_EOL;
+     * });
+     *
+     * @param  string[]|string  $streamName
+     * @param  callable|array<callable>  $listeners
+     */
+    public function listen($streamName, $listeners)
+    {
+        if (is_string($streamName)) {
+            $streamNames = array_map('trim', explode(',', $streamName));
+        } else {
+            $streamNames = $streamName;
+        }
+
+        $this->getLogger()->debug('Add event listener for stream: '.implode(', ', $streamNames));
+
+        foreach ($streamNames as $name) {
+            $this->websocket->addListener($this->getStreamName($name), $listeners);
+        }
+
+        return $this;
+    }
+
+    private function getStreamName(string $streamName): string
+    {
+        $segments = explode('.', $streamName);
+
+        if (count($segments) === 3) {
+            return $streamName;
+        }
+
+        if (count($segments) === 2) {
+            return 'market.'.$streamName;
+        }
+
+        throw new \InvalidArgumentException('Invalid stream name format. Given: '.$streamName);
+    }
+}

src/WebSocket/Engine.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Farzai\Bitkub\WebSocket;
+
+use Farzai\Bitkub\Contracts\WebSocketEngineInterface;
+use Farzai\Support\Carbon;
+use Psr\Log\LoggerInterface;
+use WebSocket\Client as WebSocketClient;
+use WebSocket\Connection as WebSocketConnection;
+use WebSocket\Message\Message as WebSocketMessage;
+use WebSocket\Middleware as WebSocketMiddleware;
+
+class Engine implements WebSocketEngineInterface
+{
+    public function __construct(
+        private LoggerInterface $logger,
+    ) {
+    }
+
+    public function handle(array $listeners): void
+    {
+        $events = $this->getEventNames($listeners);
+
+        $this->logger->info('[WebSocket] - Connecting to WebSocket server...');
+
+        $this->logger->debug('[WebSocket] - Events: '.implode(', ', $events));
+
+        $client = new WebSocketClient('wss://api.bitkub.com/websocket-api/'.implode(',', $events));
+
+        $client
+            ->addMiddleware(new WebSocketMiddleware\CloseHandler())
+            ->addMiddleware(new WebSocketMiddleware\PingResponder());
+
+        $client->onText(function (WebSocketClient $client, WebSocketConnection $connection, WebSocketMessage $message) use ($listeners) {
+            $receivedAt = Carbon::now();
+
+            $data = @json_decode($message->getContent(), true) ?? [];
+            if (! isset($data['stream'])) {
+                $this->logger->warning('[WebSocket] - Unknown data: '.$message->getContent());
+
+                return;
+            }
+
+            $event = $data['stream'];
+            if (! isset($listeners[$event])) {
+                $this->logger->warning('[WebSocket] - Unknown event: '.$event);
+
+                return;
+            }
+
+            $message = new Message(
+                $message->getContent(),
+                $receivedAt->toDateTimeImmutable(),
+            );
+
+            foreach ($listeners[$event] as $listener) {
+                $this->logger->info('[WebSocket] - Event: '.$event);
+
+                $listener($message);
+            }
+        });
+
+        $client->onClose(function () {
+            $this->logger->info('[WebSocket] - Connection closed.');
+        });
+
+        $client->start();
+    }
+
+    private function getEventNames(array $listeners): array
+    {
+        return array_unique(array_keys($listeners));
+    }
+}