Add Abi tests and refactoring

extraton · Nov 15, 2020 · 60cadfe · 60cadfe
1 parent 0b523e8
commit 60cadfe
Show file tree

Hide file tree

Showing 29 changed files with 529 additions and 237 deletions.
diff --git a/src/Abi.php b/src/Abi.php
@@ -19,18 +19,8 @@
 /**
  * Provides message encoding and decoding according to the ABI specification
  */
-class Abi
+class Abi extends AbstractModule
 {
-    private TonClient $tonClient;
-
-    /**
-     * @param TonClient $tonClient
-     */
-    public function __construct(TonClient $tonClient)
-    {
-        $this->tonClient = $tonClient;
-    }
-
     /**
      * Encodes message body according to ABI function call
      *
@@ -63,28 +53,22 @@ public function encodeMessageBody(
     }
 
     /**
-     * Attach signature to message body
+     * Decodes message body using provided body BOC and ABI
      *
-     * @param AbiParams $abi Contract ABI
-     * @param string $publicKey Public key. Must be encoded with hex
-     * @param string $message Unsigned message BOC. Must be encoded with base64
-     * @param string $signature Signature. Must be encoded with hex
-     * @return ResultOfAttachSignatureToMessageBody
+     * @param AbiParams $abi Contract ABI used to decode
+     * @param string $body Message body BOC encoded in base64
+     * @param bool $isInternal True if the body belongs to the internal message
+     * @return DecodedMessageBody
      */
-    public function attachSignatureToMessageBody(
-        AbiParams $abi,
-        string $publicKey,
-        string $message,
-        string $signature
-    ): ResultOfAttachSignatureToMessageBody {
-        return new ResultOfAttachSignatureToMessageBody(
+    public function decodeMessageBody(AbiParams $abi, string $body, bool $isInternal = false): DecodedMessageBody
+    {
+        return new DecodedMessageBody(
             $this->tonClient->request(
-                'abi.attach_signature_to_message_body',
+                'abi.decode_message_body',
                 [
-                    'abi'        => $abi,
-                    'public_key' => $publicKey,
-                    'message'    => $message,
-                    'signature'  => $signature,
+                    'abi'         => $abi,
+                    'body'        => $body,
+                    'is_internal' => $isInternal,
                 ]
             )->wait()
         );
@@ -124,6 +108,26 @@ public function encodeMessage(
         );
     }
 
+    /**
+     * Decodes message body using provided message BOC and ABI
+     *
+     * @param AbiParams $abi Contract ABI used to decode
+     * @param string $message Boc message
+     * @return DecodedMessageBody
+     */
+    public function decodeMessage(AbiParams $abi, string $message): DecodedMessageBody
+    {
+        return new DecodedMessageBody(
+            $this->tonClient->request(
+                'abi.decode_message',
+                [
+                    'abi'     => $abi,
+                    'message' => $message,
+                ]
+            )->wait()
+        );
+    }
+
     /**
      * Combines hex-encoded signature with base64-encoded unsigned_message. Returns signed message encoded in base64
      *
@@ -153,42 +157,28 @@ public function attachSignature(
     }
 
     /**
-     * Decodes message body using provided message BOC and ABI
-     *
-     * @param AbiParams $abi Contract ABI used to decode
-     * @param string $message Boc message
-     * @return DecodedMessageBody
-     */
-    public function decodeMessage(AbiParams $abi, string $message): DecodedMessageBody
-    {
-        return new DecodedMessageBody(
-            $this->tonClient->request(
-                'abi.decode_message',
-                [
-                    'abi'     => $abi,
-                    'message' => $message,
-                ]
-            )->wait()
-        );
-    }
-
-    /**
-     * Decodes message body using provided body BOC and ABI
+     * Attach signature to message body
      *
-     * @param AbiParams $abi Contract ABI used to decode
-     * @param string $body Message body BOC encoded in base64
-     * @param bool $isInternal True if the body belongs to the internal message
-     * @return DecodedMessageBody
+     * @param AbiParams $abi Contract ABI
+     * @param string $publicKey Public key. Must be encoded with hex
+     * @param string $message Unsigned message BOC. Must be encoded with base64
+     * @param string $signature Signature. Must be encoded with hex
+     * @return ResultOfAttachSignatureToMessageBody
      */
-    public function decodeMessageBody(AbiParams $abi, string $body, bool $isInternal = false): DecodedMessageBody
-    {
-        return new DecodedMessageBody(
+    public function attachSignatureToMessageBody(
+        AbiParams $abi,
+        string $publicKey,
+        string $message,
+        string $signature
+    ): ResultOfAttachSignatureToMessageBody {
+        return new ResultOfAttachSignatureToMessageBody(
             $this->tonClient->request(
-                'abi.decode_message_body',
+                'abi.attach_signature_to_message_body',
                 [
-                    'abi'         => $abi,
-                    'body'        => $body,
-                    'is_internal' => $isInternal,
+                    'abi'        => $abi,
+                    'public_key' => $publicKey,
+                    'message'    => $message,
+                    'signature'  => $signature,
                 ]
             )->wait()
         );

diff --git a/src/AbstractModule.php b/src/AbstractModule.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Extraton\TonClient;
+
+abstract class AbstractModule implements Module
+{
+    protected TonClient $tonClient;
+
+    /**
+     * @param TonClient $tonClient
+     */
+    public function __construct(TonClient $tonClient)
+    {
+        $this->tonClient = $tonClient;
+    }
+
+    /**
+     * @return TonClient
+     */
+    public function getTonClient(): TonClient
+    {
+        return $this->tonClient;
+    }
+}
diff --git a/src/Boc.php b/src/Boc.php
@@ -10,18 +10,8 @@
 /**
  * Boc module
  */
-class Boc
+class Boc extends AbstractModule
 {
-    private TonClient $tonClient;
-
-    /**
-     * @param TonClient $tonClient
-     */
-    public function __construct(TonClient $tonClient)
-    {
-        $this->tonClient = $tonClient;
-    }
-
     /**
      * Parses message boc
      *