Getting started with XRPL_PHP

Installation

You can install XRPL_PHP with Composer:

composer require hardcastle/xrpl_php

XRPL_PHP requires PHP 8.1 or above. Required is the PHP extension GMP. Optional but recommended is the PHP extension BCMath, which will speed up operations involving arbitrary length numbers like encryption and serialisation.

Sandbox

You can try XRPL_PHP in the following sandbox environment: XRPL_PHP Sandbox

Docker

[WIP]

Basic usage

Interacting with the XRPL basically involves two kinds of operations:

Querying the ledger, e.g. looking up the XRP balance of a given account or requesting the details of a specific transaction.
Doing Transactions, which are operations that modify the ledger state. Examples are issuing Payments or minting NFTs.

Query Example - Pinging the XRP Ledger

First, let's do a very basic request to the XRPL Testnet:

use XRPL_PHP\Client\JsonRpcClient;
use XRPL_PHP\Models\Utility\PingRequest;

$client = new JsonRpcClient("https://s.altnet.rippletest.net:51234");

$pingRequest = new PingRequest();

$pingResponse = $client->syncRequest($pingRequest);

$result = $pingResponse->getResult();

print_r($result);

Transaction example - Issuing a Payment

In this more complex example, we create two Wallets from their corresponding Seeds and issue a Payment from one to the other.

use Codedungeon\PHPCliColors\Color;
use XRPL_PHP\Client\JsonRpcClient;
use XRPL_PHP\Wallet\Wallet;
use function XRPL_PHP\Sugar\xrpToDrops;

// Use your own credentials here:
$aliceSeed = 'sEd7rnfWxwJmRditu2UpSsrZDRgtctn';
$aliceWallet = Wallet::fromSeed($aliceSeed);

// Use your own credentials here:
$bobSeed = 'sEd7XWKCuXENqLjPopq6WWFvoTnG3dX';
$bobWallet = Wallet::fromSeed($bobSeed);

$client = new JsonRpcClient("https://s.altnet.rippletest.net:51234");

$xrpAmount = '50';
$tx = [
    "TransactionType" => "Payment",
    "Account" => $aliceWallet->getAddress(),
    "Amount" => xrpToDrops($xrpAmount),
    "Destination" => $bobWallet->getAddress(),
    "DestinationTag" => 1937215245
];
$autofilledTx = $client->autofill($tx);
$signedTx = $aliceWallet->sign($autofilledTx);

$txResponse = $client->submitAndWait($signedTx['tx_blob']);
$result = $txResponse->getResult();

The steps are as follows:

We create a Transaction array (you can also use dedicated Method objects)
We use the autofill() function to add necessary fields like Sequence, Fee and LastLedgerSequence
We sign our Transaction (which will result in an array with the fields tx_blob and hash)
We submit our transaction using submitAndWait(), which submits the serialized Transaction and waits for validation