upgrade docs

rez1dent3 · rez1dent3 · commit efba949b9ac5 · 2024-03-13T23:45:57.000+03:00
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -55,6 +55,9 @@
   - [Wallet Swap](laravel-wallet-swap)
   - [Wallet UUID](laravel-wallet-uuid)
 
+- Helpers
+  - [Formatter](formatter)
+
 - Events
     
     - [BalanceUpdatedEvent](balance-updated-event)
@@ -65,7 +68,3 @@
 - CQRS
 
     - [Create Wallet](command-create-wallet)
-
-- Nova
-
-  - [Change of balance](nova-action)
diff --git a/docs/atomic-service.md b/docs/atomic-service.md
@@ -2,8 +2,6 @@
 
 Working with atomic wallet operations.
 
-> You need wallet version 9.2 or higher
-
 Before you start working with atomicity, you need to study the "Race Condition" section and configure the lock.
 
 Sometimes it is necessary to apply actions to the user and the wallet atomically. For example, you want to raise an ad in the search and withdraw money from your wallet.
@@ -39,4 +37,4 @@ app(AtomicServiceInterface::class)->blocks([$wallet1, $wallet2], function () use
 
 In this case, we blocked both wallets and started the process of debiting funds. Debiting from both wallets will be considered a successful operation. If there are not enough funds on some wallet, the operation is canceled.
 
-It worked! 
+It's simple!
diff --git a/docs/balance-updated-event.md b/docs/balance-updated-event.md
@@ -30,4 +30,4 @@ class MyBalanceUpdatedListener
 }
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/batch-transactions.md b/docs/batch-transactions.md
@@ -1,7 +1,5 @@
 ### API. Batch Transactions
 
-> Since version 9.5+
-
 Sometimes situations arise when there is a need to make multiple changes to wallets.
 For example, we need to change the balance of many wallets at once. For example, the system administrator accrues a bonus for participating in some promotion. Previously, the code would look like this:
 ```php
@@ -107,5 +105,5 @@ TransactionFloatQuery::createWithdraw($wallet, $amountFloat, null, uuid: '6e87db
 ```
 
 ---
-It worked! 
+It's simple!
 
diff --git a/docs/batch-transfers.md b/docs/batch-transfers.md
@@ -1,7 +1,5 @@
 ### API. Batch Transfers
 
-> Since version 9.5+
-
 If you need multiple transfers between wallets, you can use a high-performance handle. It is worth remembering that the pen does not check the balance of the wallet before transferring, you need to take care of this yourself.
 
 Previously, you would have written the following code:
@@ -68,5 +66,5 @@ new TransferFloatQuery($from, $wallet, $amountFlaot, new \Bavix\Wallet\External\
 ```
 
 ---
-It worked! 
+It's simple!
 
diff --git a/docs/cart.md b/docs/cart.md
@@ -129,4 +129,4 @@ $user->balanceFloat; // 156.27
 $user->balanceFloat; // 0
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/command-create-wallet.md b/docs/command-create-wallet.md
@@ -1,7 +1,5 @@
 # Asynchronous wallet creation
 
-> You need wallet version 9.2 or higher
-
 The idea is based on the division into teams for creating wallets, transactions, etc. The creation of a wallet can be accelerated if the client "generates a wallet himself".
 
 ---
@@ -58,4 +56,5 @@ You receive requests to create a wallet on the backend, and you create them asyn
 
 The user no longer needs to wait for the creation of a wallet, it is enough to know the uuid. You get the most stable application.
 
-It worked! 
+---
+It's simple!
diff --git a/docs/confirm.md b/docs/confirm.md
@@ -33,4 +33,4 @@ $transaction->confirmed; // bool(true)
 $user->balance; // 100 
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/credit-limits.md b/docs/credit-limits.md
@@ -33,4 +33,4 @@ $wallet = $user->createWallet([
 ]);
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/event-customize.md b/docs/event-customize.md
@@ -76,4 +76,4 @@ class MyBalanceUpdatedListener
 }
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/exchange.md b/docs/exchange.md
@@ -112,5 +112,5 @@ Due to conversion and mathematical rounding, you lost 62 kopecks.
 You have 99 rubles 38 kopecks left.
 
 ---
-It worked! 
+It's simple!
 
diff --git a/docs/formatter.md b/docs/formatter.md
@@ -0,0 +1,20 @@
+# Helper FormatterServiceInterface
+
+Sometimes you need to convert the balance to some format. A small and simple helper has appeared that will simplify the process a little.
+
+### floatValue
+
+```php
+app(FormatterServiceInterface::class)->floatValue('12345', 2); // 123.45
+app(FormatterServiceInterface::class)->floatValue('12345', 3); // 12.345
+```
+
+### intValue
+
+```php
+app(FormatterServiceInterface::class)->intValue('12.345', 3); // 12345
+app(FormatterServiceInterface::class)->intValue('123.45', 2); // 12345
+```
+
+---
+It's simple!
diff --git a/docs/gift.md b/docs/gift.md
@@ -121,4 +121,4 @@ $last->balance; // 0
 $item->balance; // 100
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/laravel-wallet-swap.md b/docs/laravel-wallet-swap.md
@@ -54,4 +54,4 @@ $usd->balance; // 190
 $rub->balance; // 622
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/laravel-wallet-uuid.md b/docs/laravel-wallet-uuid.md
@@ -24,4 +24,4 @@ After migration, you can use the UUID in your models.
 
 You can find implementation examples in the package tests: https://github.com/bavix/laravel-wallet-uuid/tree/master/tests
 
-It worked! 
+It's simple!
diff --git a/docs/lumen.md b/docs/lumen.md
@@ -1,5 +1,7 @@
 [composer](_include/composer.md ':include')
 
+> Note: In the years since releasing Lumen, PHP has made a variety of wonderful performance improvements. For this reason, along with the availability of Laravel Octane, we no longer recommend that you begin new projects with Lumen. Instead, we recommend always beginning new projects with Laravel.
+
 ## Add the service to the app
 
 [Editing the application file](https://lumen.laravel.com/docs/5.8/providers#registering-providers) `bootstrap/app.php`
diff --git a/docs/new-wallet.md b/docs/new-wallet.md
@@ -73,4 +73,4 @@ $wallet->balance; // 10
 $wallet->balanceFloatNum; // 0.10
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/nova-action.md b/docs/nova-action.md
diff --git a/docs/pay-free.md b/docs/pay-free.md
@@ -113,4 +113,4 @@ $user->balance; // 100
 $item->balance; // 0
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/payment-custom-wallet.md b/docs/payment-custom-wallet.md
@@ -120,4 +120,4 @@ $user->balance; // 0
 $receiving->balanceInt; // $100
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/payment.md b/docs/payment.md
@@ -135,4 +135,4 @@ if ($user->safePay($item)) {
 }
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/race-condition.md b/docs/race-condition.md
@@ -34,4 +34,4 @@ You need `redis-server` and `php-redis`.
 
 Redis is recommended but not required. You can choose whatever the [framework](https://laravel.com/docs/8.x/cache#introduction) offers you.
 
-It worked! 
+It's simple!
diff --git a/docs/refresh.md b/docs/refresh.md
@@ -40,4 +40,4 @@ $user->wallet->refreshBalance();
 $user->balance; // 42
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/refund.md b/docs/refund.md
@@ -112,4 +112,4 @@ $item->balance; // 0
 $user->balance; // 100
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/taxing.md b/docs/taxing.md
@@ -165,4 +165,4 @@ $user->safePay($item); // failed, 100 (product) + 5 (minimal fee) = 105
 $user->balance; // 103
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/transaction-created-event.md b/docs/transaction-created-event.md
@@ -30,4 +30,4 @@ class MyWalletTransactionCreatedListener
 }
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/transaction-filter.md b/docs/transaction-filter.md
@@ -7,12 +7,6 @@ If you only need to filter one wallet at a time, now you can use the `walletTran
 ```php
 /** @var \Bavix\Wallet\Models\Wallet $wallet */
 
-// Before version 7.3
-$query = $wallet
-    ->transactions()
-    ->where('wallet_id', $wallet->getKey());
-
-// 7.3+
 $query = $wallet->walletTransactions();
 ```
 
@@ -46,4 +40,4 @@ $usd->walletTransactions()->count(); // 1
 $eur->walletTransactions()->count(); // 1
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/transaction.md b/docs/transaction.md
@@ -1,7 +1,5 @@
 ## Transaction
 
-> Starting from version 9.6 you can safely use standard framework transactions.
-
 You definitely need to know the feature of transactions. The wallet is automatically blocked from the moment it is used until the end of the transaction. Therefore, it is necessary to use the wallet closer to the end of the transaction.
 
 Very important! Almost all wallet transactions are blocking.
@@ -19,46 +17,4 @@ The point is that you need to minimize operations within transactions as much as
 The maximum wallet blocking time is set in the configuration. The longer the transaction takes, the more likely it is to get a race for the wallet.
 
 ---
-
-If you are using a version below 9.6, then the following is relevant for you:
---
-
-> Since version 9.2 it is safer to use AtomicServiceInterface.
-
-> Is it possible to use laravel's inline transactions? No, It is Immpossible. This limitation is due to the internal architecture of the package. To achieve the maximum speed of work, work with an internal state of balance was needed. Starting with version 8.2, a special error has appeared that will inform you about incorrect work with the `TransactionStartException` package.
-
-Sometimes you need to execute many simple queries. You want to keep the data atomic. To do this, you need `laravel-wallet` v7.1+.
-
-It is necessary to write off the amount from the balance and raise the ad in the search. What happens if the service for raising an ad fails? We wrote off the money, but did not raise the ad. Received reputational losses. We can imagine the opposite situation, we first raise the ad in the search, but it does not work to write off the money. There are not enough funds. This functionality will help to solve all this. We monitor ONLY the state of the wallet, the rest falls on the developer. Let's take an unsuccessful lift, for example.
-
-```php
-use Bavix\Wallet\Internal\Service\DatabaseServiceInterface;
-
-/** @var object $businessLogicService */
-/** @var \Bavix\Wallet\Models\Wallet $payer */
-$payer->balanceInt; // 9999
-app(DatabaseServiceInterface::class)->transaction(static function () use ($payer) {
-    $payer->withdraw(1000); // 8999
-    $businessLogicService->doingMagic($payer); // throws an exception
-}); // rollback payer balance
-
-$payer->balanceInt; // 9999
-```
-
-Now let's look at the successful raising of the ad.
-
-```php
-use Bavix\Wallet\Internal\Service\DatabaseServiceInterface;
-
-/** @var object $businessLogicService */
-/** @var \Bavix\Wallet\Models\Wallet $payer */
-$payer->balanceInt; // 9999
-app(DatabaseServiceInterface::class)->transaction(static function () use ($payer) {
-    $payer->withdraw(1000); // 8999
-    $businessLogicService->doingMagic($payer); // successfully
-}); // commit payer balance
-
-$payer->balanceInt; // 8999
-```
-
-It worked! 
+It's simple!
diff --git a/docs/transfer-float.md b/docs/transfer-float.md
@@ -11,6 +11,29 @@ The transfer takes place between wallets.
 
 [User Simple](_include/models/user_simple_float.md ':include')
 
+### Example contract
+
+```php
+$transfer = $user1->transferFloat(
+    $user2,
+    5.11,
+    new Extra(
+        deposit: [
+            'type' => 'extra-deposit',
+        ],
+        withdraw: new Option(
+            [
+                'type' => 'extra-withdraw',
+            ],
+            false // confirmed
+        ),
+        extra: [
+            'msg' => 'hello world',
+        ],
+    )
+);
+```
+
 ## Make a Transfer
 
 Find user:
@@ -37,7 +60,7 @@ $first->balanceFloatNum; // 95
 $last->balanceFloatNum; // 5
 ```
 
-It worked! 
+It's simple!
 
 ## Force Transfer
 
@@ -56,4 +79,4 @@ $first->balanceFloatNum; // -400
 $last->balanceFloatNum; // 500
 ```
 
-It worked! 
+It's simple!
diff --git a/docs/transfer.md b/docs/transfer.md
diff --git a/docs/wallet-created-event.md b/docs/wallet-created-event.md
diff --git a/docs/wallet-transfer.md b/docs/wallet-transfer.md
diff --git a/docs/withdraw-float.md b/docs/withdraw-float.md
diff --git a/docs/withdraw.md b/docs/withdraw.md

Original file line number	Diff line number	Diff line change
`@@ -30,4 +30,4 @@ class MyBalanceUpdatedListener`
`30`	`30`	`}`
`31`	`31`	```
`32`	`32`
`33`		`-It worked!`
	`33`	`+It's simple!`
Original file line number	Diff line number	Diff line change
`@@ -76,4 +76,4 @@ class MyBalanceUpdatedListener`
`76`	`76`	`}`
`77`	`77`	```
`78`	`78`
`79`		`-It worked!`
	`79`	`+It's simple!`