Merge pull request #21 from polymarket-php/chore(deps)/rector-php

Chore(deps)/rector-php

Added rector-php for proper code quality.
- Used highest configuration rules
- Added github action for rector

Author: danielgnh

.github/workflows/lint.yml

@@ -40,4 +40,4 @@ jobs:
         run: composer install --prefer-dist --no-progress --no-interaction
 
       - name: Run PHP CS Fixer
-        run: composer cs-check
+        run: vendor/bin/php-cs-fixer fix --dry-run --diff

.github/workflows/rector.yml

@@ -0,0 +1,43 @@
+name: Rector
+
+on:
+  push:
+    branches: [ main, dev ]
+  pull_request:
+    branches: [ main, dev ]
+
+jobs:
+  rector:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    name: Rector Analysis
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.4'
+          coverage: none
+          tools: composer:v2
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress --no-interaction
+
+      - name: Run Rector
+        run: vendor/bin/rector process --dry-run

.gitignore

@@ -2,6 +2,7 @@
 composer.lock
 .phpunit.result.cache
 .php-cs-fixer.cache
+.rector-cache
 .phpunit.cache
 .idea/
 *.log

composer.json

@@ -25,6 +25,7 @@
         "pestphp/pest": "^4.1",
         "pestphp/pest-plugin-arch": "^4.0",
         "phpstan/phpstan": "^2.1",
+        "rector/rector": "^2.3",
         "symfony/var-dumper": "^7.3"
     },
     "autoload": {
@@ -47,8 +48,14 @@
         "test": "pest --parallel",
         "test-coverage": "pest --coverage",
         "phpstan": "phpstan analyse",
-        "cs-fix": "php-cs-fixer fix",
-        "cs-check": "php-cs-fixer fix --dry-run --diff"
+        "format": [
+            "php-cs-fixer fix",
+            "vendor/bin/rector"
+        ],
+        "format-check": [
+            "php-cs-fixer fix --dry-run --diff",
+            "rector process --dry-run"
+        ]
     },
     "config": {
         "sort-packages": true,

examples/gamma.php

@@ -5,8 +5,6 @@
 require_once __DIR__ . '/../vendor/autoload.php';
 
 use Danielgnh\PolymarketPhp\Client;
-use Danielgnh\PolymarketPhp\Enums\OrderSide;
-use Danielgnh\PolymarketPhp\Enums\OrderType;
 use Danielgnh\PolymarketPhp\Exceptions\PolymarketException;
 
 $client = new Client();

rector.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Validation\Rule;
+use Rector\Config\RectorConfig;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddVoidReturnTypeWhereNoReturnRector;
+use Rector\TypeDeclaration\Rector\StmtsAwareInterface\DeclareStrictTypesRector;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/examples',
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->withPhpSets(php81: true)
+    ->withTypeCoverageLevel(37)
+    ->withDeadCodeLevel(50)
+    ->withCodeQualityLevel(71)
+    ->withImportNames(
+        importShortClasses: false,
+        removeUnusedImports: true,
+    )
+    ->withRules([
+        DeclareStrictTypesRector::class,
+    ])
+    ->withParallel(
+        timeoutSeconds: 120,
+        maxNumberOfProcess: 16,
+        jobSize: 16,
+    )
+    ->withCache(__DIR__ . '/.rector-cache');

src/Auth/ClobAuthenticator.php

@@ -110,7 +110,7 @@ public function deriveApiKey(int $nonce = 0): ApiCredentials
      */
     public function generateL1Headers(int $nonce = 0, ?int $timestamp = null): array
     {
-        $timestamp = $timestamp ?? time();
+        $timestamp ??= time();
         $signature = $this->signer->signClobAuth($timestamp, $nonce);
 
         return [
@@ -134,11 +134,11 @@ public function generateL2Headers(
         ?string $body = null,
         ?int $timestamp = null
     ): array {
-        if ($this->credentials === null) {
+        if (!$this->credentials instanceof ApiCredentials) {
             throw ClobAuthenticationException::notSetup();
         }
 
-        $timestamp = $timestamp ?? time();
+        $timestamp ??= time();
 
         $signature = HmacSigner::sign(
             (string) $timestamp,
@@ -162,7 +162,7 @@ public function generateL2Headers(
      */
     public function hasCredentials(): bool
     {
-        return $this->credentials !== null;
+        return $this->credentials instanceof ApiCredentials;
     }
 
     /**

src/Auth/Signer/Eip712Signer.php

@@ -19,7 +19,7 @@
  */
 class Eip712Signer
 {
-    private string $privateKey;
+    private readonly string $privateKey;
 
     private Address $ethAddress;
 
@@ -28,16 +28,13 @@ public function getAddress(): string
         return '0x' . $this->ethAddress->get();
     }
 
-    private int $chainId;
-
     /**
      * @throws SigningException
      * @throws ClobAuthenticationException
      */
-    public function __construct(string $privateKey, int $chainId = 137)
+    public function __construct(string $privateKey, private readonly int $chainId = 137)
     {
         $this->privateKey = $this->normalizePrivateKey($privateKey);
-        $this->chainId = $chainId;
 
         try {
             $this->ethAddress = new Address(substr($this->privateKey, 2));
@@ -137,7 +134,6 @@ private function buildTypes(): array
      * @param array<string, array<array{name: string, type: string}>>                $types
      * @param array{address: string, timestamp: string, nonce: int, message: string} $message
      *
-     * @return string
      * @throws Exception
      */
     private function hashTypedData(array $domain, array $types, array $message): string
@@ -164,11 +160,9 @@ private function hashTypedData(array $domain, array $types, array $message): str
     /**
      * Hash a struct according to EIP-712.
      *
-     * @param string                                   $typeName
      * @param array<array{name: string, type: string}> $types
      * @param array<string, mixed>                     $data
      *
-     * @return string
      *
      * @throws Exception
      */
@@ -242,7 +236,6 @@ private function encodeValue(string $type, mixed $value): string
 
     /**
      * @param  string  $hash  Hash to sign (with 0x prefix)
-     * @return string
      */
     private function signHash(string $hash): string
     {

src/Bridge.php

@@ -19,12 +19,8 @@
  */
 class Bridge
 {
-    private HttpClientInterface $httpClient;
+    private readonly HttpClientInterface $httpClient;
 
-    /**
-     * @param Config                   $config
-     * @param HttpClientInterface|null $httpClient
-     */
     public function __construct(
         private readonly Config $config,
         ?HttpClientInterface $httpClient = null
@@ -34,8 +30,6 @@ public function __construct(
 
     /**
      * Access deposit operations for generating cross-chain deposit addresses.
-     *
-     * @return Deposits
      */
     public function deposits(): Deposits
     {

src/Client.php

@@ -12,7 +12,7 @@
 
 class Client
 {
-    private Config $config;
+    private readonly Config $config;
 
     private ?Gamma $gammaClient = null;
 
@@ -34,15 +34,15 @@ public function __construct(
     ) {
         $this->config = new Config($apiKey, $options);
 
-        if ($gammaHttpClient !== null) {
+        if ($gammaHttpClient instanceof HttpClientInterface) {
             $this->gammaClient = new Gamma($this->config, $gammaHttpClient);
         }
 
-        if ($clobHttpClient !== null) {
+        if ($clobHttpClient instanceof HttpClientInterface) {
             $this->clobClient = new Clob($this->config, $clobHttpClient);
         }
 
-        if ($bridgeHttpClient !== null) {
+        if ($bridgeHttpClient instanceof HttpClientInterface) {
             $this->bridgeClient = new Bridge($this->config, $bridgeHttpClient);
         }
     }
@@ -84,7 +84,7 @@ public function auth(
 
     public function gamma(): Gamma
     {
-        if ($this->gammaClient === null) {
+        if (!$this->gammaClient instanceof Gamma) {
             $this->gammaClient = new Gamma($this->config);
         }
 
@@ -93,7 +93,7 @@ public function gamma(): Gamma
 
     public function clob(): Clob
     {
-        if ($this->clobClient === null) {
+        if (!$this->clobClient instanceof Clob) {
             $this->clobClient = new Clob(
                 $this->config,
                 null,
@@ -106,12 +106,10 @@ public function clob(): Clob
 
     /**
      * Get Bridge API client for cross-chain deposits.
-     *
-     * @return Bridge
      */
     public function bridge(): Bridge
     {
-        if ($this->bridgeClient === null) {
+        if (!$this->bridgeClient instanceof Bridge) {
             $this->bridgeClient = new Bridge($this->config);
         }