Adding unit tests

Updating the documentation

Author: leganz

docs/advanced/bundlers.md

@@ -0,0 +1,53 @@
+# Bundlers
+
+Like many other blockchain, also the ardor blockchain suffers from a major issue. Sending transactions costs. While other blockchains does not have a proper solution to resolve that issue, ardor offers you muliple ways of solve that issue.
+
+[Bundling](https://ardordocs.jelurida.com/Bundling) transactions provides you the possibilities to fund or pay the transaction fees of others. While the "native" approach must be written in java and run as part of a ardor node, this package provides you - lets call it "easy" - approach to solve that within your laravel application.
+
+## PHP Bundlers 
+
+### How to create a bundler
+
+```bash
+php artisan ardor:make {name} --type=bundler
+```
+
+Define your bundler in the ardor config file.
+
+```php
+...
+'bundlers' => [
+    \AMBERSIVE\Ardor\Bundlers\DefaultTransactionBundler::class
+],
+...
+```
+
+Modify your bundler logic. Every bundler has a **run** function which needs to return a boolean value.
+
+```php
+/**
+ * Main entry point for the bundler
+ *
+ * @param  mixed $transaction
+ * @return bool
+ */
+public function run(ArdorTransactionJson $transaction):bool {
+    if (in_array($transaction->senderRS, data_get($this->config, 'accounts', []))){
+        return $this->ardorBundler->bundleTransactions($transaction->fullHash, $transaction->chain);
+    }
+    return false;
+}
+```
+
+### How can i run the bundler?
+
+To run the bundlers just run the following command in your command line:
+
+```bash
+php artisan ardor:run-bundler
+```
+
+Every transaction will only be processed once within a timeframe of 15 minutes, cause resolving the transation data triggers multiple cals in the api which might cause performance problems.
+
+If a transactin was bundled the bundling process for this specific bundler will stop.
+

docs/overview.md

@@ -52,8 +52,8 @@ Not implemented yet
 - [calculateFee](transactions/calculateFee.md)
 - [calculateFeeByTransactionsBytes](transactions/calculateFeeByTransactionsBytes.md)
 - [getUnconfirmedTransactions](transactions/getUnconfirmedTransactions.md)
-- [getTransactionBytes](transations/getTransactionBytes.md)
-- [getTransaction](transations/getTransaction.md)
+- [getTransactionBytes](transactions/getTransactionBytes.md)
+- [getTransaction](transactions/getTransaction.md)
 
 ## Voting System
 Not implemented yet
@@ -69,3 +69,6 @@ Not implemented yet
 
 ## Add-ons
 Not implemented yet
+
+## Advanced topics
+- [PHP Bundlers](advanced/bundlers.md)

docs/transations/calculateFee.md renamed to docs/transactions/calculateFee.md

@@ -0,0 +1,14 @@
+# Get unconfirmed transactions 
+
+Getting unconfirmed transactions is a every useful endpoint. Cause our custom bundler implementation is based on this information. This implementation is part of the ArdorBlockchain Class.
+
+```php
+$chain = 2; // = IGNIS
+$blockchain = new ArdorBlockchain();
+$result = $blockchain->getUnconfirmedTransactions($chain);
+```
+
+This request will return a instance of [ArdorTransactionCollection](../../src/Models/ArdorTransactionCollection.php).
+
+---
+Return to the [overview](../overview.md) page for all topics.

docs/transations/calculateFeeByTransactionsBytes.md renamed to docs/transactions/calculateFeeByTransactionsBytes.md

@@ -24,7 +24,6 @@ public function __construct(object $data){
             return new ArdorTransactionJson($item);
         });      
 
-        //$this->transactionJSON = isset($data->transactionJSON) ? new ArdorTransactionJson($data->transactionJSON) : new ArdorTransactionJson((object) []);
     }
 
 }

docs/transations/getTransaction.md renamed to docs/transactions/getTransaction.md

@@ -21,8 +21,13 @@ class ArdorBlockchainTest extends TestArdorCase
      */
     public function testArdorBlockchainGetTransaction():void {
 
+        // Prepare
+        $responseMessage = new ArdorMockResponse(200, ["fullHash" => "68df1c0eb56059cae1dbaa57efe161762d57e996e38b844abcad7fd1c017b33d"]);
+
+        // Test
         $blockchain = new ArdorBlockchain();
         $result = $blockchain
+                    ->setClient($this->createApiMock([$responseMessage]))      
                     ->getTransaction("68df1c0eb56059cae1dbaa57efe161762d57e996e38b844abcad7fd1c017b33d", 2);
 
         $this->assertNotNull($result);
@@ -35,8 +40,13 @@ public function testArdorBlockchainGetTransaction():void {
      */
     public function testArdorBlockchainGetTransactionWonTFailsDueIncorrectChain():void {
 
+        // Prepare
+        $responseMessage = new ArdorMockResponse(200, ["fullHash" => "68df1c0eb56059cae1dbaa57efe161762d57e996e38b844abcad7fd1c017b33d"]);
+
+        // Test
         $blockchain = new ArdorBlockchain();
         $result = $blockchain
+                    ->setClient($this->createApiMock([$responseMessage]))
                     ->getTransaction("68df1c0eb56059cae1dbaa57efe161762d57e996e38b844abcad7fd1c017b33d", 1);
 
         $this->assertNotNull($result);
@@ -62,8 +72,17 @@ public function testArdorBlockchainGetTransactionFailsDueIncorrectChain():void {
      */
     public function testArdorBlockchainGetTransactionBytes():void {
 
+        // Prepare
+        $responseMessage = new ArdorMockResponse(200, [
+            "unsignedTransactionBytes" => "020000000100010f04b4040f00850ec0aeeadd6c71804128f422cb621b89072805fa228be4369fe0e9d25d1309f0a335f1de518c6300000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008d3d4c009e95d1ccdb70f744010000000101040074657374000000000000000000000000000000000000000000000000000000000000000000000000",
+            "requestProcessingTime" =>  0,
+            "transactionBytes" => "020000000100010f04b4040f00850ec0aeeadd6c71804128f422cb621b89072805fa228be4369fe0e9d25d1309f0a335f1de518c6300000000000000000000000000000000e3bd3f9542a9419f3cd99365828089ff06a6b0094734bdce6bb8dc41115f1b02190327eaed5c25bec826009b2f31e039bd16ac6d301c3c739f4d0ac24a9decd68d3d4c009e95d1ccdb70f744010000000101040074657374000000000000000000000000000000000000000000000000000000000000000000000000"
+        ]);
+
+        // Test
         $blockchain = new ArdorBlockchain();
         $result = $blockchain
+                    ->setClient($this->createApiMock([$responseMessage]))
                     ->getTransactionBytes("68df1c0eb56059cae1dbaa57efe161762d57e996e38b844abcad7fd1c017b33d", 1);
 
         $this->assertNotNull($result);
@@ -73,7 +92,28 @@ public function testArdorBlockchainGetTransactionBytes():void {
         $this->assertNotNull($result->unsignedTransactionBytes);
         $this->assertNotNull($result->transactionBytes);
 
-        dd($result);
+    }
+
+    /**
+     * Test if the getUnconfirmedTransactions returns a ArdorTransactionCollection
+     */
+    public function testArdorBlockchainGetUnconfirmedTransactions():void {
+
+        // Prepare
+
+        $messenger = new ArdorMessenger();        
+        $resultMessage = $messenger
+                            ->setFee(1)
+                            ->sendMessage("ARDOR-DAZJ-VVSM-552M-8K459", "test", false, ['broadcast' => true, 'broadcasted' => true]);
+
+        // Test
+        $blockchain = new ArdorBlockchain();
+        $result = $blockchain->getUnconfirmedTransactions(2);
+        
+        $this->assertNotNull($result);
+        $this->assertTrue(isset($result->transactions));
+        $this->assertTrue($result->transactions->count() > 0);
+        $this->assertTrue($result instanceof \AMBERSIVE\Ardor\Models\ArdorTransactionCollection);
     }
 
 }