[11.4] Feature New TaxInterface

config/config.php

@@ -49,6 +49,7 @@
 use Bavix\Wallet\Services\PrepareService;
 use Bavix\Wallet\Services\PurchaseService;
 use Bavix\Wallet\Services\RegulatorService;
+use Bavix\Wallet\Services\TaxCollectionService;
 use Bavix\Wallet\Services\TaxService;
 use Bavix\Wallet\Services\TransactionService;
 use Bavix\Wallet\Services\TransferService;
@@ -265,6 +266,8 @@
         'purchase' => PurchaseService::class,
         // Service for handling tax operations.
         'tax' => TaxService::class,
+        // Service for handling tax collection operations.
+        'tax_collection' => TaxCollectionService::class,
         // Service for handling transaction operations.
         'transaction' => TransactionService::class,
         // Service for handling transfer operations.

src/External/Enums/TransactionType.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\External\Enums;
+
+use Bavix\Wallet\Models\Transaction;
+
+enum TransactionType: string
+{
+    case Deposit = Transaction::TYPE_DEPOSIT;
+    case Withdraw = Transaction::TYPE_WITHDRAW;
+}

src/Interfaces/MaximalTaxable.php

@@ -4,6 +4,10 @@
 
 namespace Bavix\Wallet\Interfaces;
 
+/**
+ * @deprecated Use TaxConstraintsInterface.
+ * @see TaxConstraintsInterface
+ */
 interface MaximalTaxable extends Taxable
 {
     /**

src/Interfaces/MinimalTaxable.php

@@ -4,6 +4,10 @@
 
 namespace Bavix\Wallet\Interfaces;
 
+/**
+ * @deprecated Use TaxConstraintsInterface.
+ * @see TaxConstraintsInterface
+ */
 interface MinimalTaxable extends Taxable
 {
     /**

src/Interfaces/TaxConstraintsInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\Interfaces;
+
+use Bavix\Wallet\External\Enums\TransactionType;
+
+interface TaxConstraintsInterface extends TaxInterface
+{
+    public function getMinimumTax(TransactionType $enum): float|int|null;
+
+    public function getMaximumTax(TransactionType $enum): float|int|null;
+}

src/Interfaces/TaxInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\Interfaces;
+
+use Bavix\Wallet\External\Enums\TransactionType;
+
+interface TaxInterface
+{
+    public function getTaxPercent(TransactionType $enum): float|int;
+}

src/Interfaces/Taxable.php

@@ -4,6 +4,10 @@
 
 namespace Bavix\Wallet\Interfaces;
 
+/**
+ * @deprecated Use TaxInterface.
+ * @see TaxInterface
+ */
 interface Taxable
 {
     /**

src/Services/TaxCollectionService.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\Services;
+
+use Bavix\Wallet\External\Enums\TransactionType;
+use Bavix\Wallet\Interfaces\TaxConstraintsInterface;
+use Bavix\Wallet\Interfaces\TaxInterface;
+use Bavix\Wallet\Interfaces\Wallet;
+use Bavix\Wallet\Internal\Service\MathServiceInterface;
+
+/**
+ * @internal
+ */
+final readonly class TaxCollectionService implements TaxCollectionServiceInterface
+{
+    public function __construct(
+        private MathServiceInterface $mathService,
+        private CastServiceInterface $castService,
+    ) {
+    }
+
+    public function calculate(TransactionType $type, Wallet $wallet, float|int|string $amount): string
+    {
+        $feePercent = null;
+        if ($wallet instanceof TaxInterface) {
+            $feePercent = $wallet->getTaxPercent($type);
+        }
+
+        $feeMinimum = null;
+        $feeMaximum = null;
+        if ($wallet instanceof TaxConstraintsInterface) {
+            $feeMinimum = $wallet->getMinimumTax($type);
+            $feeMaximum = $wallet->getMaximumTax($type);
+        }
+
+        $fee = 0;
+        if ($feePercent !== null) {
+            $fee = $this->mathService->floor(
+                $this->mathService->div(
+                    $this->mathService->mul($amount, $feePercent, 0),
+                    100,
+                    $this->castService->getWallet($wallet)
+                        ->decimal_places
+                )
+            );
+        }
+
+        if ($feeMinimum !== null && $this->mathService->compare($fee, $feeMinimum) === -1) {
+            $fee = $feeMinimum;
+        }
+
+        if ($feeMaximum !== null && $this->mathService->compare($feeMaximum, $fee) === -1) {
+            $fee = $feeMaximum;
+        }
+
+        return (string) $fee;
+    }
+}

src/Services/TaxCollectionServiceInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\Services;
+
+use Bavix\Wallet\External\Enums\TransactionType;
+use Bavix\Wallet\Interfaces\Wallet;
+
+/**
+ * @api
+ */
+interface TaxCollectionServiceInterface
+{
+    public function calculate(TransactionType $type, Wallet $wallet, float|int|string $amount): string;
+}

src/Services/TaxService.php

@@ -4,25 +4,36 @@
 
 namespace Bavix\Wallet\Services;
 
+use Bavix\Wallet\External\Enums\TransactionType;
 use Bavix\Wallet\Interfaces\MaximalTaxable;
 use Bavix\Wallet\Interfaces\MinimalTaxable;
 use Bavix\Wallet\Interfaces\Taxable;
+use Bavix\Wallet\Interfaces\TaxInterface;
 use Bavix\Wallet\Interfaces\Wallet;
 use Bavix\Wallet\Internal\Service\MathServiceInterface;
 
 /**
  * @internal
+ *
+ * @deprecated use TaxCollectionServiceInterface instead.
+ * @see TaxCollectionServiceInterface
  */
 final readonly class TaxService implements TaxServiceInterface
 {
     public function __construct(
         private MathServiceInterface $mathService,
-        private CastServiceInterface $castService
+        private CastServiceInterface $castService,
+        private TaxCollectionServiceInterface $taxCollectionService
     ) {
     }
 
     public function getFee(Wallet $wallet, float|int|string $amount): string
     {
+        if ($wallet instanceof TaxInterface) {
+            return $this->taxCollectionService->calculate(TransactionType::Withdraw, $wallet, $amount);
+        }
+
+        // backward compatibility
         $fee = 0;
         if ($wallet instanceof Taxable) {
             $fee = $this->mathService->floor(

src/WalletServiceProvider.php

@@ -102,6 +102,8 @@
 use Bavix\Wallet\Services\PurchaseServiceInterface;
 use Bavix\Wallet\Services\RegulatorService;
 use Bavix\Wallet\Services\RegulatorServiceInterface;
+use Bavix\Wallet\Services\TaxCollectionService;
+use Bavix\Wallet\Services\TaxCollectionServiceInterface;
 use Bavix\Wallet\Services\TaxService;
 use Bavix\Wallet\Services\TaxServiceInterface;
 use Bavix\Wallet\Services\TransactionService;
@@ -285,6 +287,10 @@ private function services(array $configure, array $cache): void
         $this->app->singleton(FormatterServiceInterface::class, $configure['formatter'] ?? FormatterService::class);
         $this->app->singleton(PrepareServiceInterface::class, $configure['prepare'] ?? PrepareService::class);
         $this->app->singleton(PurchaseServiceInterface::class, $configure['purchase'] ?? PurchaseService::class);
+        $this->app->singleton(
+            TaxCollectionServiceInterface::class,
+            $configure['tax_collection'] ?? TaxCollectionService::class
+        );
         $this->app->singleton(TaxServiceInterface::class, $configure['tax'] ?? TaxService::class);
         $this->app->singleton(
             TransactionServiceInterface::class,
@@ -479,6 +485,7 @@ private function servicesProviders(): array
             FormatterServiceInterface::class,
             PrepareServiceInterface::class,
             PurchaseServiceInterface::class,
+            TaxCollectionServiceInterface::class,
             TaxServiceInterface::class,
             TransactionServiceInterface::class,
             TransferServiceInterface::class,