Merge pull request #332 from web3p/feature/add-feehistory

feature: add fee history api

.github/workflows/php.yml

@@ -25,7 +25,7 @@ jobs:
       run: |
         sudo apt-get update -y
         sudo apt-get install -y nodejs
-        sudo npm install -g ganache-cli
+        sudo npm install -g ganache
 
     - uses: actions/checkout@v2
 

.gitignore

@@ -7,3 +7,11 @@ composer.phar
 # Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
 # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
 composer.lock
+
+*.DS_Store
+*.phpunit.result.cache
+
+# nodejs
+node_modules/
+package-lock.json
+package.json

scripts/test.sh

@@ -1,15 +1,15 @@
 #!/usr/bin/env bash
 
-ganache-cli -g 0 -l 6000000 > /dev/null & 
-ganachecli_pid=$!
-echo "Start ganache-cli pid: $ganachecli_pid and sleep 3 seconds"
+ganache -g 0 -l 6000000 --wallet.seed test,test,test,test,test,test,test,test,test,test,test,test --miner.coinbase 0x4DABDacE120050c79E355A5Ba99047B955f37fFc > /dev/null & 
+ganache_pid=$!
+echo "Start ganache pid: $ganache_pid and sleep 3 seconds"
 
 sleep 3
 
 vendor/bin/phpunit --coverage-clover=coverage.xml
 ret=$?
 
-kill -9 $ganachecli_pid
+kill -9 $ganache_pid
 echo "Kill ganache-cli"
 
 exit $ret

src/Eth.php

@@ -38,7 +38,7 @@ class Eth
      * @var array
      */
     private $allowedMethods = [
-        'eth_protocolVersion', 'eth_syncing', 'eth_coinbase', 'eth_mining', 'eth_hashrate', 'eth_gasPrice', 'eth_accounts', 'eth_blockNumber', 'eth_getBalance', 'eth_getStorageAt', 'eth_getTransactionCount', 'eth_getBlockTransactionCountByHash', 'eth_getBlockTransactionCountByNumber', 'eth_getUncleCountByBlockHash', 'eth_getUncleCountByBlockNumber', 'eth_getUncleByBlockHashAndIndex', 'eth_getUncleByBlockNumberAndIndex', 'eth_getCode', 'eth_sign', 'eth_sendTransaction', 'eth_sendRawTransaction', 'eth_call', 'eth_estimateGas', 'eth_getBlockByHash', 'eth_getBlockByNumber', 'eth_getTransactionByHash', 'eth_getTransactionByBlockHashAndIndex', 'eth_getTransactionByBlockNumberAndIndex', 'eth_getTransactionReceipt', 'eth_compileSolidity', 'eth_compileLLL', 'eth_compileSerpent', 'eth_getWork', 'eth_newFilter', 'eth_newBlockFilter', 'eth_newPendingTransactionFilter', 'eth_uninstallFilter', 'eth_getFilterChanges', 'eth_getFilterLogs', 'eth_getLogs', 'eth_submitWork', 'eth_submitHashrate'
+        'eth_protocolVersion', 'eth_syncing', 'eth_coinbase', 'eth_mining', 'eth_hashrate', 'eth_gasPrice', 'eth_accounts', 'eth_blockNumber', 'eth_getBalance', 'eth_getStorageAt', 'eth_getTransactionCount', 'eth_getBlockTransactionCountByHash', 'eth_getBlockTransactionCountByNumber', 'eth_getUncleCountByBlockHash', 'eth_getUncleCountByBlockNumber', 'eth_getUncleByBlockHashAndIndex', 'eth_getUncleByBlockNumberAndIndex', 'eth_getCode', 'eth_sign', 'eth_sendTransaction', 'eth_sendRawTransaction', 'eth_call', 'eth_estimateGas', 'eth_getBlockByHash', 'eth_getBlockByNumber', 'eth_getTransactionByHash', 'eth_getTransactionByBlockHashAndIndex', 'eth_getTransactionByBlockNumberAndIndex', 'eth_getTransactionReceipt', 'eth_compileSolidity', 'eth_compileLLL', 'eth_compileSerpent', 'eth_getWork', 'eth_newFilter', 'eth_newBlockFilter', 'eth_newPendingTransactionFilter', 'eth_uninstallFilter', 'eth_getFilterChanges', 'eth_getFilterLogs', 'eth_getLogs', 'eth_submitWork', 'eth_submitHashrate', 'eth_feeHistory'
     ];
 
     /**

src/Formatters/FeeHistoryFormatter.php

@@ -0,0 +1,46 @@
+<?php
+
+/**
+ * This file is part of web3.php package.
+ * 
+ * (c) Kuan-Cheng,Lai <[email protected]>
+ * 
+ * @author Peter Lai <[email protected]>
+ * @license MIT
+ */
+
+namespace Web3\Formatters;
+
+use InvalidArgumentException;
+use Web3\Utils;
+use Web3\Formatters\IFormatter;
+use Web3\Formatters\BigNumberFormatter;
+
+class FeeHistoryFormatter implements IFormatter
+{
+    /**
+     * format
+     * 
+     * @param mixed $value
+     * @return string
+     */
+    public static function format($value)
+    {
+        if (isset($value->oldestBlock)) {
+            $value->oldestBlock = BigNumberFormatter::format($value->oldestBlock);
+        }
+        if (isset($value->baseFeePerGas)) {
+            foreach ($value->baseFeePerGas as $key => $baseFeePerGas) {
+                $value->baseFeePerGas[$key] = BigNumberFormatter::format($baseFeePerGas);
+            }
+        }
+        if (isset($value->reward)) {
+            foreach ($value->reward as $keyOut => $rewards) {
+                foreach ($rewards as $keyIn => $reward) {
+                    $value->reward[$keyOut][$keyIn] = BigNumberFormatter::format($reward);
+                }
+            }
+        }
+        return $value;
+    }
+}

src/Formatters/NumberFormatter.php

@@ -20,15 +20,11 @@ class NumberFormatter implements IFormatter
     /**
      * format
      * 
-     * @param mixed $value
-     * @return int
+     * @param int|float $value
+     * @return int|float
      */
     public static function format($value)
     {
-        $value = Utils::toString($value);
-        $bn = Utils::toBn($value);
-        $int = (int) $bn->toString();
-
-        return $int;
+        return $value;
     }
 }

src/Methods/Eth/Accounts.php

@@ -43,16 +43,4 @@ class Accounts extends EthMethod
      * @var array
      */
     protected $defaultValues = [];
-
-    /**
-     * construct
-     * 
-     * @param string $method
-     * @param array $arguments
-     * @return void
-     */
-    // public function __construct($method='', $arguments=[])
-    // {
-    //     parent::__construct($method, $arguments);
-    // }
 }

src/Methods/Eth/BlockNumber.php

@@ -46,16 +46,4 @@ class BlockNumber extends EthMethod
      * @var array
      */
     protected $defaultValues = [];
-
-    /**
-     * construct
-     * 
-     * @param string $method
-     * @param array $arguments
-     * @return void
-     */
-    // public function __construct($method='', $arguments=[])
-    // {
-    //     parent::__construct($method, $arguments);
-    // }
 }

src/Methods/Eth/Call.php

@@ -56,16 +56,4 @@ class Call extends EthMethod
     protected $defaultValues = [
         1 => 'latest'
     ];
-
-    /**
-     * construct
-     * 
-     * @param string $method
-     * @param array $arguments
-     * @return void
-     */
-    // public function __construct($method='', $arguments=[])
-    // {
-    //     parent::__construct($method, $arguments);
-    // }
 }

src/Methods/Eth/Coinbase.php

@@ -43,16 +43,4 @@ class Coinbase extends EthMethod
      * @var array
      */
     protected $defaultValues = [];
-
-    /**
-     * construct
-     * 
-     * @param string $method
-     * @param array $arguments
-     * @return void
-     */
-    // public function __construct($method='', $arguments=[])
-    // {
-    //     parent::__construct($method, $arguments);
-    // }
 }

src/Methods/Eth/EstimateGas.php

@@ -52,16 +52,4 @@ class EstimateGas extends EthMethod
      * @var array
      */
     protected $defaultValues = [];
-
-    /**
-     * construct
-     * 
-     * @param string $method
-     * @param array $arguments
-     * @return void
-     */
-    // public function __construct($method='', $arguments=[])
-    // {
-    //     parent::__construct($method, $arguments);
-    // }
 }

src/Methods/Eth/FeeHistory.php

@@ -0,0 +1,60 @@
+<?php
+
+/**
+ * This file is part of web3.php package.
+ * 
+ * (c) Kuan-Cheng,Lai <[email protected]>
+ * 
+ * @author Peter Lai <[email protected]>
+ * @license MIT
+ */
+
+namespace Web3\Methods\Eth;
+
+use InvalidArgumentException;
+use Web3\Methods\EthMethod;
+use Web3\Validators\TagValidator;
+use Web3\Validators\QuantityValidator;
+use Web3\Validators\ArrayNumberValidator;
+use Web3\Formatters\QuantityFormatter;
+use Web3\Formatters\OptionalQuantityFormatter;
+use Web3\Formatters\FeeHistoryFormatter;
+
+class FeeHistory extends EthMethod
+{
+    /**
+     * validators
+     * 
+     * @var array
+     */
+    protected $validators = [
+        QuantityValidator::class, [
+            TagValidator::class, QuantityValidator::class
+        ], ArrayNumberValidator::class
+    ];
+
+    /**
+     * inputFormatters
+     * 
+     * @var array
+     */
+    protected $inputFormatters = [
+        QuantityFormatter::class, OptionalQuantityFormatter::class
+    ];
+
+    /**
+     * outputFormatters
+     * 
+     * @var array
+     */
+    protected $outputFormatters = [
+        FeeHistoryFormatter::class
+    ];
+
+    /**
+     * defaultValues
+     * 
+     * @var array
+     */
+    protected $defaultValues = [];
+}

src/Methods/Eth/GasPrice.php

@@ -46,16 +46,4 @@ class GasPrice extends EthMethod
      * @var array
      */
     protected $defaultValues = [];
-
-    /**
-     * construct
-     * 
-     * @param string $method
-     * @param array $arguments
-     * @return void
-     */
-    // public function __construct($method='', $arguments=[])
-    // {
-    //     parent::__construct($method, $arguments);
-    // }
 }

src/Methods/Eth/GetBalance.php

@@ -59,16 +59,4 @@ class GetBalance extends EthMethod
     protected $defaultValues = [
         1 => 'latest'
     ];
-
-    /**
-     * construct
-     * 
-     * @param string $method
-     * @param array $arguments
-     * @return void
-     */
-    // public function __construct($method='', $arguments=[])
-    // {
-    //     parent::__construct($method, $arguments);
-    // }
 }

src/Methods/Eth/GetBlockByHash.php

@@ -51,16 +51,4 @@ class GetBlockByHash extends EthMethod
      * @var array
      */
     protected $defaultValues = [];
-
-    /**
-     * construct
-     * 
-     * @param string $method
-     * @param array $arguments
-     * @return void
-     */
-    // public function __construct($method='', $arguments=[])
-    // {
-    //     parent::__construct($method, $arguments);
-    // }
 }

src/Methods/Eth/GetBlockByNumber.php

@@ -56,16 +56,4 @@ class GetBlockByNumber extends EthMethod
     protected $defaultValues = [
         0 => 'latest'
     ];
-
-    /**
-     * construct
-     * 
-     * @param string $method
-     * @param array $arguments
-     * @return void
-     */
-    // public function __construct($method='', $arguments=[])
-    // {
-    //     parent::__construct($method, $arguments);
-    // }
 }

src/Methods/Eth/GetBlockTransactionCountByHash.php

@@ -52,16 +52,4 @@ class GetBlockTransactionCountByHash extends EthMethod
      * @var array
      */
     protected $defaultValues = [];
-
-    /**
-     * construct
-     * 
-     * @param string $method
-     * @param array $arguments
-     * @return void
-     */
-    // public function __construct($method='', $arguments=[])
-    // {
-    //     parent::__construct($method, $arguments);
-    // }
 }

src/Methods/Eth/GetBlockTransactionCountByNumber.php

@@ -54,16 +54,4 @@ class GetBlockTransactionCountByNumber extends EthMethod
     protected $defaultValues = [
         'latest'
     ];
-
-    /**
-     * construct
-     * 
-     * @param string $method
-     * @param array $arguments
-     * @return void
-     */
-    // public function __construct($method='', $arguments=[])
-    // {
-    //     parent::__construct($method, $arguments);
-    // }
 }

src/Methods/Eth/GetCode.php

@@ -56,16 +56,4 @@ class GetCode extends EthMethod
     protected $defaultValues = [
         1 => 'latest'
     ];
-
-    /**
-     * construct
-     * 
-     * @param string $method
-     * @param array $arguments
-     * @return void
-     */
-    // public function __construct($method='', $arguments=[])
-    // {
-    //     parent::__construct($method, $arguments);
-    // }
 }