solana php sdk

Solana PHP SDK

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

簡單的PHP SDK，用於與交易，標誌，Borsh序列化/避難所和RPC進行交互

從verze倉庫分叉：verze-app/solana-php-sdk

---

動機

• 保護RPC API鍵，充當託管代理。
• 啟用背景數據處理。
• 為了啟用後裔數據和查詢緩存。
• 授權PHP應用程序與Solana網絡互動
• 在後台啟用異步工作和查詢。
• 啟用切開的Websocket（推送通知和訂閱）
• 為了減少客戶鍵的RPC投票，旨在減輕主網和DEVNET。

安裝

您可以通過作曲家安裝軟件包：

composer require attestto/solana-php-sdk

從這個存儲庫

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

cd solana-php-sdk

composer install 

與Docker

• Dockerfile
• COMPOSE-DEV.YAML

docker build -t solana-php-sdk .

然後

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

用法

使用Solana簡單客戶端

您可以使用Connection類以方便地訪問API方法。有些在代碼中定義：

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

有關所有可能的方法，請參見API文檔。

直接使用RPC客戶端

Connection類只是RPC客戶端頂部的輕便便利層。您可以，如果需要，可以直接使用客戶端，這使您可以與完整的Response對像一起工作：

 use Attestto  SolanaPhpSdk  SolanaRpcClient ;

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

交易

這是向Solana區塊鏈發送傳輸指令的工作示例，您可以使用自定義RPC端點的端點超越端點。

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

Borh值得注意和挑選

為了使Borsh序列化/值得起作用，必須傳遞或定義基於程序IDL的程序結構的類::架構對象。例如

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

Borsh使用（PHP實施）

為了更好地了解實施和用法，請參閱以下參考文獻：

• PHP Borsh測試
• PHP Borsh班
• PHP Borsh特質

示例用法（這將得到改善，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 ;
    }

筆記：

• 大多數魔術都是在Borshdesealizable.php特徵中完成的。
• 該項目在Alpha中，生成指令的代碼仍在使用$instruction = SystemProgram::abc()上。
• 該項目由單個開發人員維護，因此任何反饋，想法，評論都將受到讚賞。

路線圖（WIP）

1. Borsh序列化並進行序列化。完成 - 測試 - 覆蓋範圍

2. 改進的文檔。 WIP-此文檔 +文檔索引（https://github.com/attestto-com/solana-php-sdk/tree/master/docs）

3. 構建更多的連接，消息，系統程序，TokenProgram，Metaplex Program類。 WIP-測試 - 覆蓋範圍4。 ] Spl -Token程序10。 [] getorCreateAssciedInAccount（）11。 [] GetAssivicatiedTokenAddressync（）12。

4. 改善圍繞使用二進制數據的抽象。完畢？ - 測試 - 覆蓋範圍

5. 最佳化:

   1. 更多地利用PHP。
   2. 發送交易時，更好的Cache $recentBlockhash 。

6. 建議？打開問題或拉請請求：D

測試和代碼覆蓋

WIP-致力於覆蓋範圍和貶值。請參閱覆蓋報告。

• 配置phpunit.xml
• 作曲家

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

composer test

或者

/verdor/bin/phpunit tests [options]

貢獻 - 是的！ ：p

• 請有關詳細信息，請參閱貢獻。
• 一旦我們在船上獲得第二架架麥納劑後，我將更改我的個人資料圖片:-)

安全

如果發現任何與安全有關的問題，請通過電子郵件發送維護者（請參閱Composer.json），而不是使用問題跟踪器。

學分

• 馬特·斯塔弗（Matt Stauffer）（原始創作者）
• Zach Vander Velden（元數據嚮導）
• 靜脈（以前的維護者）
• 所有貢獻者

執照

麻省理工學院許可證（麻省理工學院）。請參閱許可證文件以獲取更多信息。