README

Installation

You can install the package via composer:

composer require rbaskam/monero-laravel

If you get an error with min stability thats due the monero integration package used so you will need to update your composer.json to have "minimum-stability": "dev",

You can publish the config file with:

php artisan vendor:publish --tag="monero-laravel-config"

This is the contents of the published config file:

return [
    'daemonRPC' => [
        'host' => env('MONERO_DEAMON_RPC_HOST'),
        'port' => env('MONERO_DEAMON_RPC_PORT'),
        'ssl' => env('MONERO_DEAMON_RPC_SSL', true),
        'user' => env('MONERO_DEAMON_RPC_USER', null),
        'password' => env('MONERO_DEAMON_RPC_PASSWORD', null),
    ],

    'walletRPC' => [
        'host' => env('MONERO_WALLET_RPC_HOST'),
        'port' => env('MONERO_WALLET_RPC_PORT'),
        'ssl' => env('MONERO_WALLET_RPC_SSL', true),
        'user' => env('MONERO_WALLET_RPC_USER', null),
        'password' => env('MONERO_WALLET_RPC_PASSWORD', null),
    ],
];

Usage

Sail

    monerod:
        image: sethsimmons/simple-monerod:latest
        user: ${FIXUID:-1000}:${FIXGID:-1000}
        restart: unless-stopped
        container_name: monerod
        volumes:
            - sail-bitmonero:/home/monero/.bitmonero
        ports:
            - 18080:18080
            - 18089:18089
        networks:
            - sail
        command:
            - "--rpc-restricted-bind-ip=0.0.0.0"
            - "--rpc-restricted-bind-port=18089"
            - "--public-node"
            - "--no-igd"
            - "--enable-dns-blocklist"
            - "--prune-blockchain"
            - "--testnet"
    monerowallet:
        image: sethsimmons/simple-monero-wallet-rpc:latest
        restart: unless-stopped
        container_name: monero-wallet-rpc
        networks:
            - sail
        volumes:
            - sail-bitmonerowallet:/home/monero
        ports:
            - 18083:18083
        command:
            - "--daemon-address=monerod:18089"
            - "--trusted-daemon"
            - "--rpc-bind-port=18083"
            - "--disable-rpc-login"
            - "--wallet-dir=."
            - "--testnet"
    tor:
        image: goldy/tor-hidden-service:latest
        container_name: tor
        restart: unless-stopped
        links:
            - monerod
        networks:
            - sail
        environment:
            MONEROD_TOR_SERVICE_HOSTS: 18089:monerod:18089
            MONEROD_TOR_SERVICE_VERSION: '3'
        volumes:
            - sail-tor-keys:/var/lib/tor/hidden_service/

    watchtower:
        image: containrrr/watchtower:latest
        container_name: watchtower
        restart: unless-stopped
        networks:
            - sail
        volumes:
            - "/var/run/docker.sock:/var/run/docker.sock"
networks:
    sail:
        driver: bridge
volumes:
    sail-mysql:
        driver: local
    sail-redis:
        driver: local
    sail-bitmonero:
        driver: local
    sail-tor-keys:
        driver: local
    sail-bitmonerowallet:
        driver: local

Sail PHP 8.2 Docker File

Publish the Sail files and add the following before && curl -sLS https://getcomposer.org/installer | php -- --install-dir=/usr/bin/ --filename=composer \

....
&& apt-get update && apt-get upgrade -y \
&& apt-get install -y gcc-multilib libc-dev bzip2 libgpg-error-dev libassuan-dev \
&& apt-get install -y build-essential \
&& curl -sSn -o gnupg.tar.bz2 https://gnupg.org/ftp/gcrypt/gpgme/gpgme-1.20.0.tar.bz2 \
&& mkdir gnupg \
&& tar -xf gnupg.tar.bz2 --directory gnupg \
&& (cd gnupg/gpgme-* && ./configure) \
&& (cd gnupg/gpgme-* && make && make install) \
&& pecl install gnupg \
&& apt-get install -y php-gmp \
...

Sail PHP 8.2 PHP INI

Publish the Sail files and add the following at the bottom

...

extension=gnupg.so
extension=gmp.so

ENV

MONERO_DEAMON_RPC_HOST="host.docker.internal"
MONERO_DEAMON_RPC_PORT=18089
MONERO_DEAMON_RPC_SSL=false
MONERO_DEAMON_RPC_USER=
MONERO_DEAMON_RPC_PASSWORD=

MONERO_WALLET_RPC_HOST="host.docker.internal"
MONERO_WALLET_RPC_PORT=18083
MONERO_WALLET_RPC_SSL=false
MONERO_WALLET_RPC_USER=
MONERO_WALLET_RPC_PASSWORD=

Connections

DeamonRPC

use Rbaskam\MoneroLaravel\DeamonRPC;

$daemonRPC = new DeamonRPC();
$daemonRPC = $daemonRPC->connect();

$getblockcount = $daemonRPC->getblockcount();
$on_getblockhash = $daemonRPC->on_getblockhash(42069);
$getblocktemplate = $daemonRPC->getblocktemplate('9sZABNdyWspcpsCPma1eUD5yM3efTHfsiCx3qB8RDYH9UFST4aj34s5Ygz69zxh8vEBCCqgxEZxBAEC4pyGkN4JEPmUWrxn', 60);
$submitblock = $daemonRPC->submitblock($block_blob);
$getlastblockheader = $daemonRPC->getlastblockheader();
$getblockheaderbyhash = $daemonRPC->getblockheaderbyhash('fc7ba2a76071f609e39517dc0388a77f3e27cc2f98c8e933918121b729ee6f27');
$getblockheaderbyheight = $daemonRPC->getblockheaderbyheight(696969);
$getblock_by_hash = $daemonRPC->getblock_by_hash('fc7ba2a76071f609e39517dc0388a77f3e27cc2f98c8e933918121b729ee6f27');
$getblock_by_height = $daemonRPC->getblock_by_height(696969);
$get_connections = $daemonRPC->get_connections();
$get_info = $daemonRPC->get_info();
$hardfork_info = $daemonRPC->hardfork_info();
$setbans = $daemonRPC->setbans('8.8.8.8');
$getbans = $daemonRPC->getbans();

WalletRPC

use Rbaskam\MoneroLaravel\WalletRPC;

$walletRPC = new WalletRPC();
$walletRPC = $walletRPC->connect(); 

$create_wallet = $walletRPC->create_wallet('monero_wallet', ''); // Creates a new wallet named monero_wallet with no passphrase.  Comment this line and edit the next line to use your own wallet
$open_wallet = $walletRPC->open_wallet('monero_wallet', '');
$get_address = $walletRPC->get_address();
$get_accounts = $walletRPC->get_accounts();
$get_balance = $walletRPC->get_balance();

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

rbaskam / monero-laravel

Maintainers

Details