README

Laravel Bitcoin is a Laravel package for work with cryptocurrency Bitcoin. You can create descriptor wallets, generate addresses, track current balances, collect transaction history, organize payment acceptance on your website, and automate outgoing transfers.

Examples

Create Descriptor Wallet:

$name = 'my-wallet';
$password = 'password for encrypt wallet files';
$title = 'My First Wallet';

$node = Bitcoin::createNode('localhost', 'LocalHost', '127.0.0.1');
$wallet = Bitcoin::createWallet($node, $name, $password, $title);

Import Descriptor Wallet using descriptors:

$name = 'my-wallet';
$password = 'password for encrypt wallet files';
$descriptions = json_decode('DESCRIPTORS JSON', true);
$title = 'My First Wallet';

$node = Bitcoin::createNode('localhost', 'LocalHost', '127.0.0.1');
$wallet = Bitcoin::importWallet($node, $name, $descriptions, $password, $title);

Create address:

$wallet = BitcoinWallet::firstOrFail();
$title = 'My address title';

$address = Bitcoin::createAddress($wallet, AddressType::BECH32, $title);

Validate address:

$address = '....';

$node = BitcoinNode::firstOrFail();
$addressType = Bitcoin::validateAddress($node, $address);
if( $addressType === null ) {
    die('Address is not valid!');
} 

var_dump($addressType); // Enum value of AddressType

Send all BTC from wallet:

$wallet = BitcoinWallet::firstOrFail();
$address = 'to_address';

$txid = Bitcoin::sendAll($wallet, $address);

echo 'TXID: '.$txid;

Send BTC from wallet:

$wallet = BitcoinWallet::firstOrFail();
$address = 'to_address';
$amount = 0.001;

$txid = Bitcoin::send($wallet, $address, $amount);

echo 'TXID: '.$txid;

Installation

You can install the package via composer:

composer require it-healer/laravel-bitcoin

After you can run installer using command:

php artisan bitcoin:install

And run migrations:

php artisan migrate

'providers' => ServiceProvider::defaultProviders()->merge([
    ...,
    \ItHealer\LaravelBitcoin\BitcoinServiceProvider::class,
])->toArray(),

'aliases' => Facade::defaultAliases()->merge([
    ...,
    'Bitcoin' => \ItHealer\LaravelBitcoin\Facades\Bitcoin::class,
])->toArray(),

In file app/Console/Kernel in method schedule(Schedule $schedule) add

$schedule->command('bitcoin:cron')
    ->everyMinute()
    ->runInBackground();

Electrum

Для установки приложения Electrum установите на сервер зависимости

apt-get install python3-pyqt6 libsecp256k1-dev python3-cryptography

А потом выполните команду:

php artisan electrum:install

Для запуска процесса Electrum добавьте в Supervisor конфигурацию:

[program:electrum]
command=/usr/bin/php -d variables_order=EGPCS /var/www/html/artisan electrum
user=%(ENV_SUPERVISOR_PHP_USER)s
environment=LARAVEL_SAIL="1"
stdout_logfile=/dev/stdout
stdout_logfile_maxbytes=0
stderr_logfile=/dev/stderr
stderr_logfile_maxbytes=0
autostart=true
autorestart=true
startretries=100

В Sheduler добавьте выполнение команды electrum:cron ежеминутно:

Schedule::command('electrum:cron')
    ->everyMinute()
    ->runInBackground();

Для корректной работы локальной ноды в Firewall разрешите TCP 8333

Установка Bitcoind на сервер

Заходим на сайт https://bitcoincore.org/en/download/ и скачиваем актуальную версию Bitcoin Core для вашей системы (Linux tgz) при помощи команды: wget https://bitcoincore.org/bin/bitcoin-core-29.0/bitcoin-29.0-x86_64-linux-gnu.tar.gz.
Распаковуем архив при помощи команды: tar -xvf bitcoin-29.0-x86_64-linux-gnu.tar.gz
Устанавливаем приложение командой: sudo install -m 0755 -o root -g root -t /usr/local/bin bitcoin-29.0/bin/*
Теперь у Вас доступна команда bitcoind и bitcoin-cli.
От пользователя создаём папку mkdir ~/.bitcoin и файл ~./bitcoin/bitcoin.conf содержимое описано ниже.
Создаём supervisor команду и запускаем её.

Bitcoin.conf

Ложим в папку /home/%USER%/.bitcoin/bitcoin.conf:

server=1
datadir=/home/%USER%/.bitcoin
walletdir=/home/%USER%/.bitcoin/wallets

rpcbind=127.0.0.1
rpcport=10497
rpcallowip=127.0.0.1
rpcauth=qEIop8Liv9TisWri:f635d8c82dc0c1205134ab909f39e9a5$508243bcc43f507a1ecb8160b97e6b81b2c756ff06caa1b7c33f3d31de325843

deprecatedrpc=addresses

disablewallet=0

listen=0
dnsseed=1
upnp=0
natpmp=0

prune=550

fallbackfee=0.000050
printtoconsole=1

Создаём файл Supervisor'а с названием /etc/supervisor/conf.d/bitcoin.conf:

[program:bitcoin]
process_name=%(program_name)s
command=/usr/local/bin/bitcoind
autostart=true
autorestart=true
startretries=3
user=wallet
redirect_stderr=true
stdout_logfile=/home/%USER%/%PATH_FOR_LARAVEL%/storage/logs/bitcoin.log
stdout_logfile_maxbytes=50MB
stdout_logfile_backups=5
stopsignal=TERM
stopwaitsecs=6000
environment=HOME="/home/%USER%"

Commands

Scan transactions and update balances:

> php artisan bitcoin:sync

Scan transactions and update balances for wallet:

> php artisan bitcoin:sync-wallet {wallet_id}

WebHook

You can set up a WebHook that will be called when a new incoming BTC deposit is detected.

In file config/bitcoin.php you can set param:

'webhook.handler' => \ItHealer\LaravelBitcoin\WebhookHandlers\EmptyWebhookHandler::class,

Example WebHook handler:

class EmptyWebhookHandler implements WebhookHandlerInterface
{
    public function handle(BitcoinDeposit $transaction): void
    {
        Log::error('Bitcoin new deposit '.$transaction->txid);
    }
}

Requirements

The following versions of PHP are supported by this version.

PHP 8.2 and older

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

IT-HEALER

License

The MIT License (MIT). Please see License File for more information.

it-healer / laravel-bitcoin

Maintainers

Details