Michael Sutton 1c9bb54cc2
Crucial fix for the UTXO difference mechanism (#2114)
* Illustrate the bug through prints

* Change consensus API to a single ResolveVirtual call

* nil changeset is not expected when err=nil

* Fixes a deep bug in the resolve virtual process

* Be more defensive at resolving virtual when adding a block

* When finally resolved, set virtual parents properly

* Return nil changeset when nothing happened

* Make sure the block at the split point is reversed to new chain as well

* bump to version 0.12.4

* Avoid locking consensus twice in the common case of adding block with updateVirtual=true

* check err

* Parents must be picked first before set as virtual parents

* Keep the flag for tracking virtual state, since tip sorting perf is high with many tips

* Improve and clarify resolve virtual tests

* Addressing minor review comments

* Fixed a bug in the reported virtual changeset, and modified the test to verify it

* Addressing review comments
2022-07-15 12:35:20 +03:00

133 lines
4.6 KiB
Go

package consensusstatemanager
import (
"github.com/kaspanet/kaspad/domain/consensus/model"
"github.com/kaspanet/kaspad/domain/consensus/model/externalapi"
"github.com/kaspanet/kaspad/infrastructure/logger"
)
func (csm *consensusStateManager) updateVirtual(stagingArea *model.StagingArea, newBlockHash *externalapi.DomainHash,
tips []*externalapi.DomainHash) (*externalapi.SelectedChainPath, externalapi.UTXODiff, error) {
onEnd := logger.LogAndMeasureExecutionTime(log, "updateVirtual")
defer onEnd()
log.Debugf("updateVirtual start for block %s", newBlockHash)
log.Debugf("Saving a reference to the GHOSTDAG data of the old virtual")
var oldVirtualSelectedParent *externalapi.DomainHash
if !newBlockHash.Equal(csm.genesisHash) {
oldVirtualGHOSTDAGData, err := csm.ghostdagDataStore.Get(csm.databaseContext, stagingArea, model.VirtualBlockHash, false)
if err != nil {
return nil, nil, err
}
oldVirtualSelectedParent = oldVirtualGHOSTDAGData.SelectedParent()
}
log.Debugf("Picking virtual parents from tips len: %d", len(tips))
virtualParents, err := csm.pickVirtualParents(stagingArea, tips)
if err != nil {
return nil, nil, err
}
log.Debugf("Picked virtual parents: %s", virtualParents)
virtualUTXODiff, err := csm.updateVirtualWithParents(stagingArea, virtualParents)
if err != nil {
return nil, nil, err
}
log.Debugf("Calculating selected parent chain changes")
var selectedParentChainChanges *externalapi.SelectedChainPath
if !newBlockHash.Equal(csm.genesisHash) {
newVirtualGHOSTDAGData, err := csm.ghostdagDataStore.Get(csm.databaseContext, stagingArea, model.VirtualBlockHash, false)
if err != nil {
return nil, nil, err
}
newVirtualSelectedParent := newVirtualGHOSTDAGData.SelectedParent()
selectedParentChainChanges, err = csm.dagTraversalManager.
CalculateChainPath(stagingArea, oldVirtualSelectedParent, newVirtualSelectedParent)
if err != nil {
return nil, nil, err
}
log.Debugf("Selected parent chain changes: %d blocks were removed and %d blocks were added",
len(selectedParentChainChanges.Removed), len(selectedParentChainChanges.Added))
}
return selectedParentChainChanges, virtualUTXODiff, nil
}
func (csm *consensusStateManager) updateVirtualWithParents(
stagingArea *model.StagingArea, virtualParents []*externalapi.DomainHash) (externalapi.UTXODiff, error) {
err := csm.dagTopologyManager.SetParents(stagingArea, model.VirtualBlockHash, virtualParents)
if err != nil {
return nil, err
}
log.Debugf("Set new parents for the virtual block hash")
err = csm.ghostdagManager.GHOSTDAG(stagingArea, model.VirtualBlockHash)
if err != nil {
return nil, err
}
// This is needed for `csm.CalculatePastUTXOAndAcceptanceData`
_, err = csm.difficultyManager.StageDAADataAndReturnRequiredDifficulty(stagingArea, model.VirtualBlockHash, false)
if err != nil {
return nil, err
}
log.Debugf("Calculating past UTXO, acceptance data, and multiset for the new virtual block")
virtualUTXODiff, virtualAcceptanceData, virtualMultiset, err :=
csm.CalculatePastUTXOAndAcceptanceData(stagingArea, model.VirtualBlockHash)
if err != nil {
return nil, err
}
log.Debugf("Calculated the past UTXO of the new virtual. "+
"Diff toAdd length: %d, toRemove length: %d",
virtualUTXODiff.ToAdd().Len(), virtualUTXODiff.ToRemove().Len())
log.Debugf("Staging new acceptance data for the virtual block")
csm.acceptanceDataStore.Stage(stagingArea, model.VirtualBlockHash, virtualAcceptanceData)
log.Debugf("Staging new multiset for the virtual block")
csm.multisetStore.Stage(stagingArea, model.VirtualBlockHash, virtualMultiset)
log.Debugf("Staging new UTXO diff for the virtual block")
csm.consensusStateStore.StageVirtualUTXODiff(stagingArea, virtualUTXODiff)
log.Debugf("Updating the selected tip's utxo-diff")
err = csm.updateSelectedTipUTXODiff(stagingArea, virtualUTXODiff)
if err != nil {
return nil, err
}
return virtualUTXODiff, nil
}
func (csm *consensusStateManager) updateSelectedTipUTXODiff(
stagingArea *model.StagingArea, virtualUTXODiff externalapi.UTXODiff) error {
onEnd := logger.LogAndMeasureExecutionTime(log, "updateSelectedTipUTXODiff")
defer onEnd()
selectedTip, err := csm.virtualSelectedParent(stagingArea)
if err != nil {
return err
}
log.Debugf("Calculating new UTXO diff for virtual diff parent %s", selectedTip)
selectedTipUTXODiff, err := csm.utxoDiffStore.UTXODiff(csm.databaseContext, stagingArea, selectedTip)
if err != nil {
return err
}
newDiff, err := virtualUTXODiff.DiffFrom(selectedTipUTXODiff)
if err != nil {
return err
}
log.Debugf("Staging new UTXO diff for virtual diff parent %s", selectedTip)
csm.stageDiff(stagingArea, selectedTip, newDiff, nil)
return nil
}