solana php sdk

سولانا PHP SDK

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

PHP SDK بسيطة للتفاعل مع المعاملات والتوقيعات والتسلسل Borsh/Deserialization و RPCs

متشوق من repo verze: verze-app/solana-php-sdk

---

الدوافع

• لحماية مفاتيح API RPC التي تعمل كوكيل مستضافة.
• لتمكين معالجة بيانات الخلفية.
• لتمكين Descentralized البيانات والتخزين المؤقت للاستعلام.
• لتمكين تطبيقات PHP للتفاعل مع شبكة Solana
• لتمكين وظائف واستفسارات ASYNC في الخلفية.
• لتمكين Websockets الألغاز (دفع الإخطارات والاشتراكات)
• للحد من استطلاع الرابطة المسبقة عن العميل ، تهدف إلى إلحاق Mainnet و DevNets.

تثبيت

يمكنك تثبيت الحزمة عبر الملحن:

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
• تأليف dev.yaml

docker build -t solana-php-sdk .

ثم

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

الاستخدام

باستخدام عميل سولانا البسيط

يمكنك استخدام فئة 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 blockchain ، يمكنك تجاوز نقطة النهاية بنقطة نهاية مخصصة لـ 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 );

Borsh deserialize & deserialize

بالنسبة إلى Borsh Serialization/Diseralization ، يجب تمرير أو تحديد كائن Scream :: Class: على سبيل المثال

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

استخدام بورش (تطبيق PHP)

للحصول على فهم أفضل للتنفيذ والاستخدام ، يرجى الرجوع إلى المراجع التالية:

• اختبار PHP Borsh
• PHP Borsh Class
• 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.
• هذا المشروع في ألفا ، لا يزال يتم تشغيل التعليمات البرمجية لإنشاء تعليمات على $instruction = SystemProgram::abc()
• يتم الحفاظ على هذا المشروع من خلال dev واحد ، لذلك يتم تقدير أي ملاحظات ، أفكار ، التعليقات.

خريطة الطريق (WIP)

1. Borsh التسلسل و deserialize. تم - الاختبار (الاختبارات) - التغطية

2. تحسين الوثائق. WIP-هذا المستند + فهرس الوثائق (https://github.com/attestto-com/solana-php-sdk/tree/master/docs)

3. قم بإنشاء المزيد من الاتصالات والرسالة وبرنامج SystemProgram و TokenProgram و MetaplexProgram. WIP - الاختبارات - التغطية 4. [] Connection :: class 5. برنامج spl -token 10. [] getorcreateassociedtokenscount () 11. [] getAssociedTokenAddressSync () 12. [] createassociedtokenCountIntruction () 11.

4. تحسين التجريدات حول العمل مع البيانات الثنائية. منتهي؟ - الاختبار (S) - التغطية

5. التحسينات:

   1. الاستفادة من PHP أكثر.
   2. أفضل ذاكرة التخزين $recentBlockhash عند إرسال المعاملات.

6. اقتراحات؟ افتح مشكلة أو طلب سحب: د

تغطية الاختبار وتغطية الرمز

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

• يرجى الاطلاع على المساهمة للحصول على التفاصيل.
• سأقوم بتغيير صورة ملفي الشخصي بمجرد أن نحصل على مانتين 2nd على متن الطائرة :-)

حماية

إذا اكتشفت أي مشكلات متعلقة بالأمان ، فيرجى إرسال بريد إلكتروني إلى المشرفين (انظر Composer.json) بدلاً من استخدام متتبع المشكلة.

الاعتمادات

• مات ستوفر (المبدع الأصلي)
• زاك فاندر فيلن (معالج البيانات الوصفية)
• Neverything (المشرف السابق)
• جميع المساهمين

رخصة

ترخيص معهد ماساتشوستس للتكنولوجيا (MIT). يرجى الاطلاع على ملف الترخيص لمزيد من المعلومات.