howrareis/solana-php-sdk

Solana PHP SDK

v0.5.0 2022-09-15 14:30 UTC

Requires

• php: ^7.4 || ~8.0
• ext-sodium: *
• guzzlehttp/guzzle: ^7.3
• illuminate/http: ~8.0 || ~9.0
• illuminate/support: ^8.0 || ~9.0
• paragonie/sodium_compat: ^1.17
• stephenhill/base58: ^1.1

Requires (Dev)

• mockery/mockery: ^1.4
• orchestra/testbench: ^6.0
• phpunit/phpunit: ^9.0
• squizlabs/php_codesniffer: ^3.5
• tightenco/tlint: ^5.0

MIT

• SadMouse

• php
• sdk
• blockchain
• sol
• solana-php-sdk
• solana
• howrareis

README

⚠️ This is one of the forks of the original solana-php-sdk and is in no way maintained by the original author or the new maintainers of the original package. Project was moved to new namespace to avoid any clashes with the original package. This fork will deviate from the original project and feature parity will not be maintained. It will not be possible to use both projects as a drop-in replacements.

Simple PHP SDK for Solana.

Installation

You can install the package via composer:

composer require howrareis/solana-php-sdk

Usage

Using the Solana simple client

You can use the Connection class for convenient access to API methods. Some are defined in the code:

use HowRareIs\SolanaPhpSdk\Connection;
use HowRareIs\SolanaPhpSdk\SolanaRpcClient;

// Using a defined method
$sdk = new Connection(new SolanaRpcClient(SolanaRpcClient::MAINNET_ENDPOINT));
$accountInfo = $sdk->getAccountInfo('4fYNw3dojWmQ4dXtSGE9epjRGy9pFSx62YypT7avPYvA');
var_dump($accountInfo);

For all the possible methods, see the API documentation.

Directly using the RPC client

The Connection class is just a light convenience layer on top of the RPC client. You can, if you want, use the client directly, which allows you to work with the full Response object:

use HowRareIs\SolanaPhpSdk\SolanaRpcClient;

$client = new SolanaRpcClient(SolanaRpcClient::MAINNET_ENDPOINT);
$accountInfoResponse = $client->call('getAccountInfo', ['4fYNw3dojWmQ4dXtSGE9epjRGy9pFSx62YypT7avPYvA']);
$accountInfoBody = $accountInfoResponse->json();
$accountInfoStatusCode = $accountInfoResponse->getStatusCode();

Transactions

Here is working example of sending a transfer instruction to the Solana blockchain:

$client = new SolanaRpcClient(SolanaRpcClient::DEVNET_ENDPOINT);
$connection = new Connection($client);
$fromPublicKey = KeyPair::fromSecretKey([...]);
$toPublicKey = new PublicKey('J3dxNj7nDRRqRRXuEMynDG57DkZK4jYRuv3Garmb1i99');
$instruction = SystemProgram::transfer(
    $fromPublicKey->getPublicKey(),
    $toPublicKey,
    6
);

$transaction = new Transaction(null, null, $fromPublicKey->getPublicKey());
$transaction->add($instruction);

$txHash = $connection->sendTransaction($transaction, $fromPublicKey);

Note: This project is in alpha, the code to generate instructions is still being worked on $instruction = SystemProgram::abc()

Roadmap

1. Borsh serialize and deserialize.
2. Improved documentation.
3. Build out more of the Connection, SystemProgram, TokenProgram, MetaplexProgram classes.
4. Improve abstractions around working with binary data.
5. Optimizations:
   1. Leverage PHP more.
   2. Better cache $recentBlockhash when sending transactions.
6. Suggestions? Open an issue or PR :D

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Matt Stauffer (Original creator)
• Zach Vander Velden (Metadata wizard)
• All Contributors

License

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