https://github.com/monero-integrations/monerophp

Monero PHP library + JsonRPC Client
https://github.com/monero-integrations/monerophp

monero-daemon monero-integrations monero-library monero-wallet-rpc php

Last synced: 4 days ago
JSON representation

Monero PHP library + JsonRPC Client

• Host: GitHub
• URL: https://github.com/monero-integrations/monerophp
• Owner: monero-integrations
• License: mit
• Created: 2017-06-08T12:20:25.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-08-03T23:16:15.000Z (6 months ago)
• Last Synced: 2025-01-07T22:03:36.419Z (12 days ago)
• Topics: monero-daemon, monero-integrations, monero-library, monero-wallet-rpc, php
• Language: PHP
• Homepage:
• Size: 386 KB
• Stars: 121
• Watchers: 18
• Forks: 76
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-monero - monerophp - A Monero library written in PHP by the Monero Integrations team. (Libraries / Other Wallets)

README

        
[![PHPCS PSR-12](https://img.shields.io/badge/PHPCS-PSR–12-226146.svg)](https://www.php-fig.org/psr/psr-12/) [![PHPStan ](.github/phpstan.svg)](https://phpstan.org/)

# Monero Library

A Monero library written in PHP by the [Monero Integrations](https://monerointegrations.com) [team](https://github.com/monero-integrations/monerophp/graphs/contributors).

## How It Works

This library has 3 main parts:

1. A Monero daemon JSON RPC API wrapper, `daemonRPC.php`

2. A Monero wallet (`monero-wallet-rpc`) JSON RPC API wrapper, `walletRPC.php`

3. A Monero/Cryptonote toolbox, `cryptonote.php`, with both lower level functions used in Monero related cryptography and higher level methods for things like generating Monero private/public keys.

In addition to these features, there are other lower-level libraries included for portability, *eg.* an ed25519 library, a SHA3 library, *etc.*

## Preview

![Preview](https://user-images.githubusercontent.com/4107993/38056594-b6cd6e14-3291-11e8-96e2-a771b0e9cee3.png)

## Documentation

Documentation can be found in the [`/docs`](https://github.com/sneurlax/monerophp/tree/master/docs) folder.

## Configuration

### Requirements

 - Monero daemon (`monerod`)

 - Webserver with PHP, for example XMPP, Apache, or NGINX

    - cURL PHP extension for JSON RPC API(s)

    - GMP PHP extension for about 100x faster calculations (as opposed to BCMath)

Debian (or Ubuntu) are recommended.

 

### Getting Started

1. Start the Monero daemon (`monerod`) on testnet.

```bash

monerod --testnet --detach

```

2. Start the Monero wallet RPC interface (`monero-wallet-rpc`) on testnet.

```bash

monero-wallet-rpc --testnet --rpc-bind-port 28083 --disable-rpc-login --wallet-dir /path/to/wallet/directory

```

3. Edit `example.php` with your the IP address of `monerod` and `monero-wallet-rpc` (use `127.0.0.1:28081` and `127.0.0.1:28083`, respectively, for testnet.)

4. Serve `example.php` with your webserver (*eg.* XMPP, Apache/Apache2, NGINX, *etc.*) and navigate to it.  If everything has been set up correctly, information from your Monero daemon and wallet will be displayed.