README

这是专为用 PHP 编写的应用程序提供的官方 Twala SDK。

安装

只需克隆此存储库，并用 PSR-4 自动加载器加载。

您还可以通过以下命令安装 Twala SDK 的最新版本

composer require twala-io/twala-php

此 SDK 在生产环境中没有外部依赖。这意味着您可以在任何 PHP 项目中使用此库，即使您没有访问 Composer 的权限。

要求

此 SDK 需要 PHP 7.3 或更高版本，以下扩展

• sop/asn1
• sop/crypto-types
• sop/crypto-encoding
• web3p/ethereum-util
• kornrunner/keccak
• ramsey/uuid

支持的 PHP 版本：7.3，7.4，8.0，8.1，8.2。

入门

请按照 安装过程 进行操作，然后创建一个具有以下内容的入口点 PHP 文件

<?php

// Import a PSR-4 autoloader
require_once(__DIR__ . '/autoload.php');

// Set your API Keys 👇 here
$appUuid = 'your_app_uuid'; // Replace with your app UUID
$appSecret = 'your_app_secret'; // Replace with your app secret

// Instantiate Twala SDK
$sdk = new \Twala\Sdk($appUuid, $appSecret);

// Generate account keys
$account = $sdk->generateAccountKeys();

// Generate nonce / uuid
$uuid = $sdk->generateNonce();

// Sign document uuid
$signature = $sdk->signDocumentUuid($uuid, $account['private_key']);

// Recover address from signature digest
$recover = $sdk->recoverAddress(
    $signature['message_hash'],
    $signature['v'],
    $signature['r'],
    $signature['s']
);

创建 \Twala\Sdk() 的新实例时，API 密钥是可选的。

请注意，API 的某些部分可能需要使用您自己的 API 密钥。

测试

要运行单元测试，请使用

composer install
vendor/bin/phpunit

故障排除

如果您遇到任何问题，请随意通过分叉 SDK 并提交更改的拉取请求来贡献我们的故障排除过程。要报告问题并跟踪进度，请在此 GitHub 存储库中创建新的问题。

支持

twala-php 的最新主要版本包括新功能和错误修复。为了利用新功能和错误修复，包括安全漏洞的修复，如果您正在使用较早的主要版本，我们建议您升级到最新版本。此包的较旧主要版本仍然可以使用，但不会收到更新。