feat: generate vote report job

.gitignore

@@ -1,6 +1,7 @@
 /node_modules
 /public/hot
 /public/storage
+/public/VoteReport.txt
 /storage/*.key
 /vendor
 .env

app/Console/Commands/GenerateVoteReport.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Console\Commands;
+
+use App\Jobs\GenerateVoteReport as Job;
+use Illuminate\Console\Command;
+
+final class GenerateVoteReport extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'explorer:generate-vote-report';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Generate Vote Report file.';
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        (new Job())->handle();
+    }
+}

app/Console/Kernel.php

@@ -19,6 +19,7 @@
 use App\Console\Commands\CacheMultiSignatureAddresses;
 use App\Console\Commands\CacheNetworkAggregates;
 use App\Console\Commands\CachePrices;
+use App\Console\Commands\GenerateVoteReport;
 use Illuminate\Console\Scheduling\Schedule;
 use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
 
@@ -71,6 +72,8 @@ protected function schedule(Schedule $schedule)
         $schedule->command(CacheDelegatePerformance::class)->everyMinute();
 
         $schedule->command(CacheDelegateProductivity::class)->everyMinute();
+
+        $schedule->command(GenerateVoteReport::class)->everyFiveMinutes();
     }
 
     /**

app/Jobs/GenerateVoteReport.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Jobs;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Symfony\Component\Process\Process;
+
+final class GenerateVoteReport implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    public function handle(): void
+    {
+        (new Process(['bash', resource_path('scripts/vote-report.sh')]))
+            ->setTimeout(300)
+            ->run();
+    }
+}

phpunit.xml

@@ -27,6 +27,8 @@
                 <directory suffix=".php">./app/Providers</directory>
                 <directory suffix=".php">./app/View/Components</directory>
                 <file>./app/Console/Commands/RunPlaybookCommand.php</file>
+                <file>./app/Console/Commands/GenerateVoteReport.php</file>
+                <file>./app/Jobs/GenerateVoteReport.php</file>
                 <file>./app/Console/Kernel.php</file>
                 <file>./app/Http/Kernel.php</file>
                 <!-- Application Code -->

resources/scripts/vote-report.sh

@@ -0,0 +1,98 @@
+#!/bin/bash
+# Gr33nDrag0n / v1.2 / 2017-04-02
+# tharude / v.2.5.1 / 2019-07-12
+
+EXPLORER_NODE="https://wallets.ark.io/api"
+
+SCRIPT_PATH="$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
+OutputFile="$SCRIPT_PATH/../../public/VoteReport.txt"
+
+# echo $OutputFile
+# exit
+
+###############################################################################
+# FUNCTIONS
+###############################################################################
+
+function GetVotersCount {
+
+        VotersJsonData=$( curl -s "$EXPLORER_NODE/delegates/$1/voters?page=1&limit=1" )
+        echo $VotersJsonData | jq '.meta.totalCount'
+}
+
+#==============================================================================
+
+function PrintJsonData {
+
+        echo $1 | jq -c -r '.data[] | { rank, username, votes, address, publicKey, production }' | while read Line; do
+
+                Rank=$( printf %02d $( echo $Line | jq -r '.rank' ) )
+
+                Delegate=$( printf %-25s $( echo $Line | jq -r '.username' ) )
+                Approval=$( printf %0.2f $( echo $Line | jq -r '.production.approval' ) )
+
+                Vote=$( expr $( echo $Line | jq -r '.votes' ) / 100000000 )
+                Vote=$( echo $Vote | sed ':a;s/\B[0-9]\{3\}\>/,&/;ta' )
+                Vote=$( printf %10s $Vote )
+
+                PublicKey=$( echo $Line | jq -r '.publicKey' )
+                Voters=$( printf %4s $( GetVotersCount $PublicKey ) )
+
+                echo "|  $Rank  | $Delegate |  $Approval  | $Vote |  $Voters  |" >> $2
+        done
+}
+#==============================================================================
+
+function PrintTotalVotingWeightData {
+
+        TotalArk=$( curl -s "$EXPLORER_NODE/blockchain" | jq -r '.data.supply' )
+
+        TotalVote=0
+        TotalVoters=0
+        while read Line; do
+
+                Vote=$( echo $Line | jq -r '.votes' )
+                TotalVote=$( expr $TotalVote + $Vote )
+
+                PublicKey=$( echo $Line | jq -r '.publicKey' )
+                Voters=$( GetVotersCount $PublicKey )
+                TotalVoters=$( expr $TotalVoters + $Voters )
+
+        done <<< "$( echo $1 | jq -c -r '.data[] | { rank, username, votes, address, publicKey, production }' )"
+
+        Percentage=$( bc <<< "scale=2; $TotalVote * 100 / $TotalArk" )
+
+        TotalVote=$( expr $( echo $TotalVote ) / 100000000 )
+        TotalVote=$( echo $TotalVote | sed ':a;s/\B[0-9]\{3\}\>/,&/;ta' )
+
+        TotalArk=$( expr $( echo $TotalArk ) / 100000000 )
+        TotalArk=$( echo $TotalArk | sed ':a;s/\B[0-9]\{3\}\>/,&/;ta' )
+
+        echo -e "Top 51 Delegates Stats\n" >> $2
+        echo -e "=> Total Votes  : $Percentage% ( $TotalVote / $TotalArk )" >> $2
+        echo -e "=> Total Voters : $TotalVoters\n" >> $2
+}
+
+###############################################################################
+# MAIN
+###############################################################################
+
+JsonData1=$( curl -s "$EXPLORER_NODE/delegates?page=1&limit=51" )
+JsonData2=$( curl -s "$EXPLORER_NODE/delegates?limit=29&offset=51" )
+
+WorkFile='./TxtVoteReport.txt'
+
+echo '' > $WorkFile
+PrintTotalVotingWeightData $JsonData1 $WorkFile
+echo '===================================================================' >> $WorkFile
+echo '| Rank | Delegate                  | Vote % |  Vote ARK  | Voters |' >> $WorkFile
+echo '===================================================================' >> $WorkFile
+PrintJsonData $JsonData1 $WorkFile
+echo '===================================================================' >> $WorkFile
+PrintJsonData $JsonData2 $WorkFile
+echo '===================================================================' >> $WorkFile
+Date=$( date -u "+%Y-%m-%d %H:%M:%S" )
+echo -e "\n $Date UTC / TxtVoteReport.sh v2.5.1 / ark.io \n" >> $WorkFile
+echo -e "\n NOTE: This report is based on the 51 active delegates only! \n" >> $WorkFile
+
+cp -f $WorkFile $OutputFile