Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Simple PHP SDK for interacting with Transactions, Signatures, Borsh Serialization/Deserialization and RPCs

License

NotificationsYou must be signed in to change notification settings

Attestto-com/solana-php-sdk

Repository files navigation

Latest Version on PackagistGitHub Tests Action StatusCoverage (CodeCov)

_____________________________________________/__ \////__ \/___// __ \/ /   /   |  / | / /   |     / ___// __ \/ //_///_///_///_//   \__ \///////||/|///||\__\////,</____/__/____/___///_///___/___|//|/___|___///_///||/_//_//_/_//____/\____/_____/_/|_/_/|_/_/|_|/____/_____/_/|_|

Simple PHP SDK for interacting with the Transactions, Signatures, Borsh Serialization/Deserialization and RPCs

Forked from the Verze repo:verze-app/solana-php-sdk

Motivations

  • To protect RPC API Keys acting as a Hosted Proxy.
  • To enable Background Data Processing.
  • To enable Descentralized Data & Query Caching.
  • To empower PHP Applications to interact with the Solana Network
  • To enable Async Jobs and Queries in the Background.
  • To enable Decetralized Websockets (Push Notifications & Subscriptions)
  • To reduce Client-Sice RPC Polling, aiming at decongesting the mainnet and devnets.

Installation

You can install the package via composer :

composer require attestto/solana-php-sdk

From this Repository

git clone https://github.com/Attestto-com/solana-php-sdk.gitcd solana-php-sdkcomposer install

With Docker

docker build -t solana-php-sdk.

then

docker run -it solana-php-sdk /bin/bash

Usage

Using the Solana simple client

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

useAttestto\SolanaPhpSdk\Connection;useAttestto\SolanaPhpSdk\SolanaRpcClient;// Using a defined method$sdk =newConnection(newSolanaRpcClient(SolanaRpcClient::MAINNET_ENDPOINT));$accountInfo =$sdk->getAccountInfo('4fYNw3dojWmQ4dXtSGE9epjRGy9pFSx62YypT7avPYvA');var_dump($accountInfo);

For all the possible methods, see theAPI documentation.

Directly using the RPC client

TheConnection 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 fullResponse object:

useAttestto\SolanaPhpSdk\SolanaRpcClient;$client =newSolanaRpcClient(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, you may overrride the Endpoint with a custom RPC endpoint.:

$client =newSolanaRpcClient(SolanaRpcClient::DEVNET_ENDPOINT);$connection =newConnection($client);$fromPublicKey = KeyPair::fromSecretKey([...]);$toPublicKey =newPublicKey('J3dxNj7nDRRqRRXuEMynDG57DkZK4jYRuv3Garmb1i99');$instruction = SystemProgram::transfer($fromPublicKey->getPublicKey(),$toPublicKey,6);$transaction =newTransaction(null,null,$fromPublicKey->getPublicKey());$transaction->add($instruction);$txHash =$connection->sendTransaction($transaction,$fromPublicKey);

Borsh Deserialize & Deserialize

For Borsh serialization/deseralization to work, a class::SCHEMA object reflecting the Program Structs, based on the program IDL must be passed or defined. e.g.

class DidData{use BorshObject;//traitpublic$keyData;publicconstSCHEMA = [        VerificationMethodStruct::class => VerificationMethodStruct::SCHEMA[VerificationMethodStruct::class],        ServiceStruct::class => ServiceStruct::SCHEMA[ServiceStruct::class],self::class => ['kind' =>'struct','fields' => [                ['offset','u64'],                ['version','u8'],                ['bump','u8'],                ['nonce','u64'],                ['initialVerificationMethod','string'],                ['flags','u16'],                ['methodType','u8'],                ['keyData', ['u8']],                ['verificationMethods', [VerificationMethodStruct::class]],                ['services', [ServiceStruct::class]],                ['nativeControllers', ['pubKey']],                ['otherControllers', ['string']],            ],        ],    ];publicstaticfunctionfromBuffer(array$buffer):self    {return Borsh::deserialize(self::SCHEMA,self::class,$buffer);    }}

BORSH USAGE (PHP implementation)

To get a better understanding on the implementation and usage, please refer to the following references:

example usage(This will be improved, WIP):

/**     * deserializeDidData     *     * @param string $dataBase64 The base64 encoded data of the DID data account     * @return DidData The deserialized DID data object     * @example DidSolProgram::deserializeDidData('TVjvjfsd7fMA/gAAAA...');     */staticfunctiondeserializeDidData($dataBase64)    {$base64String =base64_decode($dataBase64);$uint8Array =array_values(unpack('C*',$base64String));$didData = DidData::fromBuffer($uint8Array);// See above code block$keyData =$didData->keyData;$binaryString =pack('C*', ...$keyData);$b58 =newBase58();$base58String =$b58->encode($binaryString);$didData->keyData =$base58String;return$didData;    }

Notes:

  • Most of the Magic is done in theBorshDesealizable.php Trait.
  • This project is in alpha, the code to generate instructions is still being worked on$instruction = SystemProgram::abc()
  • This project is maintained by a single dev, so any feedback, ideas, comments are appreciated.

Roadmap (WIP)

  1. Borsh serialize and deserialize.Done -Test(s) -Coverage

  2. Improved documentation.WIP - This document +Documentation Index (https://github.com/Attestto-com/solana-php-sdk/tree/master/docs)

  3. Build out more of the Connection, Message, SystemProgram, TokenProgram, MetaplexProgram classes.WIP -Tests -Coverage4. [ ] Connection::class5. [x] getLatestBlokchash::class [Source] - [Test] - [Coverage]6. [ ] getMinimumBalanceForRentExemption()7. [ ] getTokenAccountBalance()6. [ ] TransactionMessage::class7. [ ] compileToV0Message()8. [ ] VersionedTransaction::class9. [ ] SPL-TOKEN Program10. [ ] getOrCreateAssociatedTokenAccount()11. [ ] getAssociatedTokenAddressSync()12. [ ] createAssociatedTokenAccountInstruction()11. [ ] createSyncNativeInstruction() - [Test][Coverage]

  4. Improve abstractions around working with binary data.Done? -Test(s) -Coverage

  5. Optimizations:

    1. Leverage PHP more.
    2. Better cache$recentBlockhash when sending transactions.

  6. Suggestions? Open anIssue orPull Request :D

Testing & Code Coverage

WIP -- Working on coverage and deprecations. SeeCoverage Report.

"scripts": {"test":"vendor/bin/phpunit tests --coverage-clover=coverage.xml --coverage-filter src/","format":"vendor/bin/php-cs-fixer fix --allow-risk=yes"    },

GitHub Tests Action StatusCoverage (CodeCov)

composertest

OR

/verdor/bin/phpunit tests [options]

Contributing - Yes Please! :-P

  • Please seeCONTRIBUTING for details.
  • I will change my profile pic once we get a 2nd mantainer onboard :-)

Security

If you discover any security related issues, please email the maintainers (see composer.json) instead of using the issue tracker.

Credits

License

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

About

Simple PHP SDK for interacting with Transactions, Signatures, Borsh Serialization/Deserialization and RPCs

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

[8]ページ先頭
©2009-2025 Movatter.jp