configuration.md

Author: rez1dent3

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' => [],
         ],
     ],

docs/configuration.md

@@ -1,4 +1,20 @@
 # Configuration
+
+## 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        |
+
 Though this package is crafted to suit most of your needs by default, you can edit the configuration file to suit certain demands.
 
 ## Configure default wallet