45 lines
2.1 KiB
Markdown
45 lines
2.1 KiB
Markdown
[](https://www.php-fig.org/psr/psr-12/) [](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
|
||
|
||
|
||
## 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.
|