Feature New TaxInterface

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;
+
+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 $fee;
+    }
+}

src/Services/TaxCollectionServiceInterface.php

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