Integrate fixed fee average into CLI. Add option for number of blocks to collect for fee average.

Author: dmp1ce

ChangeLog.md

@@ -1,5 +1,10 @@
 # Changelog for check_cgminer
 
+## 0.7.10.0
+
+- Fix block fee calculation for profitability calculation
+- Allow option to specify the number of past blocks to average when considering average block fee
+
 ## 0.7.9.0
 
 - Allow for dynamic power strategy power rate override via the command line.

package.yaml

@@ -1,5 +1,5 @@
 name:                check-cgminer
-version:             0.7.9.0
+version:             0.7.10.0
 github:              "dmp1ce/check_cgminer"
 license:             PublicDomain
 author:              "David Parrish"

src/CheckCgminer.hs

@@ -62,6 +62,7 @@ data CliOptions = CliOptions
   , electricity_rate :: Double
   , profitability_warning :: Double
   , profitability_critical :: Double
+  , block_fee_average_num :: Integer
   , block_reward :: Maybe Double
   , mining_fee_reward :: Maybe Double
   , pool_fee :: Double
@@ -105,6 +106,8 @@ defaultProfitabilityCriticalThreshold :: Double
 defaultProfitabilityCriticalThreshold = 0
 defaultPoolFee :: Double
 defaultPoolFee = 0
+defaultBlockFeeAverageNum :: Integer
+defaultBlockFeeAverageNum = 10
 
 cliOptions :: Parser CliOptions
 cliOptions = CliOptions
@@ -277,6 +280,13 @@ cliOptions = CliOptions
      <> help "Critical profitability threshold in USD/day"
      <> showDefault
       )
+  <*> option auto
+      ( long "fee_block_average_num"
+     <> metavar "NUMBER"
+     <> help "Number of past blocks to use for fee average"
+     <> value defaultBlockFeeAverageNum
+     <> showDefault
+      )
   <*> optional (option auto
       ( long "block_reward"
      <> metavar "NUMBER"
@@ -464,7 +474,7 @@ instance ToPerfData PerfDataWorkMode where
 
 -- | Try to parse stats from miner. Return error `T.Text` if for failure.
 tryCommand :: T.Text -> (ReplyApi -> Either String Stats) -> CliOptions -> IO (Either T.Text Stats)
-tryCommand c f (CliOptions h p _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _) = do
+tryCommand c f (CliOptions h p _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _) = do
   r <- catches (sendCGMinerCommand h p c)
        [ Handler (\(e :: IOException) ->
                     error $ "IOException while sending '" ++ T.unpack c ++ "' command: " ++ show e
@@ -498,7 +508,7 @@ trySummary = tryCommand "summary" getSummary
 
 execCheck :: CliOptions -> IO ()
 execCheck opts@(CliOptions _ _ tw tc hw hc hmax hirw hirc hu flw flc fhw fhc vhw vhc freqhw
-                freqhc ps mpc erd profw profc mbr mmfr pfp) = do
+                freqhc ps mpc erd profw profc bfan mbr mmfr pfp) = do
   -- Try to get "stats" command first
   eStats <- tryStats opts
   processStats eStats
@@ -525,7 +535,7 @@ execCheck opts@(CliOptions _ _ tw tc hw hc hmax hirw hirc hu flw flc fhw fhc vhw
     getProfitabilityFactors :: IO (Maybe ProfitabilityFactors)
     getProfitabilityFactors = do
       dNr <- cacheIO "difficultyAndRewardCache" nominalDay getBitcoinDifficultyAndReward
-      mr <- cacheIO "minerFeeRewardCache" nominalDay getBitcoinAverageMiningFeeReward
+      mr <- cacheIO "minerFeeRewardCache" nominalDay $ getBitcoinAverageMiningFeeReward bfan
       p <- cacheIO "priceCache" nominalDay getBitcoinPrice
       let er = EnergyRate USD KiloWattHour (toRational erd)
       return $ ProfitabilityFactors er <$> (fst <$> dNr) <*> p

src/Helper.hs

@@ -164,9 +164,34 @@ getBitcoinDifficultyAndRewardFromBitcoinChain = do
               _ -> return Nothing
   return $ (,) <$> d <*> reward
 
--- Average mining fee per block
-getBitcoinAverageMiningFeeReward :: IO (Maybe Bitcoins)
-getBitcoinAverageMiningFeeReward = do
+-- | Average mining fee per block
+getBitcoinAverageMiningFeeReward :: Integer -> IO (Maybe Bitcoins)
+getBitcoinAverageMiningFeeReward = getBitcoinAverageBlockFeesBlockchainInfo
+
+-- | Get the average fee for past blocks
+--   Can take up to about 1 second wait per block.
+getBitcoinAverageBlockFeesBlockchainInfo :: Integer -- ^ How many blocks back to average
+                           -> IO (Maybe Bitcoins)
+getBitcoinAverageBlockFeesBlockchainInfo h
+  | h <= 0 = return $ Just $ Bitcoins Bitcoin 0
+  | otherwise = do
+  l <- getLatestBitcoinBlockCached
+  t <- f h l
+  return $ Just $ Bitcoins Bitcoin $ (t / toRational h) / 100000000
+  where
+    f :: Integer -> Maybe RawBlock -> IO Rational
+    f 0 _ = return 0
+    f h' b =
+      case b of
+        Just b' -> do
+          p <- getBitcoinRawBlockCached $ _previousBlock b'
+          pf <- f (h' -1) p
+          return $  _fee b' + pf
+        Nothing -> return 0
+
+-- Archived and original Fee average from blockchain.com
+getBitcoinAverageBlockFeesBitcoinchain :: IO (Maybe Bitcoins)
+getBitcoinAverageBlockFeesBitcoinchain = do
   r <- W.get "https://api-r.bitcoinchain.com/v1/blocks/100"
   let rats = rational <$> r ^.. W.responseBody . values . key "fee" . _String
   case (/ (toRational . length) rats) <$> (sum . (fst <$>) <$> sequenceA rats) of
@@ -204,26 +229,6 @@ getBitcoinRawBlock h = do
 getBitcoinRawBlockCached :: B.ByteString -> IO (Maybe RawBlock)
 getBitcoinRawBlockCached h = cacheIO ("block_" <> cs h) (C.nominalDay * 10000) $ getBitcoinRawBlock h
 
--- | Get the average fee for past blocks
---   Can take up to about 1 second wait per block.
-getBitcoinAverageBlockFees :: Integer -- ^ How many blocks back to average
-                           -> IO (Maybe Rational)
-getBitcoinAverageBlockFees h
-  | h <= 0 = return $ Just 0
-  | otherwise = do
-  l <- getLatestBitcoinBlockCached
-  t <- f h l
-  return $ Just $ t / toRational h
-  where
-    f :: Integer -> Maybe RawBlock -> IO Rational
-    f 0 _ = return 0
-    f h' b =
-      case b of
-        Just b' -> do
-          p <- getBitcoinRawBlockCached $ _previousBlock b'
-          pf <- f (h' -1) p
-          return $  _fee b' + pf
-        Nothing -> return 0
 
 -- Caching
 newtype CacheUTCTime = CacheUTCTime C.UTCTime deriving (Eq, Show)