Rename HasCoincidentDifficulty() -> IsDomCoincident() for clarity

saiaman · Jan 25, 2023 · 76d0238 · 76d0238
1 parent 1c8023c
commit 76d0238
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 9 deletions.
diff --git a/consensus/blake3pow/consensus.go b/consensus/blake3pow/consensus.go
@@ -343,7 +343,7 @@ func (blake3pow *Blake3pow) CalcDifficulty(chain consensus.ChainHeaderReader, pa
 	return x
 }
 
-func (blake3pow *Blake3pow) HasCoincidentDifficulty(header *types.Header) bool {
+func (blake3pow *Blake3pow) IsDomCoincident(header *types.Header) bool {
 	nodeCtx := common.NodeLocation.Context()
 
 	// Since the Prime chain is the highest order, it cannot have coincident blocks

diff --git a/consensus/consensus.go b/consensus/consensus.go
@@ -111,13 +111,13 @@ type Engine interface {
 	// that a new block should have.
 	CalcDifficulty(chain ChainHeaderReader, parent *types.Header) *big.Int
 
-	// IsCoincident returns true if this block satisfies the difficulty order
+	// IsDomCoincident returns true if this block satisfies the difficulty order
 	// of a dominant chain. If this node does not have a dominant chain (i.e.
 	// if this is a prime node), then the function will always return false.
 	//
 	// Importantly, this check does NOT mean the block is canonical in the
 	// dominant chain, or even that the claimed dominant difficulty is valid.
-	HasCoincidentDifficulty(header *types.Header) bool
+	IsDomCoincident(header *types.Header) bool
 
 	// APIs returns the RPC APIs this consensus engine provides.
 	APIs(chain ChainHeaderReader) []rpc.API

diff --git a/core/core.go b/core/core.go
@@ -39,7 +39,8 @@ func NewCore(db ethdb.Database, config *Config, isLocalBlock func(block *types.H
 func (c *Core) InsertChain(blocks types.Blocks) (int, error) {
 	domWait := false
 	for i, block := range blocks {
-		isCoincident := c.sl.engine.HasCoincidentDifficulty(block.Header())
+		isCoincident := c.sl.engine.IsDomCoincident(block.Header())
+
 		// Write the block body to the db.
 		rawdb.WritePendingBlockBody(c.sl.sliceDb, block.Header().Root(), block.Body())
 

diff --git a/core/slice.go b/core/slice.go
@@ -245,7 +245,7 @@ func (sl *Slice) pcrc(batch ethdb.Batch, header *types.Header, domTerminus commo
 	nodeCtx := common.NodeLocation.Context()
 	location := header.Location()
 
-	isCoincident := sl.engine.HasCoincidentDifficulty(header)
+	isDomCoincident := sl.engine.IsDomCoincident(header)
 
 	log.Debug("PCRC:", "Parent Hash:", header.ParentHash(), "Number", header.Number, "Location:", header.Location())
 	termini := sl.hc.GetTerminiByHash(header.ParentHash())
@@ -270,14 +270,14 @@ func (sl *Slice) pcrc(batch ethdb.Batch, header *types.Header, domTerminus commo
 	}
 
 	// Set the terminus
-	if nodeCtx == common.PRIME_CTX || isCoincident {
+	if nodeCtx == common.PRIME_CTX || isDomCoincident {
 		newTermini[terminiIndex] = header.Hash()
 	} else {
 		newTermini[terminiIndex] = termini[terminiIndex]
 	}
 
 	// Check for a graph cyclic reference
-	if isCoincident {
+	if isDomCoincident {
 		if termini[terminiIndex] != domTerminus {
 			log.Warn("Cyclic Block:", "block number", header.NumberArray(), "hash", header.Hash(), "terminus", domTerminus, "termini", termini)
 			return common.Hash{}, []common.Hash{}, errors.New("termini do not match, block rejected due to cyclic reference")
@@ -307,8 +307,8 @@ func (sl *Slice) hlcr(externTd *big.Int) bool {
 // CalcTd calculates the TD of the given header using PCRC.
 func (sl *Slice) calcTd(header *types.Header) (*big.Int, error) {
 	// Stop from
-	isCoincident := sl.engine.HasCoincidentDifficulty(header)
-	if isCoincident {
+	isDomCoincident := sl.engine.IsDomCoincident(header)
+	if isDomCoincident {
 		return nil, errors.New("td on a dom block cannot be calculated by a sub")
 	}
 	priorTd := sl.hc.GetTd(header.ParentHash(), header.NumberU64()-1)