add docs

Author: rez1dent3

docs/_sidebar.md

@@ -13,7 +13,7 @@
     - [Transfer](transfer)
     - [Refresh balance](refresh)
     - [Confirm](confirm)
-    - [Exchange](exchange)
+<!--    - [Exchange](exchange)-->
     - [Withdraw taxing](taxing)
 
 - Purchases
@@ -29,8 +29,8 @@
     - [New Wallet](new-wallet)
     - [Transfer](wallet-transfer)
 
-- Currencies
+<!--- Currencies-->
 
-    - [Rate Service](rate)
-    - [Create Wallet](rate-wallet)
-    - [Taxing](rate-taxing)
+<!--    - [Rate Service](rate)-->
+<!--    - [Create Wallet](rate-wallet)-->
+<!--    - [Taxing](rate-taxing)-->

docs/confirm.md

@@ -16,6 +16,9 @@ class UserConfirm extends Model implements Wallet, Confirmable
 
 ### Example:
 
+Sometimes you need to create an operation and confirm its field. 
+That is what this trey does.
+
 ```php
 $user->balance; // int(0)
 $transaction = $user->deposit(100, null, false); // not confirm

docs/exchange.md

@@ -0,0 +1,4 @@
+### Exchange
+
+A description of this feature will appear later. Wait! 
+For now you can study to see the code in the unit test.

docs/gift.md

@@ -0,0 +1,90 @@
+## User Model
+
+Add the `CanPay` trait and `Customer` interface to your User model.
+
+```php
+use Bavix\Wallet\Traits\CanPay;
+use Bavix\Wallet\Interfaces\Customer;
+
+class User extends Model implements Customer
+{
+    use CanPay;
+}
+```
+
+## Item Model
+
+Add the `HasWallet` trait and `Product` interface to Item model.
+
+```php
+use Bavix\Wallet\Traits\HasWallet;
+use Bavix\Wallet\Interfaces\Product;
+use Bavix\Wallet\Interfaces\Customer;
+
+class Item extends Model implements Product
+{
+    use HasWallet;
+
+    public function canBuy(Customer $customer, int $quantity = 1, bool $force = null): bool
+    {
+        /**
+         * If the service can be purchased once, then
+         *  return !$customer->paid($this);
+         */
+        return true; 
+    }
+
+    public function getAmountProduct(): int
+    {
+        return 100;
+    }
+
+    public function getMetaProduct(): ?array
+    {
+        return [
+            'title' => $this->title, 
+            'description' => 'Purchase of Product #' . $this->id, 
+            'price' => $this->getAmountProduct(),
+        ];
+    }
+    
+    public function getUniqueId(): string
+    {
+        return (string)$this->getKey();
+    }
+}
+```
+
+## Santa Claus, give gifts
+
+Find the user's and check the balance.
+
+```php
+$first = User::first(); 
+$last = User::orderBy('id', 'desc')->first(); // last user
+$first->getKey() !== $last->getKey(); // true
+
+$first->balance; // int(115)
+$last->balance; // int(0)
+```
+
+One user wants to give a gift to another.
+Find the product.
+
+```php
+$item = Item::first();
+$item->getAmountProduct(); // int(100)
+$item->balance; // int(0)
+```
+
+The first user buys the product and gives it.
+
+```php
+$first->gift($last, $item);
+(bool)$last->paid($item, true); // bool(true)
+$first->balance; // int(15)
+$last->balance; // int(0)
+$item->balance; // int(100)
+```
+
+It worked! 

docs/taxing.md

@@ -0,0 +1,187 @@
+## User Model
+
+Add the `CanPay` trait and `Customer` interface to your User model.
+
+```php
+use Bavix\Wallet\Traits\CanPay;
+use Bavix\Wallet\Interfaces\Customer;
+
+class User extends Model implements Customer
+{
+    use CanPay;
+}
+```
+
+## Item Model
+
+Add the `HasWallet` trait and `Product` interface to Item model.
+
+```php
+use Bavix\Wallet\Traits\HasWallet;
+use Bavix\Wallet\Interfaces\Product;
+use Bavix\Wallet\Interfaces\Customer;
+use Bavix\Wallet\Interfaces\Taxable;
+
+class Item extends Model implements Product, Taxable
+{
+    use HasWallet;
+
+    public function canBuy(Customer $customer, int $quantity = 1, bool $force = null): bool
+    {
+        /**
+         * If the service can be purchased once, then
+         *  return !$customer->paid($this);
+         */
+        return true; 
+    }
+
+    public function getAmountProduct(): int
+    {
+        return 100;
+    }
+
+    public function getMetaProduct(): ?array
+    {
+        return [
+            'title' => $this->title, 
+            'description' => 'Purchase of Product #' . $this->id, 
+            'price' => $this->getAmountProduct(),
+        ];
+    }
+    
+    public function getUniqueId(): string
+    {
+        return (string)$this->getKey();
+    }
+    
+    public function getFeePercent() : float
+    {
+        return 0.03; // 3%    
+    }
+}
+```
+
+## Tax process
+
+Find the user and check the balance.
+
+```php
+$user = User::first();
+$user->balance; // int(103)
+```
+
+Find the goods and check the cost.
+
+```php
+$item = Item::first();
+$item->getAmountProduct(); // int(100)
+```
+
+The user can buy a product, buy...
+
+```php
+$user->pay($item); // success, 100 (product) + 3 (fee) = 103
+$user->balance; // int(0)
+```
+
+## Minimal Taxing
+
+Add trait `MinimalTaxable` in class `Item`.
+
+```php
+use Bavix\Wallet\Traits\HasWallet;
+use Bavix\Wallet\Interfaces\Product;
+use Bavix\Wallet\Interfaces\Customer;
+use Bavix\Wallet\Interfaces\MinimalTaxable;
+
+class Item extends Model implements Product, MinimalTaxable
+{
+    use HasWallet;
+
+    public function canBuy(Customer $customer, int $quantity = 1, bool $force = null): bool
+    {
+        /**
+         * If the service can be purchased once, then
+         *  return !$customer->paid($this);
+         */
+        return true; 
+    }
+
+    public function getAmountProduct(): int
+    {
+        return 100;
+    }
+
+    public function getMetaProduct(): ?array
+    {
+        return [
+            'title' => $this->title, 
+            'description' => 'Purchase of Product #' . $this->id, 
+            'price' => $this->getAmountProduct(),
+        ];
+    }
+    
+    public function getUniqueId(): string
+    {
+        return (string)$this->getKey();
+    }
+    
+    public function getFeePercent() : float
+    {
+        return 0.03; // 3%    
+    }
+    
+    public function getMinimalFee() : int
+    {
+        return 5; // 3%, minimum int(5)    
+    }
+}
+```
+
+#### Successfully
+
+Find the user and check the balance.
+
+```php
+$user = User::first();
+$user->balance; // int(105)
+```
+
+Find the goods and check the cost.
+
+```php
+$item = Item::first();
+$item->getAmountProduct(); // int(100)
+```
+
+The user can buy a product, buy...
+
+```php
+$user->pay($item); // failed, 100 (product) + 5 (minimal fee) = 105
+$user->balance; // int(0)
+```
+
+#### Failed
+
+Find the user and check the balance.
+
+```php
+$user = User::first();
+$user->balance; // int(103)
+```
+
+Find the goods and check the cost.
+
+```php
+$item = Item::first();
+$item->getAmountProduct(); // int(100)
+```
+
+The user can buy a product, buy...
+
+```php
+$user->safePay($item); // failed, 100 (product) + 5 (minimal fee) = 105
+$user->balance; // int(103)
+```
+
+It worked!