Separate creation and initialisation of auxpow's.

domob1812 · domob1812 · commit d8c447554507 · 2018-06-25T17:59:50.000+02:00
Instead of both creating and already setting the "minimal" auxpow in
initAuxPow, this logic is split into two parts:  The construction of the
auxpow itself, and the logic that modifies the header.

Furthermore, we now return a reference to the parent block header from
initAuxPow, so it can be more easily mined.  This allows us to get rid
of the general accessor getParentBlockHeader, and replace it by just a
function returning the parent block hash (as before) to verify a PoW.
diff --git a/src/auxpow.cpp b/src/auxpow.cpp
@@ -20,7 +20,7 @@
 #include <validation.h>
 
 #include <algorithm>
-#include <memory>
+#include <cassert>
 
 /* Moved from wallet.cpp.  CMerkleTx is necessary for auxpow, independent
    of an enabled (or disabled) wallet.  Always include the code.  */
@@ -188,11 +188,10 @@ CAuxPow::CheckMerkleBranch (uint256 hash,
   return hash;
 }
 
-void
-CAuxPow::initAuxPow (CBlockHeader& header)
+std::unique_ptr<CAuxPow>
+CAuxPow::createAuxPow (const CPureBlockHeader& header)
 {
-  /* Set auxpow flag right now, since we take the block hash below.  */
-  header.SetAuxpowVersion(true);
+  assert (header.IsAuxpow ());
 
   /* Build a minimal coinbase script input for merge-mining.  */
   const uint256 blockHash = header.GetHash ();
@@ -224,5 +223,20 @@ CAuxPow::initAuxPow (CBlockHeader& header)
   assert (auxpow->vMerkleBranch.empty ());
   auxpow->nIndex = 0;
   auxpow->parentBlock = parent;
-  header.SetAuxpow (std::move (auxpow));
+
+  return auxpow;
+}
+
+CPureBlockHeader&
+CAuxPow::initAuxPow (CBlockHeader& header)
+{
+  /* Set auxpow flag right now, since we take the block hash below when creating
+     the minimal auxpow for header.  */
+  header.SetAuxpowVersion(true);
+
+  std::unique_ptr<CAuxPow> apow = createAuxPow (header);
+  CPureBlockHeader& result = apow->parentBlock;
+  header.SetAuxpow (std::move (apow));
+
+  return result;
 }
diff --git a/src/auxpow.h b/src/auxpow.h
@@ -13,6 +13,7 @@
 #include <serialize.h>
 #include <uint256.h>
 
+#include <memory>
 #include <vector>
 
 class CBlock;
@@ -162,18 +163,13 @@ class CAuxPow : public CMerkleTx
   bool check (const uint256& hashAuxBlock, int nChainId,
               const Consensus::Params& params) const;
 
-  /* Accessors for the parent block.  */
-
-  inline CPureBlockHeader&
-  getParentBlock ()
-  {
-    return parentBlock;
-  }
-
-  inline const CPureBlockHeader&
-  getParentBlock () const
+  /**
+   * Returns the parent block hash.  This is used to validate the PoW.
+   */
+  inline uint256
+  getParentBlockHash () const
   {
-    return parentBlock;
+    return parentBlock.GetHash ();
   }
 
   /**
@@ -195,13 +191,19 @@ class CAuxPow : public CMerkleTx
                                     int nIndex);
 
   /**
-   * Initialise the auxpow of the given block header.  This constructs
-   * a minimal CAuxPow object with a minimal parent block and sets
-   * it on the block header.  The auxpow is not necessarily valid, but
-   * can be "mined" to make it valid.
-   * @param header The header to set the auxpow on.
+   * Constructs a minimal CAuxPow object for the given block header and
+   * returns it.  The caller should make sure to set the auxpow flag on the
+   * header already, since the block hash to which the auxpow commits depends
+   * on that!
+   */
+  static std::unique_ptr<CAuxPow> createAuxPow (const CPureBlockHeader& header);
+
+  /**
+   * Initialises the auxpow of the given block header.  This builds a minimal
+   * auxpow object like createAuxPow and sets it on the block header.  Returns
+   * a reference to the parent header so it can be mined as a follow-up.
    */
-  static void initAuxPow (CBlockHeader& header);
+  static CPureBlockHeader& initAuxPow (CBlockHeader& header);
 
 };
 
diff --git a/src/rpc/mining.cpp b/src/rpc/mining.cpp
@@ -128,8 +128,7 @@ UniValue generateBlocks(std::shared_ptr<CReserveScript> coinbaseScript, int nGen
             LOCK(cs_main);
             IncrementExtraNonce(pblock, chainActive.Tip(), nExtraNonce);
         }
-        CAuxPow::initAuxPow(*pblock);
-        CPureBlockHeader& miningHeader = pblock->auxpow->getParentBlock();
+        auto& miningHeader = CAuxPow::initAuxPow(*pblock);
         while (nMaxTries > 0 && miningHeader.nNonce < nInnerLoopCount && !CheckProofOfWork(miningHeader.GetHash(), pblock->nBits, Params().GetConsensus())) {
             ++miningHeader.nNonce;
             --nMaxTries;
diff --git a/src/test/validation_block_tests.cpp b/src/test/validation_block_tests.cpp
@@ -72,9 +72,7 @@ std::shared_ptr<CBlock> FinalizeBlock(std::shared_ptr<CBlock> pblock)
 {
     pblock->hashMerkleRoot = BlockMerkleRoot(*pblock);
 
-    CAuxPow::initAuxPow(*pblock);
-    CPureBlockHeader& miningHeader = pblock->auxpow->getParentBlock();
-
+    auto& miningHeader = CAuxPow::initAuxPow(*pblock);
     while (!CheckProofOfWork(miningHeader.GetHash(), pblock->nBits, Params().GetConsensus())) {
         ++(miningHeader.nNonce);
     }
diff --git a/src/validation.cpp b/src/validation.cpp
@@ -1103,7 +1103,7 @@ bool CheckProofOfWork(const CBlockHeader& block, const Consensus::Params& params
 
     if (!block.auxpow->check(block.GetHash(), block.GetChainId(), params))
         return error("%s : AUX POW is not valid", __func__);
-    if (!CheckProofOfWork(block.auxpow->getParentBlock().GetHash(), block.nBits, params))
+    if (!CheckProofOfWork(block.auxpow->getParentBlockHash(), block.nBits, params))
         return error("%s : AUX proof of work failed", __func__);
 
     return true;

Original file line number	Diff line number	Diff line change
`@@ -72,9 +72,7 @@ std::shared_ptr<CBlock> FinalizeBlock(std::shared_ptr<CBlock> pblock)`
`72`	`72`	`{`
`73`	`73`	`pblock->hashMerkleRoot = BlockMerkleRoot(*pblock);`
`74`	`74`
`75`		`- CAuxPow::initAuxPow(*pblock);`
`76`		`- CPureBlockHeader& miningHeader = pblock->auxpow->getParentBlock();`
`77`		`-`
	`75`	`+ auto& miningHeader = CAuxPow::initAuxPow(*pblock);`
`78`	`76`	`while (!CheckProofOfWork(miningHeader.GetHash(), pblock->nBits, Params().GetConsensus())) {`
`79`	`77`	`++(miningHeader.nNonce);`
`80`	`78`	`}`