Compare commits

..

No commits in common. "main" and "dev" have entirely different histories.
main ... dev

10 changed files with 14 additions and 245 deletions

View File

@ -14,7 +14,7 @@ jobs:
- name: Dependabot metadata
id: metadata
uses: dependabot/fetch-metadata@v2.5.0
uses: dependabot/fetch-metadata@v2.4.0
with:
github-token: "${{ secrets.GITHUB_TOKEN }}"

View File

@ -23,6 +23,6 @@ jobs:
uses: aglipanci/laravel-pint-action@2.6
- name: Commit changes
uses: stefanzweifel/git-auto-commit-action@v7
uses: stefanzweifel/git-auto-commit-action@v6
with:
commit_message: Fix styling

View File

@ -2,15 +2,6 @@
A Laravel package for interacting with the Bitunix cryptocurrency exchange API.
---
[![Latest Stable Version](https://poser.pugx.org/mahdimsr/laravel-bitunix-api/v/stable)](https://packagist.org/packages/msr/laravel-bitunix-api)
[![Fix PHP code style issues](https://github.com/mahdimsr/laravel-bitunix-api/actions/workflows/fix-php-code-style-issues.yml/badge.svg)](https://github.com/mahdimsr/laravel-bitunix-api/actions/workflows/fix-php-code-style-issues.yml)
[![PHPStan](https://github.com/mahdimsr/laravel-bitunix-api/actions/workflows/phpstan.yml/badge.svg)](https://github.com/mahdimsr/laravel-bitunix-api/actions/workflows/phpstan.yml)
[![run-tests](https://github.com/mahdimsr/laravel-bitunix-api/actions/workflows/run-tests.yml/badge.svg)](https://github.com/mahdimsr/laravel-bitunix-api/actions/workflows/run-tests.yml)
[![License](https://poser.pugx.org/mahdimsr/laravel-bitunix-api/license)](https://packagist.org/packages/msr/laravel-bitunix-api)
## Installation
```bash

View File

@ -1,5 +1,5 @@
{
"name": "moltox/laravel-bitunix-api",
"name": "mahdimsr/laravel-bitunix-api",
"description": "composer package for using bitunix api trading",
"keywords": [
"msr",
@ -13,22 +13,17 @@
"name": "mahdi mansouri",
"email": "mahdi.msr4@gmail.com",
"role": "Developer"
},
{
"name": "Maik Mueller ",
"email": "mueller.maik1@gmail.com",
"role": "Developer"
}
],
"require": {
"php": "^8.4",
"spatie/laravel-package-tools": "^1.16",
"illuminate/contracts": "^10.0||^11.0||^12.0||^13.0"
"illuminate/contracts": "^11.0||^12.0||^10.0"
},
"require-dev": {
"larastan/larastan": "^3.0",
"laravel/pint": "^1.29",
"laravel/pint": "^1.14",
"nunomaduro/collision": "^8.8",
"larastan/larastan": "^3.0",
"orchestra/testbench": "^10.0.0||^9.0.0",
"pestphp/pest": "^4.0",
"pestphp/pest-plugin-arch": "^4.0",
@ -55,8 +50,7 @@
"analyse": "vendor/bin/phpstan analyse",
"test": "vendor/bin/pest",
"test-coverage": "vendor/bin/pest --coverage",
"format": "vendor/bin/pint",
"pint": "vendor/bin/pint --ansi"
"format": "vendor/bin/pint"
},
"config": {
"sort-packages": true,
@ -75,7 +69,7 @@
}
}
},
"version": "1.2.3",
"version": "1.1.0",
"minimum-stability": "stable",
"prefer-stable": true
}

View File

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

View File

@ -3,14 +3,10 @@
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;
@ -20,11 +16,11 @@ use Msr\LaravelBitunixApi\Requests\PlacePositionTpSlOrderRequestContract;
use Msr\LaravelBitunixApi\Requests\PlaceTpSlOrderRequestContract;
use Psr\Http\Message\ResponseInterface;
class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginModeRequestContract, FlashClosePositionRequestContract, FutureKLineRequestContract, GetHistoryPositionsRequestContract, GetHistoryTradesRequestContract, GetPendingPositionsRequestContract, GetSingleAccountRequestContract, GetTradingPairsRequestContract, PlaceOrderRequestContract, PlacePositionTpSlOrderRequestContract, PlaceTpSlOrderRequestContract
class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginModeRequestContract, FlashClosePositionRequestContract, FutureKLineRequestContract, GetPendingPositionsRequestContract, GetSingleAccountRequestContract, GetTradingPairsRequestContract, PlaceOrderRequestContract, PlacePositionTpSlOrderRequestContract, PlaceTpSlOrderRequestContract
{
private Client $publicFutureClient;
public function __construct(protected RateLimiter $rateLimiter)
public function __construct()
{
$this->publicFutureClient = new Client([
'base_uri' => config('bitunix-api.future_base_uri').'/api/v1/futures/market/',
@ -42,14 +38,8 @@ class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginMo
]);
}
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,
@ -198,54 +188,6 @@ 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 = [];
@ -265,45 +207,6 @@ 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 = [
@ -402,13 +305,10 @@ class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginMo
$body['slStopType'] = $slStopType;
}
return $this->getPrivateFutureClient([], $body)->post('tpsl/position/place_order', [
$response = $this->getPrivateFutureClient([], $body)->post('tpsl/position/place_order', [
'json' => $body,
]);
}
protected function resolveRateLimitIdentity(): string
{
return (string) config('bitunix-api.api_key');
return $response;
}
}

View File

@ -2,22 +2,17 @@
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;
@ -52,13 +47,5 @@ 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()
);
});
}
}

View File

@ -1,16 +0,0 @@
<?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;
}

View File

@ -1,18 +0,0 @@
<?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;
}

View File

@ -1,56 +0,0 @@
<?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)
);
}
}