Skip to content

Configuration v10.0.1 ​

Though this package is crafted to suit most of your needs by default, you can edit the configuration file to suit certain demands.

Environment ​

NameDescriptionDefault
WALLET_MATH_SCALESelect mathematical precision64
WALLET_CACHE_DRIVERCache for wallet balancearray
WALLET_CACHE_TTLCache TTL for wallet balance24h
WALLET_LOCK_DRIVERLock for walletsarray
WALLET_LOCK_TTLLock TTL for wallets1s
WALLET_TRANSACTION_TABLE_NAMETransaction table nametransactions
WALLET_TRANSFER_TABLE_NAMETransfer table nametransfers
WALLET_WALLET_TABLE_NAMEWallet table namewallets
WALLET_DEFAULT_WALLET_NAMEDefault wallet nameDefault Wallet
WALLET_DEFAULT_WALLET_SLUGDefault wallet slugdefault

Configure default wallet ​

Customize name,slug and meta of default wallet.

config/wallet.php:

php
'default' => [
    'name' => 'Ethereum',
    'slug' => 'ETH',
    'meta' => [],
],

Extend base Wallet model ​

You can extend base Wallet model by creating a new class that extends Bavix\Wallet\Models\Wallet and registering the new class in config/wallet.php. Example MyWallet.php

App/Models/MyWallet.php:

php
use Bavix\Wallet\Models\Wallet as WalletBase;

class MyWallet extends WalletBase {
    public function helloWorld(): string { return "hello world"; }
}

Register base Wallet model ​

config/wallet.php:

php
'wallet' => [
    'table' => 'wallets',
    'model' => MyWallet::class,
    'creating' => [],
    'default' => [
        'name' => 'Default Wallet',
        'slug' => 'default',
        'meta' => [],
    ],
],
php
echo $user->wallet->helloWorld();

This same method above, can be used to extend the base Transfer and Transaction models and registering the extended models in the configuration file.

Changing wallet decimal places ​

You can change the default wallet decimal places, in wallet config file. This can be useful when working with fractional numbers.

config/wallet.php:

php
/**
 * Base model 'wallet'.
 */
'wallet' => [
    ....
    'creating' => [
        'decimal_places' => 18,
    ],
   ....
],