SP-1167 - Add support for PHP 8.4

Author: swlodarski-sumoheavy

.github/workflows/documentation.yml

@@ -3,7 +3,7 @@ name: Documentation
 on:
   push:
     branches:
-      - '*.*.x'
+      - "*.*.x"
 
 concurrency:
   group: documentation
@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Run phpdoc
         run: |
           docker run --rm -v $(pwd):/data phpdoc/phpdoc:3 -d ./src -t ./docs
@@ -24,4 +24,4 @@ jobs:
           git config user.email ""
           git add docs/
           git commit -m "Update phpdoc" || echo "No changes to commit"
-          git push
+          git push

.github/workflows/test.yml

@@ -3,21 +3,20 @@ name: Test
 on: [push, pull_request]
 
 jobs:
-
   phpunit10:
     runs-on: ubuntu-20.04
 
     strategy:
       matrix:
-        php-version: ['8.1', '8.2', '8.3']
+        php-version: ["8.1", "8.2", "8.3", "8.4"]
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: php-actions/composer@v5
+      - uses: actions/checkout@v4
+      - uses: php-actions/composer@v6
         with:
           php_version: ${{ matrix.php-version }}
           args: --ignore-platform-reqs
-      - uses: php-actions/phpunit@v3
+      - uses: php-actions/phpunit@v4
         with:
           configuration: phpunit.xml
           php_version: ${{ matrix.php-version }}
@@ -31,12 +30,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: php-actions/composer@v5
+      - uses: actions/checkout@v4
+      - uses: php-actions/composer@v6
         with:
           php_version: 8.1
           php_extensions: bcmath gmp xdebug
       - name: Install PHP_CodeSniffer
         run: |
           curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
-          php phpcs.phar src --standard=ruleset.xml
+          php phpcs.phar src --standard=ruleset.xml

composer.json

@@ -12,13 +12,13 @@
   ],
   "homepage": "https://github.com/bitpay/php-bitpay-client-v2",
   "require": {
-    "php": "^8.1 || ^8.2 || ^8.3",
+    "php": "^8.1 || ^8.2 || ^8.3 || ^8.4",
     "ext-json": "*",
     "ext-reflection": "*",
     "bitpay/key-utils": "^2.0",
     "guzzlehttp/guzzle": "^7.0",
-    "symfony/yaml": "^5.4 || ^6.0 || ^7.0",
-    "netresearch/jsonmapper": "^4.1",
+    "symfony/yaml": "^6.0 || ^7.0",
+    "netresearch/jsonmapper": "^5.0",
     "symfony/console": "^6.0"
   },
   "authors": [
@@ -28,7 +28,7 @@
     }
   ],
   "require-dev": {
-    "phpunit/phpunit": "^9.0 || ^10.2.2"
+    "phpunit/phpunit": "^10.5.45 || ^11.5.7 || ^12.0.2"
   },
   "scripts": {
     "setup": [

composer.lock

@@ -90,7 +90,7 @@ function selectTokens(OutputInterface $output, mixed $helper, InputInterface $in
         $shouldGenerateMerchant = true;
         $shouldGeneratePayout = true;
     }
-    
+
     return [$shouldGenerateMerchant, $shouldGeneratePayout];
 }
 
@@ -144,6 +144,9 @@ function getPublicKey(string $privateKeyLocation, string $password): PublicKey {
     $storageEngine = new EncryptedFilesystemStorage($password);
     try {
         //  Use the EncryptedFilesystemStorage to load the Merchant's encrypted private key with the Master Password.
+        /**
+         * @var PrivateKey
+         */
         $privateKey = $storageEngine->load($privateKeyLocation);
     } catch (\Exception $ex) {
         //  Check if the loaded keys is a valid key
@@ -255,13 +258,13 @@ function getPayoutToken(
     ->setHelp($help)
     ->setCode(function (InputInterface $input, OutputInterface $output): int {
         $helper = $this->getHelper('question');
-        
+
         try {
             $env = getEnv($output, $helper, $input);
             $apiUrl = $env === 'P' ? 'https://bitpay.com' : 'https://test.bitpay.com';
             $password = getPrivateKeyPassword($helper, $input, $output);
             $privateKeyLocation = getPrivateKeyLocation($helper, $input, $output);
-            
+
             [$shouldGenerateMerchant, $shouldGeneratePayout] = selectTokens($output, $helper, $input);
             $publicKey = getPublicKey($privateKeyLocation, $password);
             $sin = getSin($publicKey);

setup/ConfigGenerator.php

@@ -257,10 +257,10 @@ public function getInvoiceByGuid(
     public function getInvoices(
         string $dateStart,
         string $dateEnd,
-        string $status = null,
-        string $orderId = null,
-        int $limit = null,
-        int $offset = null
+        ?string $status = null,
+        ?string $orderId = null,
+        ?int $limit = null,
+        ?int $offset = null
     ): array {
         $invoiceClient = $this->getInvoiceClient();
 
@@ -581,7 +581,7 @@ public function getBill(string $billId, string $facade = Facade::MERCHANT, bool
      * @throws BitPayApiException
      * @throws BitPayGenericException
      */
-    public function getBills(string $status = null): array
+    public function getBills(?string $status = null): array
     {
         $billClient = $this->getBillClient();
 
@@ -762,7 +762,7 @@ public function getPayoutRecipient(string $recipientId): PayoutRecipient
      * @throws BitPayApiException
      * @throws BitPayGenericException
      */
-    public function getPayoutRecipients(string $status = null, int $limit = null, int $offset = null): array
+    public function getPayoutRecipients(?string $status = null, ?int $limit = null, ?int $offset = null): array
     {
         $payoutRecipientsClient = $this->getPayoutRecipientsClient();
 
@@ -874,12 +874,12 @@ public function getPayout(string $payoutId): Payout
      * @throws BitPayApiException
      */
     public function getPayouts(
-        string $startDate = null,
-        string $endDate = null,
-        string $status = null,
-        string $reference = null,
-        int $limit = null,
-        int $offset = null
+        ?string $startDate = null,
+        ?string $endDate = null,
+        ?string $status = null,
+        ?string $reference = null,
+        ?int $limit = null,
+        ?int $offset = null
     ): array {
         $payoutClient = $this->getPayoutClient();
 
@@ -972,9 +972,9 @@ public function getSettlements(
         string $currency,
         string $dateStart,
         string $dateEnd,
-        string $status = null,
-        int $limit = null,
-        int $offset = null
+        ?string $status = null,
+        ?int $limit = null,
+        ?int $offset = null
     ): array {
         $settlementsClient = $this->getSettlementClient();
 

src/BitPaySDK/Client.php

@@ -108,7 +108,7 @@ public function get(string $billId, string $facade = Facade::MERCHANT, bool $sig
      * @throws BitPayApiException
      * @throws BitPayGenericException
      */
-    public function getBills(string $status = null): array
+    public function getBills(?string $status = null): array
     {
         $params = [];
         $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);

src/BitPaySDK/Client/BillClient.php

@@ -210,10 +210,10 @@ public function getByGuid(
     public function getInvoices(
         string $dateStart,
         string $dateEnd,
-        string $status = null,
-        string $orderId = null,
-        int $limit = null,
-        int $offset = null
+        ?string $status = null,
+        ?string $orderId = null,
+        ?int $limit = null,
+        ?int $offset = null
     ): array {
         $params = [];
         $params["token"] = $this->tokenCache->getTokenByFacade(Facade::MERCHANT);

src/BitPaySDK/Client/InvoiceClient.php

@@ -125,12 +125,12 @@ public function get(string $payoutId): Payout
      * @throws BitPayGenericException
      */
     public function getPayouts(
-        string $startDate = null,
-        string $endDate = null,
-        string $status = null,
-        string $reference = null,
-        int $limit = null,
-        int $offset = null
+        ?string $startDate = null,
+        ?string $endDate = null,
+        ?string $status = null,
+        ?string $reference = null,
+        ?int $limit = null,
+        ?int $offset = null
     ): array {
         $params = [];
         $params["token"] = $this->tokenCache->getTokenByFacade(Facade::PAYOUT);

src/BitPaySDK/Client/PayoutClient.php

@@ -121,7 +121,7 @@ public function get(string $recipientId): PayoutRecipient
      * @throws BitPayApiException
      * @throws BitPayGenericException
      */
-    public function getPayoutRecipients(string $status = null, int $limit = null, int $offset = null): array
+    public function getPayoutRecipients(?string $status = null, ?int $limit = null, ?int $offset = null): array
     {
         $params = [];
         $params["token"] = $this->tokenCache->getTokenByFacade(Facade::PAYOUT);