TrueCloudLab/neoneo-go
7
0
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity

native: rename NEO's cached validators list to newEpochNextValidators

Browse source 
Adjust all comments, make the field name match its meaning.

Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>
This commit is contained in:
Anna Shaleva 2023-09-01 15:33:01 +03:00
parent 312534af7c
commit 794658b54c
1 changed files with 19 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
pkg/core/native/native_neo.go
View file

@ -50,14 +50,14 @@ type NeoCache struct {
votesChanged bool votesChanged bool
nextValidators keys.PublicKeys nextValidators keys.PublicKeys
// validators contains cached next block validators. This list is updated once // newEpochNextValidators contains cached next block newEpochNextValidators. This list is updated once
// per dBFT epoch in PostPersist of the last block in the epoch if candidates // per dBFT epoch in PostPersist of the last block in the epoch if candidates
// votes ratio has been changed or register/unregister operation was performed // votes ratio has been changed or register/unregister operation was performed
// within the last processed epoch. The updated value is being persisted // within the last processed epoch. The updated value is being persisted
// following the standard layered DAO persist rules, so that external users // following the standard layered DAO persist rules, so that external users
// will get the proper value with upper Blockchain's DAO (but this value is // will get the proper value with upper Blockchain's DAO (but this value is
// relevant only by the moment of first epoch block creation). // relevant only by the moment of first epoch block creation).
validators keys.PublicKeys newEpochNextValidators keys.PublicKeys
// committee contains cached committee members and their votes. // committee contains cached committee members and their votes.
// It is updated once in a while depending on committee size // It is updated once in a while depending on committee size
// (every 28 blocks for mainnet). It's value // (every 28 blocks for mainnet). It's value
@ -132,9 +132,9 @@ func (c *NeoCache) Copy() dao.NativeContractCache {
func copyNeoCache(src, dst *NeoCache) { func copyNeoCache(src, dst *NeoCache) {
dst.votesChanged = src.votesChanged dst.votesChanged = src.votesChanged
// Can safely omit copying because the new array is created each time // Can safely omit copying because the new array is created each time
// validators list, nextValidators and committee are updated. // newEpochNextValidators list, nextValidators and committee are updated.
dst.nextValidators = src.nextValidators dst.nextValidators = src.nextValidators
dst.validators = src.validators dst.newEpochNextValidators = src.newEpochNextValidators
dst.committee = src.committee dst.committee = src.committee
dst.committeeHash = src.committeeHash dst.committeeHash = src.committeeHash
@ -276,7 +276,7 @@ func (n *NEO) Initialize(ic *interop.Context) error {
cache := &NeoCache{ cache := &NeoCache{
gasPerVoteCache: make(map[string]big.Int), gasPerVoteCache: make(map[string]big.Int),
votesChanged: true, votesChanged: true,
validators: nil, // will be updated in the last epoch block's PostPersist right before the committee update block. newEpochNextValidators: nil, // will be updated in the last epoch block's PostPersist right before the committee update block.
} }
// We need cache to be present in DAO before the subsequent call to `mint`. // We need cache to be present in DAO before the subsequent call to `mint`.
@ -323,7 +323,7 @@ func (n *NEO) InitializeCache(blockHeight uint32, d *dao.Simple) error {
// this field, and it will be updated during the PostPersist of the last // this field, and it will be updated during the PostPersist of the last
// block in the current epoch. If it's the laast block of the current epoch, // block in the current epoch. If it's the laast block of the current epoch,
// then update this cache manually below. // then update this cache manually below.
validators: nil, newEpochNextValidators: nil,
} }
var committee = keysWithVotes{} var committee = keysWithVotes{}
@ -344,7 +344,7 @@ func (n *NEO) InitializeCache(blockHeight uint32, d *dao.Simple) error {
var numOfCNs = n.cfg.GetNumOfCNs(blockHeight + 1) var numOfCNs = n.cfg.GetNumOfCNs(blockHeight + 1)
err := n.updateCachedValidators(d, cache, blockHeight, numOfCNs) err := n.updateCachedValidators(d, cache, blockHeight, numOfCNs)
if err != nil { if err != nil {
return fmt.Errorf("failed to update next block validators cache: %w", err) return fmt.Errorf("failed to update next block newEpochNextValidators cache: %w", err)
} }
} }
@ -376,7 +376,7 @@ func (n *NEO) updateCache(cache *NeoCache, cvs keysWithVotes, blockHeight uint32
return nil return nil
} }
// updateCachedValidators sets validators cache that will be used by external users // updateCachedValidators sets newEpochNextValidators cache that will be used by external users
// to retrieve next block validators list of the next dBFT epoch that wasn't yet // to retrieve next block validators list of the next dBFT epoch that wasn't yet
// started. Thus, it stores the list of validators computed using the persisted // started. Thus, it stores the list of validators computed using the persisted
// blocks state of the latest epoch. // blocks state of the latest epoch.
@ -387,7 +387,7 @@ func (n *NEO) updateCachedValidators(d *dao.Simple, cache *NeoCache, blockHeight
} }
result = result[:numOfCNs] result = result[:numOfCNs]
sort.Sort(result) sort.Sort(result)
cache.validators = result cache.newEpochNextValidators = result
return nil return nil
} }
@ -475,20 +475,20 @@ func (n *NEO) PostPersist(ic *interop.Context) error {
} }
} }
} }
// Update next block validators cache for external users if committee should be // Update next block newEpochNextValidators cache for external users if committee should be
// updated in the next block. // updated in the next block.
if n.cfg.ShouldUpdateCommitteeAt(ic.Block.Index + 1) { if n.cfg.ShouldUpdateCommitteeAt(ic.Block.Index + 1) {
var ( var (
h = ic.Block.Index // consider persisting block as stored to get _next_ block validators h = ic.Block.Index // consider persisting block as stored to get _next_ block newEpochNextValidators
numOfCNs = n.cfg.GetNumOfCNs(h + 1) numOfCNs = n.cfg.GetNumOfCNs(h + 1)
) )
if cache.validators == nil || numOfCNs != len(cache.validators) { if cache.newEpochNextValidators == nil || numOfCNs != len(cache.newEpochNextValidators) {
if !isCacheRW { if !isCacheRW {
cache = ic.DAO.GetRWCache(n.ID).(*NeoCache) cache = ic.DAO.GetRWCache(n.ID).(*NeoCache)
} }
err := n.updateCachedValidators(ic.DAO, cache, h, numOfCNs) err := n.updateCachedValidators(ic.DAO, cache, h, numOfCNs)
if err != nil { if err != nil {
return fmt.Errorf("failed to update next block validators cache: %w", err) return fmt.Errorf("failed to update next block newEpochNextValidators cache: %w", err)
} }
} }
} }
@ -831,7 +831,7 @@ func (n *NEO) UnregisterCandidateInternal(ic *interop.Context, pub *keys.PublicK
return nil return nil
} }
cache := ic.DAO.GetRWCache(n.ID).(*NeoCache) cache := ic.DAO.GetRWCache(n.ID).(*NeoCache)
cache.validators = nil cache.newEpochNextValidators = nil
c := new(candidate).FromBytes(si) c := new(candidate).FromBytes(si)
emitEvent := c.Registered emitEvent := c.Registered
c.Registered = false c.Registered = false
@ -957,7 +957,7 @@ func (n *NEO) ModifyAccountVotes(acc *state.NEOBalance, d *dao.Simple, value *bi
return nil return nil
} }
} }
cache.validators = nil cache.newEpochNextValidators = nil
return putConvertibleToDAO(n.ID, d, key, cd) return putConvertibleToDAO(n.ID, d, key, cd)
} }
return nil return nil
@ -1108,12 +1108,12 @@ func (n *NEO) ComputeNextBlockValidators(d *dao.Simple) keys.PublicKeys {
// It should always be OK with RO cache if using lower-layered DAO with proper // It should always be OK with RO cache if using lower-layered DAO with proper
// cache set. // cache set.
cache := d.GetROCache(n.ID).(*NeoCache) cache := d.GetROCache(n.ID).(*NeoCache)
if vals := cache.validators; vals != nil { if vals := cache.newEpochNextValidators; vals != nil {
return vals.Copy() return vals.Copy()
} }
// It's a caller's program error to call ComputeNextBlockValidators not having // It's a caller's program error to call ComputeNextBlockValidators not having
// the right value in lower cache. // the right value in lower cache.
panic("bug: unexpected external call to validators cache") panic("bug: unexpected external call to newEpochNextValidators cache")
} }
func (n *NEO) getCommittee(ic *interop.Context, _ []stackitem.Item) stackitem.Item { func (n *NEO) getCommittee(ic *interop.Context, _ []stackitem.Item) stackitem.Item {