Adjust Readme.md with more info about Borsh

Author: chongkan

README.md

@@ -5,7 +5,7 @@
 [![Coverage (CodeCov)](https://codecov.io/github/Attestto-com/solana-php-sdk/graph/badge.svg?token=M12LECZ9QE)](https://codecov.io/github/Attestto-com/solana-php-sdk)
 ---
 
-:notice: Forked from:  [verze-app/solana-php-sdk](https://github.com/verze-app/solana-php-sdk)
+## notice: Forked from the abandoned repo:  [verze-app/solana-php-sdk](https://github.com/verze-app/solana-php-sdk)
 
 ---
 
@@ -79,8 +79,8 @@ For Borsh serialization/deseralization to work, a class::SCHEMA object reflectin
 class DidData
 {
 
-    use BorshDeserializable;
-
+    use BorshObject; //trait
+    public $keyData;
 
     public const SCHEMA = [
         VerificationMethodStruct::class => VerificationMethodStruct::SCHEMA[VerificationMethodStruct::class],
@@ -110,8 +110,46 @@ class DidData
     }
 }
 ```
+## BORSH USAGE (PHP implementation)
+
+To get a better understanding on the implementation and usage, please refer to the following references: 
+
+- [PHP Borsh Test](https://github.com/Attestto-com/solana-php-sdk/blob/master/tests/Unit/BorshTest.php)
+- [PHP Borsh Class](https://github.com/Attestto-com/solana-php-sdk/blob/master/src/Borsh/Borsh.php)
+- [PHP Borsh Trait](https://github.com/Attestto-com/solana-php-sdk/blob/master/src/Borsh/BorshObject.php)
+
+example usage _**(This will be improved, WIP)**_: 
+```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;
 
-Note: This project is in alpha, the code to generate instructions is still being worked on `$instruction = SystemProgram::abc()`
+        $binaryString = pack('C*', ...$keyData);
+
+        $b58 = new Base58();
+        $base58String = $b58->encode($binaryString);
+        $didData->keyData = $base58String;
+        return $didData;
+    }
+```
+
+## Notes:
+
+- Most of the Magic is done in the [BorshDesealizable.php](https://github.com/Attestto-com/solana-php-sdk/blob/master/src/Borsh/BorshDeserializable.php) Trait. 
+- This project is in alpha, the code to generate instructions is still being worked on `$instruction = SystemProgram::abc()`
+- This project is maintained by a single dev, so any feedback, ideas, comments are appreciated. 
 
 ## Roadmap (WIP)
 
@@ -124,7 +162,14 @@ Note: This project is in alpha, the code to generate instructions is still being
    2. Better cache `$recentBlockhash` when sending transactions.
 6. Suggestions? Open an issue or PR :D
 
-## Testing
+## Testing & Code Coverage
+
+WIP -- Working on coverage and deprecations. See [Coverage Report](https://app.codecov.io/github/Attestto-com/solana-php-sdk).
+
+
+[![GitHub Tests Action Status](https://github.com/Attestto-com/solana-php-sdk/actions/workflows/run-tests.yml/badge.svg?branch=master)](https://github.com/Attestto-com/solana-php-sdk/actions/workflows/run-tests.yml)
+[![Coverage (CodeCov)](https://codecov.io/github/Attestto-com/solana-php-sdk/graph/badge.svg?token=M12LECZ9QE)](https://codecov.io/github/Attestto-com/solana-php-sdk)
+
 
 ```bash
 composer test

composer.json

@@ -31,7 +31,7 @@
         }
     ],
     "require": {
-        "php": "~8.0",
+        "php": "~8.2",
         "ext-sodium": "*",
         "guzzlehttp/guzzle": "^7.3",
         "paragonie/sodium_compat": "^1.17",

docs/CLI.md

@@ -0,0 +1,105 @@
+## SOLANA SDK CLI for Newbies
+
+[Solana CLI Installation Instructions](https://docs.solanalabs.com/cli/install)
+
+## Why installing the CLI?
+
+I actually installed the CLI long time ago but never used it and tried with no luck to get things working using Vanilla JS and the Web3.js in intermittent attempts. ( hint: It doesn't work because the Web3.js package uses node.js libraries, as far as I know ) 
+
+So, why is it needed? 
+
+Answer: Because the browser wallets provide very limited functionality when using them in DEV mode. 
+
+## Getting Started
+
+#### 1- **Install a FileSystem Wallet (DEVNET)** [Docs](https://docs.solanalabs.com/cli/wallets/paper)
+
+DO NOT do this for a Mainnet wallet as your keys would be residing in the Filesystem. You need to provide a valid URL, custom RPCs are not supported ( not recognized )
+
+```bash
+ solana config set --url https://api.devnet.solana.com
+```
+
+#### 2- Fund the Wallet with more than SOL: 
+
+The following cmd generates a new keypair and stores it in the following path by default: _/Users/[yourUser]/.config/solana/id.json_
+
+```bash
+solana-keygen new
+```
+
+#### 3- Verifying the configuration: 
+
+```bash
+solana config get
+```
+
+Output: 
+
+```bash 
+Config File: /Users/eduardochongkan/.config/solana/cli/config.yml
+RPC URL: https://api.devnet.solana.com
+WebSocket URL: wss://api.devnet.solana.com/ (computed)
+Keypair Path: Pasv78UQDTJyPLSS8FTtCekyZHJoPcZCjiGWkr7hdzy.json
+Commitment: confirmed
+```
+
+#### 4- Funding the Wallet:
+
+To fund the local wallet: 
+```bash
+solana airdrop 1
+```
+
+To fund a remote wallet, e.g. a Phantom Wallet. If it fails due to Rate Limiting, try again with 0.5 Sol. 
+
+```bash
+solana airdrop 1 3Js7k6xYQbvXv6qUYLapYV7Sptfg37Tss9GcAyVEuUqk 
+```
+OR 
+```bash
+solana airdrop 0.5 3Js7k6xYQbvXv6qUYLapYV7Sptfg37Tss9GcAyVEuUqk 
+```
+
+Then 
+
+```bash
+solana balance
+```
+OR 
+```bash
+solana balance 3Js7k6xYQbvXv6qUYLapYV7Sptfg37Tss9GcAyVEuUqk 
+```
+
+#### Wrapped Sol (wSol)
+
+```bash
+spl-token --url devnet wrap 0.5 
+```
+Outputs:
+```bash
+Wrapping 0.5 SOL into GdDubLim7hPPv95X2xPdKtbvWt4gJJ4uHfUYrPbxmKuZ
+
+Signature: ertqCkWCkwtgCzDFtXbyNvFL9zEiqTmHX6zjMxpGXqAuPH8n7FCEaAnL7MiQpmL6cWGVWtEBVPXcRkqSKAvYNrx
+```
+
+#### Getting Token Balance
+
+```bash
+solana balance GdDubLim7hPPv95X2xPdKtbvWt4gJJ4uHfUYrPbxmKuZ
+```
+Outputs (that is wrapped Sol (wSol))
+```bash
+0.5 SOL
+```
+OR
+
+```bash
+spl-token 
+```
+
+### Some DEVNET Token Mints: 
+
+- [Devnet USDC](https://explorer.solana.com/address/DL4ivZm3NVHWk9ZvtcqTchxoKArDK4rT3vbDx2gYVr7P?cluster=devnet): 4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU
+- [Devnet USDT](https://explorer.solana.com/address/EJwZgeZrdC8TXTQbQBoL6bfuAnFUUy1PVCMB4DYPzVaS?cluster=devnet): EJwZgeZrdC8TXTQbQBoL6bfuAnFUUy1PVCMB4DYPzVaS
+- [Devnet SOL (wSOL](https://explorer.solana.com/address/So11111111111111111111111111111111111111112?cluster=devnet): So11111111111111111111111111111111111111112

src/.DS_Store

@@ -9,7 +9,7 @@
 use Attestto\SolanaPhpSdk\SolanaRpcClient;
 
 /**
- * Class DidSolProgram
+ * Class DidSolProgram - Work In Progress
  * 
  * This class represents a program for interacting with the Solana blockchain using the DID (Decentralized Identifier) protocol.
  * It provides methods for creating and managing DID accounts, signing and verifying messages, and other related operations.

src/Programs/DidSolProgram.php

@@ -2,6 +2,7 @@
 
 namespace Attestto\SolanaPhpSdk\Programs\SNS;
 
+use Attestto\SolanaPhpSdk\Exceptions\InputValidationException;
 use Attestto\SolanaPhpSdk\PublicKey;
 use Attestto\SolanaPhpSdk\Connection;
 use Attestto\SolanaPhpSdk\Exceptions\GenericException;
@@ -13,7 +14,8 @@ class Utils
 {
 
     // config.json file should be in the same directory as this file
-    public $config;
+    public mixed $config;
+    public $centralStateSNSRecords;
 
 
     // Constructor
@@ -25,7 +27,7 @@ public function __construct($config = null)
             $this->config = $this->loadConstants();
         }
         $sns_records_id = new PublicKey($this->config['BONFIDA_SNS_RECORDS_ID']);
-        //dd($sns_records_id);
+
         $this->centralStateSNSRecords = PublicKey::findProgramAddressSync(
             [$sns_records_id],
              $sns_records_id);
@@ -47,11 +49,12 @@ public function getHashedNameSync(string $name): Buffer
     }
 
     /**
-     * @deprecated Use {@link getNameAccountKeySync} instead
-     * @param string $hashedName The hashed name buffer
+     * @param Buffer $hashed_name
      * @param PublicKey|null $nameClass The name class public key
      * @param PublicKey|null $nameParent The name parent public key
      * @return PublicKey The public key of the name account
+     * @throws InputValidationException
+     * @deprecated Use {@link getNameAccountKeySync} instead
      */
     public function getNameAccountKeySync(
         Buffer $hashed_name,

src/Programs/SNS/Utils.php

@@ -2,15 +2,27 @@
 
 namespace Attestto\SolanaPhpSdk;
 
+use GuzzleHttp\Handler\StreamHandler;
+use GuzzleHttp\Psr7\Message;
+use GuzzleHttp\Psr7\Uri;
+
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestFactoryInterface;
-use Psr\Http\Message\ResponseInterface;
+use GuzzleHttp\Client as GuzzleClient;
+use GuzzleHttp\Psr7\Request;
+use GuzzleHttp\Psr7\Response;
+use GuzzleHttp\Psr7\HttpFactory;
+
+
 use Attestto\SolanaPhpSdk\Exceptions\GenericException;
 use Attestto\SolanaPhpSdk\Exceptions\InvalidIdResponseException;
 use Attestto\SolanaPhpSdk\Exceptions\MethodNotFoundException;
 use Psr\Http\Message\StreamFactoryInterface;
+use Psr\Http\Message\StreamInterface;
 use Psr\Http\Message\UriFactoryInterface;
+use Random\RandomException;
+
 
 /**
  * @see https://docs.solana.com/developing/clients/jsonrpc-api
@@ -49,24 +61,25 @@ class SolanaRpcClient
 
     /**
      * @param string $endpoint
-     * @param ClientInterface $httpClient
-     * @param RequestFactoryInterface $requestFactory
-     * @param StreamFactoryInterface $streamFactory
-     * @param UriFactoryInterface $uriFactory
+     * @param ClientInterface|null $httpClient
+     * @param RequestFactoryInterface|null $requestFactory
+     * @param StreamFactoryInterface|Message|null $streamFactory
+     * @param UriFactoryInterface|null $uriFactory
+     * @throws RandomException
      */
     public function __construct(
         string $endpoint,
-        ClientInterface $httpClient,
-        RequestFactoryInterface $requestFactory,
-        StreamFactoryInterface $streamFactory,
-        UriFactoryInterface $uriFactory
+        ClientInterface $httpClient = null,
+        RequestFactoryInterface $requestFactory = null,
+        StreamFactoryInterface|Message $streamFactory= null ,
+        UriFactoryInterface $uriFactory= null
     ) {
-        $this->endpoint = $endpoint;
+        $this->endpoint = $endpoint ? : self::DEVNET_ENDPOINT;
         $this->randomKey = random_int(0, 99999999);
-        $this->httpClient = $httpClient;
-        $this->requestFactory = $requestFactory;
-        $this->streamFactory = $streamFactory;
-        $this->uriFactory = $uriFactory;
+        $this->httpClient = $httpClient?: new GuzzleClient();
+        $this->requestFactory = $requestFactory?: new HttpFactory();
+      // $this->streamFactory = $streamFactory;
+      //  $this->uriFactory = $uriFactory?: new Uri();
     }
 
     /**
@@ -84,10 +97,10 @@ public function call(string $method, array $params = [], array $headers = []): m
         $body = json_encode($this->buildRpc($method, $params));
         $request = $this->requestFactory->createRequest('POST', $this->endpoint)
             ->withHeader('Content-Type', 'application/json')
-            ->withHeader('Accept', 'application/json')
-            ->withBody($this->streamFactory->createStream($body));
+            ->withHeader('Accept', 'application/json');
+            //->withBody($this->streamFactory->createStream($body));
 
-        $response = $this->httpClient->request('POST', $this->endpoint, ['body' => $request->getBody()->getContents()]);
+        $response = $this->httpClient->request('POST', $this->endpoint, ['body' => $body]);
 
 
 

src/SolanaRpcClient.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Attestto\SolanaPhpSdk\Tests\Unit\Programs\SNS;
+
+use Attestto\SolanaPhpSdk\PublicKey;
+use Attestto\SolanaPhpSdk\Tests\TestCase;
+use Attestto\SolanaPhpSdk\TransactionInstruction;
+use Attestto\SolanaPhpSdk\Util\Buffer;
+use Attestto\SolanaPhpSdk\Borsh\Borsh;
+use Attestto\SolanaPhpSdk\Programs\SNS\InstructionBurn;
+use Attestto\SolanaPhpSdk\Programs\SNS\Utils;
+
+class DerivationTest extends TestCase
+{
+
+    private $items = [
+        [
+            'domain' => 'bonfida',
+            'address' => 'Crf8hzfthWGbGbLTVCiqRqV5MVnbpHB1L9KQMd6gsinb',
+        ],
+        [
+            'domain' => 'bonfida.sol',
+            'address' => 'Crf8hzfthWGbGbLTVCiqRqV5MVnbpHB1L9KQMd6gsinb',
+        ],
+        [
+            'domain' => 'dex.bonfida',
+            'address' => 'HoFfFXqFHAC8RP3duuQNzag1ieUwJRBv1HtRNiWFq4Qu',
+        ],
+        [
+            'domain' => 'dex.bonfida.sol',
+            'address' => 'HoFfFXqFHAC8RP3duuQNzag1ieUwJRBv1HtRNiWFq4Qu',
+        ],
+    ];
+
+    public function setUp(): void
+    {
+        parent::setUp();
+    }
+
+    /** @test */
+    public function it_derives_domain_key()
+    {
+        $utils = new Utils();
+        foreach ($this->items as $item) {
+            $result = $utils->getDomainKey($item['domain']);
+            $this->assertInstanceOf(PublicKey::class, $result['pubkey']);
+            $this->assertEquals($item['address'], $result['pubkey']->toBase58());
+        }
+
+        foreach ($this->items as $item) {
+            $result = $utils->getDomainKeySync($item['domain']);
+            $this->assertInstanceOf(PublicKey::class, $result['pubkey']);
+            $this->assertEquals($item['address'], $result['pubkey']->toBase58());
+        }
+    }
+  
+}