Compare commits

...
6 Commits
Author SHA1 Message Date
mis_mueller 351289dcdc Done 2026-05-19 16:28:49 +02:00
mis_mueller 3845bf12c1 Done 2026-04-12 19:59:00 +02:00
mis_mueller f066040415 Add CacheRateLimiter 2026-04-12 19:47:10 +02:00
mis_mueller 8ad4765d5d Merge branch 'refs/heads/1.2.2'
# Conflicts:
#	src/LaravelBitunixApiServiceProvider.php
2026-04-12 19:46:48 +02:00
mis_mueller bf9bcd4f7e Add CacheRateLimiter 2026-04-12 19:43:56 +02:00
moltox a58ece7076 Merge pull request '1.2.2' (#1) from 1.2.2 into main
Reviewed-on: #1
2026-04-11 21:44:13 +00:00
7 changed files with 171 additions and 25 deletions

No files matched your search

+5 -4
View File
@@ -26,9 +26,9 @@
"illuminate/contracts": "^10.0||^11.0||^12.0||^13.0" "illuminate/contracts": "^10.0||^11.0||^12.0||^13.0"
}, },
"require-dev": { "require-dev": {
"laravel/pint": "^1.14",
"nunomaduro/collision": "^8.8",
"larastan/larastan": "^3.0", "larastan/larastan": "^3.0",
"laravel/pint": "^1.29",
"nunomaduro/collision": "^8.8",
"orchestra/testbench": "^10.0.0||^9.0.0", "orchestra/testbench": "^10.0.0||^9.0.0",
"pestphp/pest": "^4.0", "pestphp/pest": "^4.0",
"pestphp/pest-plugin-arch": "^4.0", "pestphp/pest-plugin-arch": "^4.0",
@@ -55,7 +55,8 @@
"analyse": "vendor/bin/phpstan analyse", "analyse": "vendor/bin/phpstan analyse",
"test": "vendor/bin/pest", "test": "vendor/bin/pest",
"test-coverage": "vendor/bin/pest --coverage", "test-coverage": "vendor/bin/pest --coverage",
"format": "vendor/bin/pint" "format": "vendor/bin/pint",
"pint": "vendor/bin/pint --ansi"
}, },
"config": { "config": {
"sort-packages": true, "sort-packages": true,
@@ -74,7 +75,7 @@
} }
} }
}, },
"version": "1.2.2", "version": "1.2.3",
"minimum-stability": "stable", "minimum-stability": "stable",
"prefer-stable": true "prefer-stable": true
} }
+13
View File
@@ -0,0 +1,13 @@
<?php
namespace Msr\LaravelBitunixApi\Contracts;
interface RateLimiterContract
{
public function throttle(
string $bucket,
string $identity,
int $maxRequests,
float $perSeconds
): void;
}
+37 -13
View File
@@ -4,6 +4,7 @@ namespace Msr\LaravelBitunixApi;
use GuzzleHttp\Client; use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException; use GuzzleHttp\Exception\GuzzleException;
use Msr\LaravelBitunixApi\Contracts\RateLimiterContract as RateLimiter;
use Msr\LaravelBitunixApi\Requests\ChangeLeverageRequestContract; use Msr\LaravelBitunixApi\Requests\ChangeLeverageRequestContract;
use Msr\LaravelBitunixApi\Requests\ChangeMarginModeRequestContract; use Msr\LaravelBitunixApi\Requests\ChangeMarginModeRequestContract;
use Msr\LaravelBitunixApi\Requests\FlashClosePositionRequestContract; use Msr\LaravelBitunixApi\Requests\FlashClosePositionRequestContract;
@@ -17,31 +18,38 @@ use Msr\LaravelBitunixApi\Requests\Header;
use Msr\LaravelBitunixApi\Requests\PlaceOrderRequestContract; use Msr\LaravelBitunixApi\Requests\PlaceOrderRequestContract;
use Msr\LaravelBitunixApi\Requests\PlacePositionTpSlOrderRequestContract; use Msr\LaravelBitunixApi\Requests\PlacePositionTpSlOrderRequestContract;
use Msr\LaravelBitunixApi\Requests\PlaceTpSlOrderRequestContract; use Msr\LaravelBitunixApi\Requests\PlaceTpSlOrderRequestContract;
use Msr\LaravelBitunixApi\Support\BitunixAccountConfig;
use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ResponseInterface;
class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginModeRequestContract, class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginModeRequestContract, FlashClosePositionRequestContract, FutureKLineRequestContract, GetHistoryPositionsRequestContract, GetHistoryTradesRequestContract, GetPendingPositionsRequestContract, GetSingleAccountRequestContract, GetTradingPairsRequestContract, PlaceOrderRequestContract, PlacePositionTpSlOrderRequestContract, PlaceTpSlOrderRequestContract
FlashClosePositionRequestContract, FutureKLineRequestContract,
GetPendingPositionsRequestContract, GetSingleAccountRequestContract,
GetTradingPairsRequestContract, PlaceOrderRequestContract,
PlacePositionTpSlOrderRequestContract, PlaceTpSlOrderRequestContract,
GetHistoryPositionsRequestContract, GetHistoryTradesRequestContract
{ {
private Client $publicFutureClient; private Client $publicFutureClient;
public function __construct() protected BitunixAccountConfig $config;
public function __construct(protected RateLimiter $rateLimiter)
{ {
$this->config = BitunixAccountConfig::fromConfig();
$this->publicFutureClient = new Client([ $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 protected function getPrivateFutureClient(array $queryParams = [], array $body = []): Client
{ {
$bodyString = count($body) ? json_encode($body) : ''; $bodyString = count($body) ? json_encode($body) : '';
$headers = Header::generateHeaders($queryParams, $bodyString); $headers = Header::generateHeaders($queryParams, $bodyString, $this->config);
return new Client([ 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, 'headers' => $headers,
]); ]);
} }
@@ -211,6 +219,13 @@ class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginMo
int $skip = 0, int $skip = 0,
int $limit = 100 int $limit = 100
): ResponseInterface { ): ResponseInterface {
$this->rateLimiter->throttle(
'futures::get_history_trades',
$this->resolveRateLimitIdentity(),
maxRequests: 8,
perSeconds: 1
);
$queryParams = [ $queryParams = [
'skip' => $skip, 'skip' => $skip,
'limit' => $limit, 'limit' => $limit,
@@ -243,7 +258,6 @@ class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginMo
return $response; return $response;
} }
public function getPendingPositions(?string $symbol = null, ?string $positionId = null): ResponseInterface public function getPendingPositions(?string $symbol = null, ?string $positionId = null): ResponseInterface
{ {
$queryParams = []; $queryParams = [];
@@ -273,6 +287,13 @@ class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginMo
int $skip = 0, int $skip = 0,
int $limit = 100 int $limit = 100
): ResponseInterface { ): ResponseInterface {
$this->rateLimiter->throttle(
'futures::get_history_positions',
$this->resolveRateLimitIdentity(),
maxRequests: 8,
perSeconds: 1
);
$queryParams = [ $queryParams = [
'skip' => $skip, 'skip' => $skip,
'limit' => $limit, 'limit' => $limit,
@@ -393,10 +414,13 @@ class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginMo
$body['slStopType'] = $slStopType; $body['slStopType'] = $slStopType;
} }
$response = $this->getPrivateFutureClient([], $body)->post('tpsl/position/place_order', [ return $this->getPrivateFutureClient([], $body)->post('tpsl/position/place_order', [
'json' => $body, 'json' => $body,
]); ]);
}
return $response; protected function resolveRateLimitIdentity(): string
{
return (string) ($this->config->accountKey ?? $this->config->apiKey);
} }
} }
+9
View File
@@ -2,7 +2,9 @@
namespace Msr\LaravelBitunixApi; namespace Msr\LaravelBitunixApi;
use Illuminate\Contracts\Cache\Factory as CacheFactory;
use Msr\LaravelBitunixApi\Commands\LaravelBitunixApiCommand; use Msr\LaravelBitunixApi\Commands\LaravelBitunixApiCommand;
use Msr\LaravelBitunixApi\Contracts\RateLimiterContract;
use Msr\LaravelBitunixApi\Requests\ChangeLeverageRequestContract; use Msr\LaravelBitunixApi\Requests\ChangeLeverageRequestContract;
use Msr\LaravelBitunixApi\Requests\ChangeMarginModeRequestContract; use Msr\LaravelBitunixApi\Requests\ChangeMarginModeRequestContract;
use Msr\LaravelBitunixApi\Requests\FlashClosePositionRequestContract; use Msr\LaravelBitunixApi\Requests\FlashClosePositionRequestContract;
@@ -15,6 +17,7 @@ use Msr\LaravelBitunixApi\Requests\GetTradingPairsRequestContract;
use Msr\LaravelBitunixApi\Requests\PlaceOrderRequestContract; use Msr\LaravelBitunixApi\Requests\PlaceOrderRequestContract;
use Msr\LaravelBitunixApi\Requests\PlacePositionTpSlOrderRequestContract; use Msr\LaravelBitunixApi\Requests\PlacePositionTpSlOrderRequestContract;
use Msr\LaravelBitunixApi\Requests\PlaceTpSlOrderRequestContract; use Msr\LaravelBitunixApi\Requests\PlaceTpSlOrderRequestContract;
use Msr\LaravelBitunixApi\Support\CacheRateLimiter;
use Spatie\LaravelPackageTools\Package; use Spatie\LaravelPackageTools\Package;
use Spatie\LaravelPackageTools\PackageServiceProvider; use Spatie\LaravelPackageTools\PackageServiceProvider;
@@ -51,5 +54,11 @@ class LaravelBitunixApiServiceProvider extends PackageServiceProvider
$this->app->bind(GetTradingPairsRequestContract::class, LaravelBitunixApi::class); $this->app->bind(GetTradingPairsRequestContract::class, LaravelBitunixApi::class);
$this->app->bind(GetHistoryTradesRequestContract::class, LaravelBitunixApi::class); $this->app->bind(GetHistoryTradesRequestContract::class, LaravelBitunixApi::class);
$this->app->bind(GetHistoryPositionsRequestContract::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()
);
});
} }
} }
+10 -8
View File
@@ -2,6 +2,8 @@
namespace Msr\LaravelBitunixApi\Requests; namespace Msr\LaravelBitunixApi\Requests;
use Msr\LaravelBitunixApi\Support\BitunixAccountConfig;
class Header class Header
{ {
/** /**
@@ -64,13 +66,13 @@ class Header
* 3. Create digest: SHA256(nonce + timestamp + api-key + queryParams + body) * 3. Create digest: SHA256(nonce + timestamp + api-key + queryParams + body)
* 4. Create sign: SHA256(digest + secretKey) * 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'); $apiKey = $config->apiKey;
$apiSecret = config('bitunix-api.api_secret'); $apiSecret = $config->apiSecret;
if (empty($apiKey) || empty($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 // Step 1: Sort query parameters in ascending ASCII order
@@ -97,18 +99,18 @@ class Header
/** /**
* Generate complete headers for authenticated requests * 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(); $nonce = self::generateNonce();
$timestamp = self::generateTimestamp(); $timestamp = self::generateTimestamp();
$sign = self::generateSignValue($queryParams, $body, $nonce, $timestamp); $sign = self::generateSignValue($queryParams, $body, $nonce, $timestamp, $config);
return [ return [
'api-key' => config('bitunix-api.api_key'), 'api-key' => $config->apiKey,
'sign' => $sign, 'sign' => $sign,
'nonce' => $nonce, 'nonce' => $nonce,
'timestamp' => $timestamp, 'timestamp' => $timestamp,
'language' => config('bitunix-api.language', 'en-US'), 'language' => $config->language, //config('bitunix-api.language', 'en-US'),
'Content-Type' => 'application/json', 'Content-Type' => 'application/json',
]; ];
} }
+41
View File
@@ -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'),
);
}
}
+56
View File
@@ -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)
);
}
}