laravel-wallet - Easy work with virtual wallet.

[Benchmark] [Documentation] [Get Started]

• Vendor: bavix
• Package: laravel-wallet
• Version:
• PHP Version: 8.0+
• Laravel Version: 9.x
• Composer: composer require bavix/laravel-wallet

Support Policy

Version	Laravel	PHP	End of improvements	End of support
7.x	^6.0,^7.0,^8.0	7.4,8.0,8.1	1 Mar 2022	6 Sep 2022
8.x	^9.0	8.0,8.1	1 May 2022	1 Jun 2022
9.x [LTS]	^9.0	8.0,8.1	1 Feb 2023	6 Nov 2023

Upgrade Guide

To perform the migration, you will be helped by the instruction.

Community

I want to create a cozy place for developers using the wallet package. This will help you find bugs faster, get feedback and discuss ideas.

Telegram: @laravel_wallet

Extensions

Extension	Description
Swap	Addition to the laravel-wallet library for quick setting of exchange rates
uuid	Addition to laravel-wallet to support model uuid keys
Warm Up	Addition to the laravel-wallet library for refresh balance wallets

Usage

Add the HasWallet trait and Wallet interface to model.

use Bavix\Wallet\Traits\HasWallet;
use Bavix\Wallet\Interfaces\Wallet;

class User extends Model implements Wallet
{
    use HasWallet;
}

Now we make transactions.

$user = User::first();
$user->balanceInt; // 0

$user->deposit(10);
$user->balance; // 10
$user->balanceInt; // int(10)

$user->withdraw(1);
$user->balance; // 9

$user->forceWithdraw(200, ['description' => 'payment of taxes']);
$user->balance; // -191

Purchases

Add the CanPay trait and Customer interface to your User model.

use Bavix\Wallet\Traits\CanPay;
use Bavix\Wallet\Interfaces\Customer;

class User extends Model implements Customer
{
    use CanPay;
}

Add the HasWallet trait and interface to Item model.

Starting from version 9.x there are two product interfaces:

• For an unlimited number of products (ProductInterface);
• For a limited number of products (ProductLimitedInterface);

An example with an unlimited number of products:

use Bavix\Wallet\Traits\HasWallet;
use Bavix\Wallet\Interfaces\Customer;
use Bavix\Wallet\Interfaces\ProductInterface;

class Item extends Model implements ProductInterface
{
    use HasWallet;

    public function getAmountProduct(Customer $customer): int|string
    {
        return 100;
    }

    public function getMetaProduct(): ?array
    {
        return [
            'title' => $this->title, 
            'description' => 'Purchase of Product #' . $this->id,
        ];
    }
}

Example with a limited number of products:

use Bavix\Wallet\Traits\HasWallet;
use Bavix\Wallet\Interfaces\Customer;
use Bavix\Wallet\Interfaces\ProductLimitedInterface;

class Item extends Model implements ProductLimitedInterface
{
    use HasWallet;

    public function canBuy(Customer $customer, int $quantity = 1, bool $force = false): bool
    {
        /**
         * This is where you implement the constraint logic. 
         * 
         * If the service can be purchased once, then
         *  return !$customer->paid($this);
         */
        return true; 
    }
    
    public function getAmountProduct(Customer $customer): int|string
    {
        return 100;
    }

    public function getMetaProduct(): ?array
    {
        return [
            'title' => $this->title, 
            'description' => 'Purchase of Product #' . $this->id,
        ];
    }
}

I do not recommend using the limited interface when working with a shopping cart. If you are working with a shopping cart, then you should override the PurchaseServiceInterface interface. With it, you can check the availability of all products with one request, there will be no N-queries in the database.

Proceed to purchase.

$user = User::first();
$user->balance; // 100

$item = Item::first();
$user->pay($item); // If you do not have enough money, throw an exception
var_dump($user->balance); // 0

if ($user->safePay($item)) {
  // try to buy again
}

var_dump((bool)$user->paid($item)); // bool(true)

var_dump($user->refund($item)); // bool(true)
var_dump((bool)$user->paid($item)); // bool(false)

Eager Loading

// When working with one wallet
User::with('wallet');

// When using the multi-wallet functionality
User::with('wallets');

How to work with fractional numbers?

Add the HasWalletFloat trait and WalletFloat interface to model.

use Bavix\Wallet\Traits\HasWalletFloat;
use Bavix\Wallet\Interfaces\WalletFloat;
use Bavix\Wallet\Interfaces\Wallet;

class User extends Model implements Wallet, WalletFloat
{
    use HasWalletFloat;
}

Now we make transactions.

$user = User::first();
$user->balance; // 100
$user->balanceFloat; // 1.00

$user->depositFloat(1.37);
$user->balance; // 237
$user->balanceFloat; // 2.37

Performance Comparison

Name	7.2	7.3	8.1	8.2	8.3	8.4	9.0	9.1
Cart:EagerLoaderPay	38.8s	28.6s	27.9s	28.5s	1.27s	924ms	987ms	765ms
Cart:Pay	2.21s	1.81s	1.75s	1.81s	593ms	588ms	426ms	419ms
Cart:PayFree	2.06s	1.71s	1.66s	1.69s	534ms	534ms	360ms	348ms
Cart:PayOneItemXPieces	1.03s	754ms	726ms	749ms	148ms	158ms	75.1ms	78.3ms
Gift:Gift	61.6ms	59.9ms	55ms	58.8ms	60.1ms	60.5ms	66.7ms	71.2ms
Gift:Refund	167ms	132ms	147ms	150ms	143ms	129ms	141ms	133ms
Solo:Deposit	31.5ms	31.6ms	28.8ms	29.7ms	28.2ms	28.7ms	28ms	28.3ms
Solo:EagerLoading	3.1s	1.18s	8.16s	8.08s	8.99s	1.28s	1.25s	1.1s
Solo:ForceWithdraw	31.3ms	31.2ms	29.3ms	29.6ms	28.2ms	28.5ms	28.4ms	28.3ms
Solo:GetBalance	20.7ms	21.5ms	19.8ms	20.2ms	19.5ms	19.8ms	21.2ms	21.3ms
Solo:Transfer	53.1ms	51.6ms	47.8ms	50.5ms	46.9ms	48.4ms	44.1ms	44.3ms
State:InTransaction	818ms	693ms	679ms	703ms	628ms	677ms	698ms	700ms
State:RefreshInTransaction	48.7ms	40.3ms	39.6ms	40.8ms	36.8ms	39.1ms	39.7ms	39.6ms
State:TransactionRollback	38.6ms	33.8ms	31.6ms	32.6ms	30.9ms	32.2ms	31.7ms	31.9ms

Table generated using benchmark. Pull Request.

---

Supported by

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]