solana php sdk Download - solana php sdk Source Code Download

SDK PHP Solana

GitHub teste l'état de l'action

    ____  __  ______     _____ ____  __    ___    _   _____       _____ ____  __ __
   / __  / / / / __    / ___ // __ / /   /   |  / | / /   |     / ___// __ / //_/
  / / _ / / / _ / / / _ / /    __  / / / / /   / / | | /  | / / / | |     __ / / / / ,<   
 / ____ / __  / ____ /   ___ / / / _ / / / ___ / ___ | / / |  / ___ |    ___ / / / _ / / / | |  
/ _ /   / _ / / _ / _ /       / ____ / _ ___ / _____ / _ /  | _ / _ / | _ / _ /  | _ |   / ____ / _____ / _ / | _ |

SDK PHP simple pour interagir avec les transactions, les signatures, la sérialisation / désérialisation BORSH et les RPC

Fourchu du repos de Verze: Verze-App / Solana-Php-Sdk

Motivations

Pour protéger les clés API RPC agissant comme un proxy hébergé.
Pour activer le traitement des données de fond.
Pour permettre des données et une mise en cache de requête descentes.
Pour permettre aux applications PHP d'interagir avec le réseau Solana
Pour permettre des travaux et des requêtes asynchrones en arrière-plan.
Pour permettre les webockets décétralisés (notifications push et abonnements)
Pour réduire le sondage du RPC du client, visant à décongestionner le MainNet et les Devnets.

Installation

Vous pouvez installer le package via le compositeur:

composer require attestto/solana-php-sdk

De ce référentiel

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

cd solana-php-sdk

composer install

Avec Docker

Dockerfile
compose-dev.yaml

docker build -t solana-php-sdk .

alors

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

Usage

Utilisation du client Simple Solana

Vous pouvez utiliser la classe Connection pour un accès pratique aux méthodes API. Certains sont définis dans le code:

 use Attestto  SolanaPhpSdk  Connection ;
use Attestto  SolanaPhpSdk  SolanaRpcClient ;

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

Pour toutes les méthodes possibles, consultez la documentation de l'API.

Utilisation directement du client RPC

La classe Connection n'est qu'une couche de commodité légère au-dessus du client RPC. Vous pouvez, si vous le souhaitez, utiliser directement le client, ce qui vous permet de travailler avec l'objet Response complet:

 use Attestto  SolanaPhpSdk  SolanaRpcClient ;

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

Transactions

Voici l'exemple fonctionnant de l'envoi d'une instruction de transfert à la blockchain Solana, vous pouvez sous-tendre le point de terminaison avec un point de terminaison RPC personnalisé.:

 $ 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 );

Borsh désérialiser et désérialiser

Pour que la sérialisation / déraalisation de BORSH fonctionne, un objet de schéma Class :: reflétant les structures du programme, basé sur le programme IDL, doit être passé ou défini. par exemple

 class DidData
{

    use BorshObject; //trait
    public $ keyData ;

    public const SCHEMA = [
        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 ' ]],
            ],
        ],
    ];

    public static function fromBuffer ( array $ buffer ): self
    {
        return Borsh:: deserialize ( self :: SCHEMA , self ::class, $ buffer );
    }
}

Utilisation de Borsh (implémentation PHP)

Pour mieux comprendre la mise en œuvre et l'utilisation, veuillez vous référer aux références suivantes:

Test PHP Borsh
Classe PHP Borsh
PHP BORSH Trait

Exemple d'utilisation (ce sera amélioré, 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...');
     */
    static function deserializeDidData ( $ 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 = new Base58 ();
        $ base58String = $ b58 -> encode ( $ binaryString );
        $ didData -> keyData = $ base58String ;
        return $ didData ;
    }

Notes:

La plupart de la magie se fait dans le trait borshdesealizable.php.
Ce projet est en alpha, le code pour générer des instructions est toujours en cours de travail sur $instruction = SystemProgram::abc()
Ce projet est maintenu par un seul DEV, donc tous les commentaires, idées, commentaires sont appréciés.

Feuille de route (WIP)

Borsh sérialise et désérialise. Terminé - Test (s) - Couverture
Documentation améliorée. WIP - Ce document + index de la documentation (https://github.com/attestto-com/solana-php-sdk/tree/master/docs)
Construisez plus de classes, des classes, des classes, du systemProgram, des classes TokenProgram, MetaplexProgram. WIP - Tests - Couverture 4. [] Connexion :: Classe 5. [X] GetlatestBlokChash :: Class [Source] - [Test] - [Couverture] 6. [] GetMinImbalanceForrentExemption () 7. Programme SPL-Token 10. [] GetorCreateAsociatedTokenAccount () 11. [] GetAssociatedTokenDressSync () 12. [] CreateAsociatedTokenAccountInStruction () 11. [] CreateSyncNativeInstruction () - [test] [Couverture]
Améliorer les abstractions autour du travail avec les données binaires. Fait? - Test (s) - Couverture
Optimisations:
1. Tirer parti davantage PHP.
2. Meilleur cache $recentBlockhash lors de l'envoi de transactions.
Suggestions? Ouvrez un problème ou une demande de traction: D

Test et couverture de code

WIP - Travailler sur la couverture et les dépréciations. Voir le rapport de couverture.

Configuration phpunit.xml
composer.json

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

GitHub teste l'état de l'action

composer test

/verdor/bin/phpunit tests [options]

Contribution - Oui s'il vous plaît! : P

Veuillez consulter la contribution pour plus de détails.
Je changerai ma photo de profil une fois que nous aurons un 2ème manteau à bord :-)

Sécurité

Si vous découvrez des problèmes liés à la sécurité, veuillez envoyer un e-mail aux responsables (voir Composer.json) au lieu d'utiliser le tracker du problème.