[ETCM-44] Treasury block reward distribution

src/ets/scala/io/iohk/ethereum/ets/blockchain/BlockchainTestConfig.scala

@@ -43,7 +43,8 @@ object BlockchainTestConfig {
     atlantisBlockNumber = Long.MaxValue,
     aghartaBlockNumber = Long.MaxValue,
     phoenixBlockNumber = Long.MaxValue,
-    ecip1098BlockNumber = Long.MaxValue
+    ecip1098BlockNumber = Long.MaxValue,
+    treasuryAddress = Address(0)
   )
 
   val FrontierConfig = BaseBlockchainConfig.copy(

src/it/scala/io/iohk/ethereum/txExecTest/ECIP1017Test.scala

@@ -2,7 +2,7 @@ package io.iohk.ethereum.txExecTest
 
 import java.util.concurrent.Executors
 
-import io.iohk.ethereum.domain.{BlockchainImpl, Receipt, UInt256}
+import io.iohk.ethereum.domain.{Address, BlockchainImpl, Receipt, UInt256}
 import io.iohk.ethereum.ledger._
 import io.iohk.ethereum.txExecTest.util.FixtureProvider
 import io.iohk.ethereum.utils.{BlockchainConfig, MonetaryPolicyConfig}
@@ -45,7 +45,8 @@ class ECIP1017Test extends AnyFlatSpec with Matchers {
       aghartaBlockNumber = Long.MaxValue,
       phoenixBlockNumber = Long.MaxValue,
       petersburgBlockNumber = Long.MaxValue,
-      ecip1098BlockNumber = Long.MaxValue
+      ecip1098BlockNumber = Long.MaxValue,
+      treasuryAddress = Address(0)
     )
     val ec = ExecutionContext.fromExecutor(Executors.newFixedThreadPool(4))
 

src/it/scala/io/iohk/ethereum/txExecTest/ForksTest.scala

@@ -2,7 +2,7 @@ package io.iohk.ethereum.txExecTest
 
 import java.util.concurrent.Executors
 
-import io.iohk.ethereum.domain.{BlockchainImpl, Receipt, UInt256}
+import io.iohk.ethereum.domain.{Address, BlockchainImpl, Receipt, UInt256}
 import io.iohk.ethereum.ledger.{BlockExecution, BlockQueue, BlockValidation}
 import io.iohk.ethereum.txExecTest.util.FixtureProvider
 import io.iohk.ethereum.utils.{BlockchainConfig, MonetaryPolicyConfig}
@@ -44,7 +44,8 @@ class ForksTest extends AnyFlatSpec with Matchers {
       aghartaBlockNumber = Long.MaxValue,
       phoenixBlockNumber = Long.MaxValue,
       petersburgBlockNumber = Long.MaxValue,
-      ecip1098BlockNumber = Long.MaxValue
+      ecip1098BlockNumber = Long.MaxValue,
+      treasuryAddress = Address(0)
     )
 
     val noErrors = a[Right[_, Seq[Receipt]]]

src/main/resources/chains/etc-chain.conf

@@ -80,6 +80,7 @@
 
   # Proto-treasury fork block number (ETC only, but deactivated for now)
   # https://ecips.ethereumclassic.org/ECIPs/ecip-1098
+  treasury-address = "0011223344556677889900112233445566778899"
   ecip1098-block-number = "1000000000000000000"
 
   # DAO fork configuration (Ethereum HF/Classic split)

src/main/resources/chains/eth-chain.conf

@@ -80,6 +80,7 @@
 
   # Proto-treasury fork block number (ETC only, but deactivated for now)
   # https://ecips.ethereumclassic.org/ECIPs/ecip-1098
+  treasury-address = "0011223344556677889900112233445566778899"
   ecip1098-block-number = "1000000000000000000"
 
   # DAO fork configuration (Ethereum HF/Classic split)

src/main/resources/chains/mordor-chain.conf

@@ -80,6 +80,7 @@
 
   # Proto-treasury fork block number (ETC only, but deactivated for now)
   # https://ecips.ethereumclassic.org/ECIPs/ecip-1098
+  treasury-address = "0011223344556677889900112233445566778899"
   ecip1098-block-number = "1000000000000000000"
 
   # DAO fork configuration (Ethereum HF/Classic split)

src/main/resources/chains/ropsten-chain.conf

@@ -83,6 +83,7 @@
 
   # Proto-treasury fork block number (ETC only, but deactivated for now)
   # https://ecips.ethereumclassic.org/ECIPs/ecip-1098
+  treasury-address = "0011223344556677889900112233445566778899"
   ecip1098-block-number = "1000000000000000000"
 
   # DAO fork configuration (Ethereum HF/Classic split)

src/main/resources/chains/test-chain.conf

@@ -80,6 +80,7 @@
 
   # Proto-treasury fork block number (ETC only, but deactivated for now)
   # https://ecips.ethereumclassic.org/ECIPs/ecip-1098
+  treasury-address = "0011223344556677889900112233445566778899"
   ecip1098-block-number = "1000000000000000000"
 
   # DAO fork configuration (Ethereum HF/Classic split)

src/main/resources/chains/testnet-internal-chain.conf

@@ -80,6 +80,7 @@
 
     # Proto-treasury fork block number (ETC only, but deactivated for now)
     # https://ecips.ethereumclassic.org/ECIPs/ecip-1098
+    treasury-address = "0011223344556677889900112233445566778899"
     ecip1098-block-number = "1000000000000000000"
 
     # DAO fork configuration (Ethereum HF/Classic split)

src/main/scala/io/iohk/ethereum/ledger/BlockPreparator.scala

@@ -6,6 +6,7 @@ import io.iohk.ethereum.domain.UInt256._
 import io.iohk.ethereum.domain._
 import io.iohk.ethereum.ledger.BlockExecutionError.{StateBeforeFailure, TxsExecutionError}
 import io.iohk.ethereum.ledger.Ledger._
+import io.iohk.ethereum.ledger.BlockPreparator._
 import io.iohk.ethereum.utils.{BlockchainConfig, Logger}
 import io.iohk.ethereum.vm.{PC => _, _}
 
@@ -38,33 +39,66 @@ class BlockPreparator(
     )
 
   /**
-   * This function updates state in order to pay rewards based on YP section 11.3
+   * This function updates the state in order to pay rewards based on YP section 11.3 and with the required
+   * modifications due to ECIP1097:
+   *  1. Reward for block is distributed as:
+   *      a. If treasury is disabled or it's has been selfdestructed:
+   *            Pay 100% of it to the miner
+   *      b. If a. isn't true and the miner opted out:
+   *            Pay 80% of it to the miner
+   *            Never generate the 20% else
+   *      c. If a. isn't true and the miner opted in:
+   *            Pay 80% of it to the miner
+   *            Pay 20% of it to the treasury contract
+   *  2. Miner is payed a reward for the inclusion of ommers
+   *  3. Ommers's miners are payed a reward for their inclusion in this block
    *
-   * @param block
-   * @param worldStateProxy
-   * @return
+   * @param block the block being processed
+   * @param worldStateProxy the initial state
+   * @return the state after paying the apropiate reward to who corresponds
    */
   private[ledger] def payBlockReward(block: Block, worldStateProxy: InMemoryWorldStateProxy): InMemoryWorldStateProxy = {
-    def getAccountToPay(address: Address, ws: InMemoryWorldStateProxy): Account =
-      ws.getAccount(address).getOrElse(Account.empty(blockchainConfig.accountStartNonce))
-
     val blockNumber = block.header.number
 
+    val minerRewardForBlock = blockRewardCalculator.calculateMiningRewardForBlock(blockNumber)
+    val minerRewardForOmmers = blockRewardCalculator.calculateMiningRewardForOmmers(blockNumber, block.body.uncleNodesList.size)
+
     val minerAddress = Address(block.header.beneficiary)
-    val minerAccount = getAccountToPay(minerAddress, worldStateProxy)
-    val minerReward = blockRewardCalculator.calcBlockMinerReward(blockNumber, block.body.uncleNodesList.size)
+    val treasuryAddress = blockchainConfig.treasuryAddress
+    val existsTreasuryContract = worldStateProxy.getAccount(treasuryAddress).isDefined
 
-    val afterMinerReward = worldStateProxy.saveAccount(minerAddress, minerAccount.increaseBalance(UInt256(minerReward)))
-    log.debug(s"Paying block $blockNumber reward of $minerReward to miner with account address $minerAddress")
+    val worldAfterPayingBlockReward =
+      if (block.header.treasuryOptOut.isEmpty || !existsTreasuryContract) {
+        val minerReward = minerRewardForOmmers + minerRewardForBlock
+        val worldAfterMinerReward = increaseAccountBalance(minerAddress, UInt256(minerReward))(worldStateProxy)
+        log.debug(s"Paying block $blockNumber reward of $minerReward to miner with address $minerAddress")
 
-    block.body.uncleNodesList.foldLeft(afterMinerReward) { (ws, ommer) =>
-      val ommerAddress = Address(ommer.beneficiary)
-      val account = getAccountToPay(ommerAddress, ws)
+        worldAfterMinerReward
+      } else if (block.header.treasuryOptOut.get) {
+        val minerReward = minerRewardForOmmers + minerRewardForBlock * MinerRewardPercentageAfterECIP1098 / 100
+        val worldAfterMinerReward = increaseAccountBalance(minerAddress, UInt256(minerReward))(worldStateProxy)
+        log.debug(s"Paying block $blockNumber reward of $minerReward to miner with address $minerAddress, miner opted-out of treasury")
+
+        worldAfterMinerReward
+      } else {
+        val minerReward = minerRewardForOmmers + minerRewardForBlock * MinerRewardPercentageAfterECIP1098 / 100
+        val worldAfterMinerReward = increaseAccountBalance(minerAddress, UInt256(minerReward))(worldStateProxy)
+
+        val treasuryReward = minerRewardForBlock * TreasuryRewardPercentageAfterECIP1098 / 100
+        val worldAfterTreasuryReward = increaseAccountBalance(treasuryAddress, UInt256(treasuryReward))(worldAfterMinerReward)
+
+        log.debug(s"Paying block $blockNumber reward of $minerReward to miner with address $minerAddress" +
+          s"paying treasury reward of $treasuryReward to treasury with address $treasuryAddress")
 
-      val ommerReward = blockRewardCalculator.calcOmmerMinerReward(blockNumber, ommer.number)
+        worldAfterTreasuryReward
+      }
+
+    block.body.uncleNodesList.foldLeft(worldAfterPayingBlockReward) { (ws, ommer) =>
+      val ommerAddress = Address(ommer.beneficiary)
+      val ommerReward = blockRewardCalculator.calculateOmmerRewardForInclusion(blockNumber, ommer.number)
 
       log.debug(s"Paying block $blockNumber reward of $ommerReward to ommer with account address $ommerAddress")
-      ws.saveAccount(ommerAddress, account.increaseBalance(UInt256(ommerReward)))
+      increaseAccountBalance(ommerAddress, UInt256(ommerReward))(ws)
     }
   }
 
@@ -120,13 +154,16 @@ class BlockPreparator(
     }
   }
 
+  private[ledger] def increaseAccountBalance(address: Address, value: UInt256)(world: InMemoryWorldStateProxy): InMemoryWorldStateProxy = {
+    val account = world.getAccount(address).getOrElse(Account.empty(blockchainConfig.accountStartNonce)).increaseBalance(value)
+    world.saveAccount(address, account)
+  }
+
   private[ledger] def pay(address: Address, value: UInt256, withTouch: Boolean)(world: InMemoryWorldStateProxy): InMemoryWorldStateProxy = {
     if (world.isZeroValueTransferToNonExistentAccount(address, value)) {
       world
     } else {
-      val account = world.getAccount(address).getOrElse(Account.empty(blockchainConfig.accountStartNonce)).increaseBalance(value)
-      val savedWorld = world.saveAccount(address, account)
-
+      val savedWorld = increaseAccountBalance(address, value)(world)
       if (withTouch) savedWorld.touchAccounts(address) else savedWorld
     }
   }
@@ -320,3 +357,8 @@ class BlockPreparator(
     }
   }
 }
+
+object BlockPreparator {
+  val TreasuryRewardPercentageAfterECIP1098 = 20
+  val MinerRewardPercentageAfterECIP1098 = 100 - TreasuryRewardPercentageAfterECIP1098
+}

src/main/scala/io/iohk/ethereum/ledger/BlockRewardCalculator.scala

@@ -44,33 +44,44 @@ class BlockRewardCalculator(config: MonetaryPolicyConfig, byzantiumBlockNumber:
   val firstEraOmmerMiningRewardDenom: BigInt = 8
 
 
-  def calcBlockMinerReward(blockNumber: BigInt, ommersCount: Int): BigInt = {
-    val baseReward = calcMinerBaseReward(blockNumber)
-    val ommersReward = calcMinerRewardPerOmmer(blockNumber) * ommersCount
-    baseReward + ommersReward
+  /**
+    * Calculates the miner reward for the block, that is, without considering the ommers included
+    *
+    * @param blockNumber of the mined block
+    * @return miner reward for the block
+    */
+  def calculateMiningRewardForBlock(blockNumber: BigInt): BigInt = {
+    val era = eraNumber(blockNumber)
+    val eraMultiplier = rewardReductionRateNumer.pow(era)
+    val eraDivisor = rewardReductionRateDenom.pow(era)
+    newBlockReward(blockNumber) * eraMultiplier / eraDivisor
   }
 
-  def calcOmmerMinerReward(blockNumber: BigInt, ommerNumber: BigInt): BigInt = {
+  /**
+    * Calculates the miner reward for the ommers included on the block
+    *
+    * @param blockNumber of the mined block
+    * @param ommersCount the number of ommers on the block
+    * @return miner reward for the block ommers
+    */
+  def calculateMiningRewardForOmmers(blockNumber: BigInt, ommersCount: Int): BigInt =
+    calculateMiningRewardPerOmmer(blockNumber) * ommersCount
+
+  /**
+    * Calculates the ommers reward for the ommers included on the block
+    *
+    * @param blockNumber of the mined block
+    * @param ommerNumber the block number of the ommer
+    * @return ommer reward
+    */
+  def calculateOmmerRewardForInclusion(blockNumber: BigInt, ommerNumber: BigInt): BigInt = {
     val era = eraNumber(blockNumber)
 
     if (era == 0) {
       val number = firstEraOmmerMiningRewardMaxNumer - (blockNumber - ommerNumber - 1)
       (newBlockReward(blockNumber) * number) / firstEraOmmerMiningRewardDenom
     } else
-      calcMinerBaseReward(blockNumber) * ommerMiningRewardNumer / ommerMiningRewardDenom
-  }
-
-  /**
-    * Calculates the miner base reward (without considering the ommers included)
-    *
-    * @param blockNumber mined block
-    * @return miner base reward
-    */
-  private def calcMinerBaseReward(blockNumber: BigInt): BigInt = {
-    val era = eraNumber(blockNumber)
-    val eraMultiplier = rewardReductionRateNumer.pow(era)
-    val eraDivisor = rewardReductionRateDenom.pow(era)
-    newBlockReward(blockNumber) * eraMultiplier / eraDivisor
+      calculateMiningRewardForBlock(blockNumber) * ommerMiningRewardNumer / ommerMiningRewardDenom
   }
 
   /**
@@ -79,8 +90,8 @@ class BlockRewardCalculator(config: MonetaryPolicyConfig, byzantiumBlockNumber:
     * @param blockNumber mined block
     * @return reward given to the miner for each ommer included
     */
-  private def calcMinerRewardPerOmmer(blockNumber: BigInt): BigInt = {
-    calcMinerBaseReward(blockNumber) * ommerInclusionRewardNumer / ommerInclusionRewardDenom
+  private def calculateMiningRewardPerOmmer(blockNumber: BigInt): BigInt = {
+    calculateMiningRewardForBlock(blockNumber) * ommerInclusionRewardNumer / ommerInclusionRewardDenom
   }
 
   /** era number counting from 0 */

src/main/scala/io/iohk/ethereum/utils/BlockchainConfig.scala

@@ -1,7 +1,7 @@
 package io.iohk.ethereum.utils
 
 import akka.util.ByteString
-import io.iohk.ethereum.domain.UInt256
+import io.iohk.ethereum.domain.{Address, UInt256}
 import io.iohk.ethereum.utils.NumericUtils._
 
 import scala.collection.JavaConverters._
@@ -25,6 +25,7 @@ case class BlockchainConfig(
   aghartaBlockNumber: BigInt,
   phoenixBlockNumber: BigInt,
   petersburgBlockNumber: BigInt,
+  treasuryAddress: Address,
   ecip1098BlockNumber: BigInt,
 
   maxCodeSize: Option[BigInt],
@@ -72,6 +73,7 @@ object BlockchainConfig {
     val aghartaBlockNumber: BigInt = BigInt(blockchainConfig.getString("agharta-block-number"))
     val phoenixBlockNumber: BigInt = BigInt(blockchainConfig.getString("phoenix-block-number"))
     val petersburgBlockNumber: BigInt = BigInt(blockchainConfig.getString("petersburg-block-number"))
+    val treasuryAddress = Address(blockchainConfig.getString("treasury-address"))
     val ecip1098BlockNumber: BigInt = BigInt(blockchainConfig.getString("ecip1098-block-number"))
 
     val maxCodeSize: Option[BigInt] = Try(BigInt(blockchainConfig.getString("max-code-size"))).toOption
@@ -117,6 +119,7 @@ object BlockchainConfig {
       aghartaBlockNumber = aghartaBlockNumber,
       phoenixBlockNumber = phoenixBlockNumber,
       petersburgBlockNumber = petersburgBlockNumber,
+      treasuryAddress = treasuryAddress,
       ecip1098BlockNumber = ecip1098BlockNumber,
 
       maxCodeSize = maxCodeSize,

src/test/scala/io/iohk/ethereum/consensus/BlockGeneratorSpec.scala

@@ -221,7 +221,8 @@ class BlockGeneratorSpec extends AnyFlatSpec with Matchers with ScalaCheckProper
       aghartaBlockNumber = Long.MaxValue,
       phoenixBlockNumber = Long.MaxValue,
       petersburgBlockNumber = Long.MaxValue,
-      ecip1098BlockNumber = Long.MaxValue
+      ecip1098BlockNumber = Long.MaxValue,
+      treasuryAddress = Address(0)
     )
 
     override lazy val blockExecution =
@@ -490,7 +491,8 @@ class BlockGeneratorSpec extends AnyFlatSpec with Matchers with ScalaCheckProper
       aghartaBlockNumber = Long.MaxValue,
       phoenixBlockNumber = Long.MaxValue,
       petersburgBlockNumber = Long.MaxValue,
-      ecip1098BlockNumber = Long.MaxValue
+      ecip1098BlockNumber = Long.MaxValue,
+      treasuryAddress = Address(0)
     )
     override lazy val blockchainConfig = baseBlockchainConfig
 

src/test/scala/io/iohk/ethereum/consensus/validators/BlockHeaderValidatorSpec.scala

@@ -431,7 +431,8 @@ class BlockHeaderValidatorSpec
       aghartaBlockNumber = Long.MaxValue,
       phoenixBlockNumber = Long.MaxValue,
       petersburgBlockNumber = Long.MaxValue,
-      ecip1098BlockNumber = Long.MaxValue
+      ecip1098BlockNumber = Long.MaxValue,
+      treasuryAddress = Address(0)
     )
   }
 

src/test/scala/io/iohk/ethereum/jsonrpc/EthServiceSpec.scala

@@ -976,38 +976,6 @@ class EthServiceSpec
     override lazy val ledger = mock[Ledger]
     override lazy val stxLedger = mock[StxLedger]
 
-    override lazy val blockchainConfig = BlockchainConfig(
-      ethCompatibleStorage = true,
-      //unused
-      eip155BlockNumber = 0,
-      chainId = 0x03.toByte,
-      networkId = 1,
-      maxCodeSize = None,
-      eip161BlockNumber = 0,
-      frontierBlockNumber = 0,
-      homesteadBlockNumber = 0,
-      eip150BlockNumber = 0,
-      eip160BlockNumber = 0,
-      eip106BlockNumber = 0,
-      byzantiumBlockNumber = 0,
-      constantinopleBlockNumber = 0,
-      istanbulBlockNumber = 0,
-      difficultyBombPauseBlockNumber = 0,
-      difficultyBombContinueBlockNumber = 0,
-      difficultyBombRemovalBlockNumber = 0,
-      customGenesisFileOpt = None,
-      accountStartNonce = UInt256.Zero,
-      monetaryPolicyConfig = MonetaryPolicyConfig(0, 0, 0, 0),
-      daoForkConfig = None,
-      bootstrapNodes = Set(),
-      gasTieBreaker = false,
-      atlantisBlockNumber = 0,
-      aghartaBlockNumber = 0,
-      phoenixBlockNumber = 0,
-      petersburgBlockNumber = 0,
-      ecip1098BlockNumber = 0
-    )
-
     override lazy val consensus: TestConsensus = buildTestConsensus().withBlockGenerator(blockGenerator)
 
     override implicit lazy val system = ActorSystem("EthServiceSpec_System")