README

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

用于与交易、签名、Borsh序列化和反序列化以及RPC交互的简单PHP SDK

从Verze仓库分支： verze-app/solana-php-sdk

动机

保护作为托管代理操作的RPC API密钥。
启用后台数据处理。
启用去中心化数据查询缓存。
赋予PHP应用程序与Solana网络交互的能力
启用后台异步作业和查询。
启用去中心化WebSockets（推送通知和订阅）
减少客户端RPC轮询，旨在缓解主网和开发网的拥堵。

安装

您可以通过composer安装此包

composer require attestto/solana-php-sdk

从本仓库

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

cd solana-php-sdk

composer install

使用Docker

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

Borsh反序列化与序列化

为了使Borsh序列化和反序列化工作，必须传递或定义一个基于程序IDL的class::SCHEMA对象，该对象反映程序结构。例如。

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实现）

为了更好地了解实现和使用方法，请参阅以下参考资料

示例用法 （这将得到改进，工作中）

/**
     * 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;
    }

注意

大部分魔法都在BorshDeserializable.php特性中完成。
此项目处于alpha阶段，生成指令的代码仍在开发中$instruction = SystemProgram::abc()
此项目由一名开发者维护，因此任何反馈、想法、评论都将受到欢迎。

路线图（工作中）

Borsh序列化和反序列化。完成 - 测试 - 覆盖率
改进文档。工作中 - 此文档 + 文档索引 (https://github.com/Attestto-com/solana-php-sdk/tree/master/docs)
扩展连接、消息、系统程序、令牌程序、元数据程序类。 WIP - 测试 - 覆盖率 4. [ ] Connection::class 5. [x] getLatestBlokchash::class [源] - [测试] - [覆盖率] 6. [ ] getMinimumBalanceForRentExemption() 7. [ ] getTokenAccountBalance() 6. [ ] TransactionMessage::class 7. [ ] compileToV0Message() 8. [ ] VersionedTransaction::class 9. [ ] SPL-TOKEN Program 10. [ ] getOrCreateAssociatedTokenAccount() 11. [ ] getAssociatedTokenAddressSync() 12. [ ] createAssociatedTokenAccountInstruction() 11. [ ] createSyncNativeInstruction() - [测试][覆盖率]
改善与二进制数据交互的抽象。完成？ - 测试 - 覆盖率
优化
1. 更好地利用PHP。
2. 在发送交易时更好地缓存 $recentBlockhash。
有建议吗？请开启一个问题或拉取请求 :D

测试与代码覆盖率

WIP -- 正在处理覆盖率和弃用功能。请查看覆盖率报告。

配置 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"
    },

composer test

或

/verdor/bin/phpunit tests [options]

贡献 - 欢迎加入！:-P

请查看 CONTRIBUTING 以获取详细信息。
一旦我们有了第二个维护者，我将更换我的个人资料图片 :)

安全

如果您发现任何安全相关的问题，请通过电子邮件联系维护者（请参阅 composer.json），而不是使用问题跟踪器。

致谢

Matt Stauffer（原始创建者）
Zach Vander Velden（元数据专家）
Neverything（前维护者）
所有贡献者

许可

MIT许可（MIT）。请参阅许可文件以获取更多信息。

cryptothree / solana-php-sdk

维护者

详细信息