Merge pull request 'fix version number' (#3) from 1.2.5 into main

Reviewed-on: #3

composer.json

@@ -13,6 +13,11 @@
             "name": "mahdi mansouri",
             "email": "mahdi.msr4@gmail.com",
             "role": "Developer"
+        },
+        {
+            "name": "Maik Mueller   ",
+            "email": "mueller.maik1@gmail.com",
+            "role": "Developer"
         }
     ],
     "require": {
@@ -21,9 +26,9 @@
         "illuminate/contracts": "^10.0||^11.0||^12.0||^13.0"
     },
     "require-dev": {
-        "laravel/pint": "^1.14",
-        "nunomaduro/collision": "^8.8",
         "larastan/larastan": "^3.0",
+        "laravel/pint": "^1.29",
+        "nunomaduro/collision": "^8.8",
         "orchestra/testbench": "^10.0.0||^9.0.0",
         "pestphp/pest": "^4.0",
         "pestphp/pest-plugin-arch": "^4.0",
@@ -50,7 +55,8 @@
         "analyse": "vendor/bin/phpstan analyse",
         "test": "vendor/bin/pest",
         "test-coverage": "vendor/bin/pest --coverage",
-        "format": "vendor/bin/pint"
+        "format": "vendor/bin/pint",
+        "pint": "vendor/bin/pint --ansi"
     },
     "config": {
         "sort-packages": true,
@@ -69,7 +75,7 @@
             }
         }
     },
-    "version": "1.1.0",
+    "version": "1.2.5",
     "minimum-stability": "stable",
     "prefer-stable": true
 }

src/Contracts/RateLimiterContract.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Msr\LaravelBitunixApi\Contracts;
+
+interface RateLimiterContract
+{
+    public function throttle(
+        string $bucket,
+        string $identity,
+        int $maxRequests,
+        float $perSeconds
+    ): void;
+}

src/LaravelBitunixApi.php

@@ -3,10 +3,14 @@
 namespace Msr\LaravelBitunixApi;
 
 use GuzzleHttp\Client;
+use GuzzleHttp\Exception\GuzzleException;
+use Msr\LaravelBitunixApi\Contracts\RateLimiterContract as RateLimiter;
 use Msr\LaravelBitunixApi\Requests\ChangeLeverageRequestContract;
 use Msr\LaravelBitunixApi\Requests\ChangeMarginModeRequestContract;
 use Msr\LaravelBitunixApi\Requests\FlashClosePositionRequestContract;
 use Msr\LaravelBitunixApi\Requests\FutureKLineRequestContract;
+use Msr\LaravelBitunixApi\Requests\GetHistoryPositionsRequestContract;
+use Msr\LaravelBitunixApi\Requests\GetHistoryTradesRequestContract;
 use Msr\LaravelBitunixApi\Requests\GetPendingPositionsRequestContract;
 use Msr\LaravelBitunixApi\Requests\GetSingleAccountRequestContract;
 use Msr\LaravelBitunixApi\Requests\GetTradingPairsRequestContract;
@@ -14,32 +18,50 @@ use Msr\LaravelBitunixApi\Requests\Header;
 use Msr\LaravelBitunixApi\Requests\PlaceOrderRequestContract;
 use Msr\LaravelBitunixApi\Requests\PlacePositionTpSlOrderRequestContract;
 use Msr\LaravelBitunixApi\Requests\PlaceTpSlOrderRequestContract;
+use Msr\LaravelBitunixApi\Support\BitunixAccountConfig;
 use Psr\Http\Message\ResponseInterface;
 
-class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginModeRequestContract, FlashClosePositionRequestContract, FutureKLineRequestContract, GetPendingPositionsRequestContract, GetSingleAccountRequestContract, GetTradingPairsRequestContract, PlaceOrderRequestContract, PlacePositionTpSlOrderRequestContract, PlaceTpSlOrderRequestContract
+class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginModeRequestContract, FlashClosePositionRequestContract, FutureKLineRequestContract, GetHistoryPositionsRequestContract, GetHistoryTradesRequestContract, GetPendingPositionsRequestContract, GetSingleAccountRequestContract, GetTradingPairsRequestContract, PlaceOrderRequestContract, PlacePositionTpSlOrderRequestContract, PlaceTpSlOrderRequestContract
 {
     private Client $publicFutureClient;
 
-    public function __construct()
+    protected BitunixAccountConfig $config;
+
+    public function __construct(protected RateLimiter $rateLimiter)
     {
+        $this->config = BitunixAccountConfig::fromConfig();
+
         $this->publicFutureClient = new Client([
-            'base_uri' => config('bitunix-api.future_base_uri').'/api/v1/futures/market/',
+            'base_uri' => ($this->config->baseUrl ?? config('bitunix-api.future_base_uri')).'/api/v1/futures/market/',
         ]);
     }
 
+    public function forAccount(BitunixAccountConfig $config): self
+    {
+        $this->config = $config;
+
+        return $this;
+    }
+
     protected function getPrivateFutureClient(array $queryParams = [], array $body = []): Client
     {
         $bodyString = count($body) ? json_encode($body) : '';
-        $headers = Header::generateHeaders($queryParams, $bodyString);
+        $headers = Header::generateHeaders($queryParams, $bodyString, $this->config);
 
         return new Client([
-            'base_uri' => config('bitunix-api.future_base_uri').'/api/v1/futures/',
+            'base_uri' => ($this->config->baseUrl ?? config('bitunix-api.future_base_uri')).'/api/v1/futures/',
             'headers' => $headers,
         ]);
     }
 
-    public function getFutureKline(string $symbol, string $interval, int $limit = 100, ?int $startTime = null, ?int $endTime = null, string $type = 'LAST_PRICE'): ResponseInterface
-    {
+    public function getFutureKline(
+        string $symbol,
+        string $interval,
+        int $limit = 100,
+        ?int $startTime = null,
+        ?int $endTime = null,
+        string $type = 'LAST_PRICE'
+    ): ResponseInterface {
         $response = $this->publicFutureClient->get('kline', [
             'query' => [
                 'symbol' => $symbol,
@@ -188,6 +210,54 @@ class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginMo
         return $response;
     }
 
+    public function getHistoryTrades(
+        ?string $symbol = null,
+        ?string $orderId = null,
+        ?string $positionId = null,
+        ?int $startTime = null,
+        ?int $endTime = null,
+        int $skip = 0,
+        int $limit = 100
+    ): ResponseInterface {
+        $this->rateLimiter->throttle(
+            'futures::get_history_trades',
+            $this->resolveRateLimitIdentity(),
+            maxRequests: 8,
+            perSeconds: 1
+        );
+
+        $queryParams = [
+            'skip' => $skip,
+            'limit' => $limit,
+        ];
+
+        if ($symbol !== null) {
+            $queryParams['symbol'] = $symbol;
+        }
+
+        if ($orderId !== null) {
+            $queryParams['orderId'] = $orderId;
+        }
+
+        if ($positionId !== null) {
+            $queryParams['positionId'] = $positionId;
+        }
+
+        if ($startTime !== null) {
+            $queryParams['startTime'] = $startTime;
+        }
+
+        if ($endTime !== null) {
+            $queryParams['endTime'] = $endTime;
+        }
+
+        $response = $this->getPrivateFutureClient($queryParams, [])->get('trade/get_history_trades', [
+            'query' => $queryParams,
+        ]);
+
+        return $response;
+    }
+
     public function getPendingPositions(?string $symbol = null, ?string $positionId = null): ResponseInterface
     {
         $queryParams = [];
@@ -207,6 +277,45 @@ class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginMo
         return $response;
     }
 
+    /**
+     * @throws GuzzleException
+     */
+    public function getHistoryPositions(
+        ?string $symbol = null,
+        ?int $startTime = null,
+        ?int $endTime = null,
+        int $skip = 0,
+        int $limit = 100
+    ): ResponseInterface {
+        $this->rateLimiter->throttle(
+            'futures::get_history_positions',
+            $this->resolveRateLimitIdentity(),
+            maxRequests: 8,
+            perSeconds: 1
+        );
+
+        $queryParams = [
+            'skip' => $skip,
+            'limit' => $limit,
+        ];
+
+        if ($symbol !== null) {
+            $queryParams['symbol'] = $symbol;
+        }
+
+        if ($startTime !== null) {
+            $queryParams['startTime'] = $startTime;
+        }
+
+        if ($endTime !== null) {
+            $queryParams['endTime'] = $endTime;
+        }
+
+        return $this->getPrivateFutureClient($queryParams, [])->get('position/get_history_positions', [
+            'query' => $queryParams,
+        ]);
+    }
+
     public function getSingleAccount(string $marginCoin): ResponseInterface
     {
         $queryParams = [
@@ -305,10 +414,13 @@ class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginMo
             $body['slStopType'] = $slStopType;
         }
 
-        $response = $this->getPrivateFutureClient([], $body)->post('tpsl/position/place_order', [
+        return $this->getPrivateFutureClient([], $body)->post('tpsl/position/place_order', [
             'json' => $body,
         ]);
+    }
 
-        return $response;
+    protected function resolveRateLimitIdentity(): string
+    {
+        return (string) ($this->config->accountKey ?? $this->config->apiKey);
     }
 }

src/LaravelBitunixApiServiceProvider.php

@@ -2,17 +2,22 @@
 
 namespace Msr\LaravelBitunixApi;
 
+use Illuminate\Contracts\Cache\Factory as CacheFactory;
 use Msr\LaravelBitunixApi\Commands\LaravelBitunixApiCommand;
+use Msr\LaravelBitunixApi\Contracts\RateLimiterContract;
 use Msr\LaravelBitunixApi\Requests\ChangeLeverageRequestContract;
 use Msr\LaravelBitunixApi\Requests\ChangeMarginModeRequestContract;
 use Msr\LaravelBitunixApi\Requests\FlashClosePositionRequestContract;
 use Msr\LaravelBitunixApi\Requests\FutureKLineRequestContract;
+use Msr\LaravelBitunixApi\Requests\GetHistoryPositionsRequestContract;
+use Msr\LaravelBitunixApi\Requests\GetHistoryTradesRequestContract;
 use Msr\LaravelBitunixApi\Requests\GetPendingPositionsRequestContract;
 use Msr\LaravelBitunixApi\Requests\GetSingleAccountRequestContract;
 use Msr\LaravelBitunixApi\Requests\GetTradingPairsRequestContract;
 use Msr\LaravelBitunixApi\Requests\PlaceOrderRequestContract;
 use Msr\LaravelBitunixApi\Requests\PlacePositionTpSlOrderRequestContract;
 use Msr\LaravelBitunixApi\Requests\PlaceTpSlOrderRequestContract;
+use Msr\LaravelBitunixApi\Support\CacheRateLimiter;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
@@ -47,5 +52,13 @@ class LaravelBitunixApiServiceProvider extends PackageServiceProvider
         $this->app->bind(PlaceTpSlOrderRequestContract::class, LaravelBitunixApi::class);
         $this->app->bind(PlacePositionTpSlOrderRequestContract::class, LaravelBitunixApi::class);
         $this->app->bind(GetTradingPairsRequestContract::class, LaravelBitunixApi::class);
+        $this->app->bind(GetHistoryTradesRequestContract::class, LaravelBitunixApi::class);
+        $this->app->bind(GetHistoryPositionsRequestContract::class, LaravelBitunixApi::class);
+
+        $this->app->bind(RateLimiterContract::class, function ($app) {
+            return new CacheRateLimiter(
+                $app->make(CacheFactory::class)->store()
+            );
+        });
     }
 }

src/Requests/GetHistoryPositionsRequestContract.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Msr\LaravelBitunixApi\Requests;
+
+use Psr\Http\Message\ResponseInterface;
+
+interface GetHistoryPositionsRequestContract
+{
+    public function getHistoryPositions(
+        ?string $symbol = null,
+        ?int $startTime = null,
+        ?int $endTime = null,
+        int $skip = 0,
+        int $limit = 100
+    ): ResponseInterface;
+}

src/Requests/GetHistoryTradesRequestContract.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Msr\LaravelBitunixApi\Requests;
+
+use Psr\Http\Message\ResponseInterface;
+
+interface GetHistoryTradesRequestContract
+{
+    public function getHistoryTrades(
+        ?string $symbol = null,
+        ?string $orderId = null,
+        ?string $positionId = null,
+        ?int $startTime = null,
+        ?int $endTime = null,
+        int $skip = 0,
+        int $limit = 100
+    ): ResponseInterface;
+}

src/Requests/Header.php

@@ -2,6 +2,8 @@
 
 namespace Msr\LaravelBitunixApi\Requests;
 
+use Msr\LaravelBitunixApi\Support\BitunixAccountConfig;
+
 class Header
 {
     /**
@@ -64,13 +66,13 @@ class Header
      * 3. Create digest: SHA256(nonce + timestamp + api-key + queryParams + body)
      * 4. Create sign: SHA256(digest + secretKey)
      */
-    public static function generateSignValue(array $queryParams = [], string $body = '', string $nonce = '', string $timestamp = ''): string
+    public static function generateSignValue(array $queryParams, string $body, string $nonce, string $timestamp, BitunixAccountConfig $config): string
     {
-        $apiKey = config('bitunix-api.api_key');
-        $apiSecret = config('bitunix-api.api_secret');
+        $apiKey = $config->apiKey;
+        $apiSecret = $config->apiSecret;
 
         if (empty($apiKey) || empty($apiSecret)) {
-            throw new \InvalidArgumentException('API key and secret must be configured');
+            throw new \InvalidArgumentException('API key and secret must be provided in config');
         }
 
         // Step 1: Sort query parameters in ascending ASCII order
@@ -97,18 +99,18 @@ class Header
     /**
      * Generate complete headers for authenticated requests
      */
-    public static function generateHeaders(array $queryParams = [], string $body = ''): array
+    public static function generateHeaders(array $queryParams, string $body, BitunixAccountConfig $config): array
     {
         $nonce = self::generateNonce();
         $timestamp = self::generateTimestamp();
-        $sign = self::generateSignValue($queryParams, $body, $nonce, $timestamp);
+        $sign = self::generateSignValue($queryParams, $body, $nonce, $timestamp, $config);
 
         return [
-            'api-key' => config('bitunix-api.api_key'),
+            'api-key' => $config->apiKey,
             'sign' => $sign,
             'nonce' => $nonce,
             'timestamp' => $timestamp,
-            'language' => config('bitunix-api.language', 'en-US'),
+            'language' => $config->language, //config('bitunix-api.language', 'en-US'),
             'Content-Type' => 'application/json',
         ];
     }

src/Support/BitunixAccountConfig.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Msr\LaravelBitunixApi\Support;
+
+class BitunixAccountConfig
+
+{
+
+    public function __construct(
+
+        public readonly string $apiKey,
+
+        public readonly string $apiSecret,
+
+        public readonly ?string $accountKey = null,
+
+        public readonly ?string $baseUrl = null,
+
+        public readonly ?string $language = 'en-US',
+
+    ) {
+    }
+
+    public static function fromConfig(): self
+
+    {
+        return new self(
+
+            apiKey: config('bitunix-api.api_key'),
+
+            apiSecret: config('bitunix-api.api_secret'),
+
+            accountKey: config('bitunix-api.account_key', 'default'),
+
+            baseUrl: config('bitunix-api.future_base_uri'),
+
+            language: config('bitunix-api.language', 'en-US'),
+
+        );
+    }
+}

src/Support/CacheRateLimiter.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Msr\LaravelBitunixApi\Support;
+
+use Illuminate\Contracts\Cache\Repository;
+use Msr\LaravelBitunixApi\Contracts\RateLimiterContract;
+
+class CacheRateLimiter implements RateLimiterContract
+{
+    public function __construct(
+        protected Repository $cache,
+    ) {}
+
+    public function throttle(
+        string $bucket,
+        string $identity,
+        int $maxRequests,
+        float $perSeconds
+    ): void {
+        if ($maxRequests <= 0 || $perSeconds <= 0) {
+            return;
+        }
+
+        $cacheKey = $this->makeCacheKey($bucket, $identity);
+        $minIntervalMicroseconds = (int) (($perSeconds / $maxRequests) * 1_000_000);
+
+        $lastRequestAt = $this->cache->get($cacheKey);
+
+        if (is_numeric($lastRequestAt)) {
+            $elapsedMicroseconds = (int) ((microtime(true) - (float) $lastRequestAt) * 1_000_000);
+
+            if ($elapsedMicroseconds < $minIntervalMicroseconds) {
+                $sleepMicroseconds = $minIntervalMicroseconds - $elapsedMicroseconds;
+
+                if ($sleepMicroseconds > 0) {
+                    usleep($sleepMicroseconds);
+                }
+            }
+        }
+
+        $this->cache->put(
+            $cacheKey,
+            microtime(true),
+            now()->addSeconds((int) max(1, ceil($perSeconds * 2)))
+        );
+    }
+
+    protected function makeCacheKey(string $bucket, string $identity): string
+    {
+        return sprintf(
+            'laravel_bitunix_api:rate_limit:%s:%s',
+            $bucket,
+            sha1($identity)
+        );
+    }
+}