monero-integrations/monerophp

A Monero library written in PHP by the Monero-Integrations team.

dev-master 2024-01-20 09:09 UTC

Requires

• php: >=7.3
• ext-bcmath: *
• ext-curl: *
• ext-json: *
• kornrunner/keccak: ^1.1

Requires (Dev)

• brainmaestro/composer-git-hooks: ^2.8
• dealerdirect/phpcodesniffer-composer-installer: *
• phpstan/extension-installer: *
• squizlabs/php_codesniffer: *

Suggests

• ext-gmp: Used to have a multiple math precision for generating address

MIT

• SerHack
• cryptochangements34
• sneurlax

• json-rpc
• jsonrpc
• cryptocurrency
• Monero
• XMR
• monerod
• monero-wallet-rpc
• cryptonote

README

Monero Library

A Monero library written in PHP by the Monero Integrations team.

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

Documentation

Documentation can be found in the /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.

monerod --testnet --detach

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

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

1. 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.)

2. 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.