Merge pull request #913 from bavix/11.x

rez1dent3 · web-flow · commit d236114ea469 · 2024-03-14T00:02:50.000+03:00
[11.x] docs
diff --git a/config/config.php b/config/config.php
@@ -60,7 +60,7 @@
      * 'scale' - length of the mantissa
      */
     'math' => [
-        'scale' => 64,
+        'scale' => env('WALLET_MATH_SCALE', 64),
     ],
 
     /**
@@ -166,28 +166,28 @@
      * Base model 'transaction'.
      */
     'transaction' => [
-        'table' => 'transactions',
+        'table' => env('WALLET_TRANSACTION_TABLE_NAME', 'transactions'),
         'model' => Transaction::class,
     ],
 
     /**
      * Base model 'transfer'.
      */
     'transfer' => [
-        'table' => 'transfers',
+        'table' => env('WALLET_TRANSFER_TABLE_NAME', 'transfers'),
         'model' => Transfer::class,
     ],
 
     /**
      * Base model 'wallet'.
      */
     'wallet' => [
-        'table' => 'wallets',
+        'table' => env('WALLET_WALLET_TABLE_NAME', 'wallets'),
         'model' => Wallet::class,
         'creating' => [],
         'default' => [
-            'name' => 'Default Wallet',
-            'slug' => 'default',
+            'name' => env('WALLET_DEFAULT_WALLET_NAME', 'Default Wallet'),
+            'slug' => env('WALLET_DEFAULT_WALLET_SLUG', 'default'),
             'meta' => [],
         ],
     ],
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -2,7 +2,6 @@
 
     - [Introduction](README)
     - [Installation](installation)
-    - [Lumen installation](lumen)
     - [Configuration](configuration)
     - [Basic Usage](basic-usage)
     - [Upgrade Guide](upgrade-guide)
@@ -55,6 +54,9 @@
   - [Wallet Swap](laravel-wallet-swap)
   - [Wallet UUID](laravel-wallet-uuid)
 
+- Helpers
+  - [Formatter](formatter)
+
 - Events
     
     - [BalanceUpdatedEvent](balance-updated-event)
@@ -65,7 +67,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
@@ -78,7 +76,6 @@ use Bavix\Wallet\Services\ConsistencyServiceInterface;
 app(AtomicServiceInterface::class)->blocks($wallets, function () use ($wallets, $amount) {
     foreach ($wallets as $wallet) {
         app(ConsistencyServiceInterface::class)->checkPotential($wallet, $amount);
-
     }
 
     app(TransactionQueryHandlerInterface::class)->apply(
@@ -98,10 +95,15 @@ The main thing is to keep uniqueness.
 ```php
 use Bavix\Wallet\External\Api\TransactionQuery;
 
-TransactionQuery::createDeposit($wallet, $amount, null, uuid: '5f7820d1-1e82-4d03-9414-05d0c44da9a1')
-TransactionQuery::createWithdraw($wallet, $amount, null, uuid: '6e87dbf2-7be7-48c2-b688-f46ba4e25786')
+// int version
+TransactionQuery::createDeposit($wallet, $amount, null, uuid: '5f7820d1-1e82-4d03-9414-05d0c44da9a1');
+TransactionQuery::createWithdraw($wallet, $amount, null, uuid: '6e87dbf2-7be7-48c2-b688-f46ba4e25786');
+
+// float version
+TransactionFloatQuery::createDeposit($wallet, $amountFloat, null, uuid: '5f7820d1-1e82-4d03-9414-05d0c44da9a1');
+TransactionFloatQuery::createWithdraw($wallet, $amountFloat, null, uuid: '6e87dbf2-7be7-48c2-b688-f46ba4e25786');
 ```
 
 ---
-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:
@@ -38,6 +36,7 @@ The main thing is to keep uniqueness.
 ```php
 use Bavix\Wallet\External\Api\TransferQuery;
 
+// int version
 new TransferQuery($from, $wallet, $amount, new \Bavix\Wallet\External\Dto\Extra(
     deposit: new \Bavix\Wallet\External\Dto\Option(
         null,
@@ -48,9 +47,24 @@ new TransferQuery($from, $wallet, $amount, new \Bavix\Wallet\External\Dto\Extra(
         uuid: '3805730b-39a1-419d-8715-0b7cc3f1ffc2', // withdraw transaction
     ),
     uuid: 'f8becf81-3993-43d7-81f1-7a725c72e976', // transfer uuid
-))
+    extra: ['info' => 'fast deposit'], // metadata in the table transfers
+));
+
+// float version
+new TransferFloatQuery($from, $wallet, $amountFlaot, new \Bavix\Wallet\External\Dto\Extra(
+    deposit: new \Bavix\Wallet\External\Dto\Option(
+        null,
+        uuid: '71cecafe-da10-464f-9e00-c80437bb4c3e', // deposit transaction
+    ),
+    withdraw: new \Bavix\Wallet\External\Dto\Option(
+        null,
+        uuid: '3805730b-39a1-419d-8715-0b7cc3f1ffc2', // withdraw transaction
+    ),
+    uuid: 'f8becf81-3993-43d7-81f1-7a725c72e976', // transfer uuid
+    extra: ['info' => 'fast deposit'], // metadata in the table transfers
+));
 ```
 
 ---
-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/configuration.md b/docs/configuration.md
@@ -1,6 +1,22 @@
 # Configuration
+
 Though this package is crafted to suit most of your needs by default, you can edit the configuration file to suit certain demands.
 
+## Environment
+
+| Name                            | Description                   | Default        | 
+|---------------------------------|-------------------------------|----------------|
+| `WALLET_MATH_SCALE`             | Select mathematical precision | 64             |
+| `WALLET_CACHE_DRIVER`           | Cache for wallet balance      | array          |
+| `WALLET_CACHE_TTL`              | Cache TTL for wallet balance  | 24h            |
+| `WALLET_LOCK_DRIVER`            | Lock for wallets              | array          |
+| `WALLET_LOCK_TTL`               | Lock TTL for wallets          | 1s             |
+| `WALLET_TRANSACTION_TABLE_NAME` | Transaction table name        | transactions   |
+| `WALLET_TRANSFER_TABLE_NAME`    | Transfer table name           | transfers      |
+| `WALLET_WALLET_TABLE_NAME`      | Wallet table name             | wallets        |
+| `WALLET_DEFAULT_WALLET_NAME`    | Default wallet name           | Default Wallet |
+| `WALLET_DEFAULT_WALLET_SLUG`    | Default wallet slug           | default        |
+
 ## Configure default wallet
 Customize `name`,`slug` and `meta` of default wallet.
 
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
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
diff --git a/docs/transaction-filter.md b/docs/transaction-filter.md
diff --git a/docs/transaction.md b/docs/transaction.md
diff --git a/docs/transfer-float.md b/docs/transfer-float.md
diff --git a/docs/transfer.md b/docs/transfer.md
diff --git a/docs/upgrade-guide.md b/docs/upgrade-guide.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!`