Skip to content

Refactor match bucket type #4706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 3, 2025
Merged

Refactor match bucket type #4706

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e998814
store contract staking data in trie
CoderZhi Jul 11, 2025
5ff0535
fix unit test and address comment
CoderZhi Sep 2, 2025
e236101
snapshot/revert views
CoderZhi Jul 11, 2025
86fe978
fix two unit tests and refactor matchbuckettype
CoderZhi Sep 1, 2025
435bb1b
Merge branch 'master' into refactor_match_bucket_type
CoderZhi Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions blockindex/contractstaking/cache.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ type (
BucketInfo(id uint64) (*bucketInfo, bool)
MustGetBucketInfo(id uint64) *bucketInfo
MustGetBucketType(id uint64) *BucketType
MatchBucketType(amount *big.Int, duration uint64) (uint64, *BucketType, bool)
MatchBucketType(amount *big.Int, duration uint64) (uint64, *BucketType)
BucketType(id uint64) (*BucketType, bool)
BucketTypeCount() int
Buckets() ([]uint64, []*BucketType, []*bucketInfo)
Expand Down Expand Up @@ -210,15 +210,15 @@ func (s *contractStakingCache) DeleteBucketInfo(id uint64) {
s.deltaBuckets[id] = nil
}

func (s *contractStakingCache) MatchBucketType(amount *big.Int, duration uint64) (uint64, *BucketType, bool) {
func (s *contractStakingCache) MatchBucketType(amount *big.Int, duration uint64) (uint64, *BucketType) {
s.mutex.RLock()
defer s.mutex.RUnlock()

id, ok := s.getBucketTypeIndex(amount, duration)
if !ok {
return 0, nil, false
return 0, nil
}
return id, s.mustGetBucketType(id), true
return id, s.mustGetBucketType(id)
}

func (s *contractStakingCache) LoadFromDB(kvstore db.KVStore) error {
Expand Down
20 changes: 8 additions & 12 deletions blockindex/contractstaking/cache_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,33 +376,29 @@ func TestContractStakingCache_MatchBucketType(t *testing.T) {
cache := newContractStakingCache()

// no bucket types
_, bucketType, ok := cache.MatchBucketType(big.NewInt(100), 100)
require.False(ok)
_, bucketType := cache.MatchBucketType(big.NewInt(100), 100)
require.Nil(bucketType)

// one bucket type
cache.PutBucketType(1, &BucketType{Amount: big.NewInt(100), Duration: 100, ActivatedAt: 1})
// match exact bucket type
id, bucketType, ok := cache.MatchBucketType(big.NewInt(100), 100)
require.True(ok)
id, bucketType := cache.MatchBucketType(big.NewInt(100), 100)
require.NotNil(bucketType)
require.EqualValues(1, id)
require.EqualValues(100, bucketType.Amount.Int64())
require.EqualValues(100, bucketType.Duration)
require.EqualValues(1, bucketType.ActivatedAt)

// match bucket type with different amount
_, bucketType, ok = cache.MatchBucketType(big.NewInt(200), 100)
require.False(ok)
_, bucketType = cache.MatchBucketType(big.NewInt(200), 100)
require.Nil(bucketType)

// match bucket type with different duration
_, bucketType, ok = cache.MatchBucketType(big.NewInt(100), 200)
require.False(ok)
_, bucketType = cache.MatchBucketType(big.NewInt(100), 200)
require.Nil(bucketType)

// no match
_, bucketType, ok = cache.MatchBucketType(big.NewInt(200), 200)
require.False(ok)
_, bucketType = cache.MatchBucketType(big.NewInt(200), 200)
require.Nil(bucketType)
}

Expand Down Expand Up @@ -533,8 +529,8 @@ func TestContractStakingCache_LoadFromDB(t *testing.T) {
require.Equal(bucketInfo, bi)
btc = cache.BucketTypeCount()
require.EqualValues(1, btc)
id, bt, ok := cache.MatchBucketType(big.NewInt(100), 100)
require.True(ok)
id, bt := cache.MatchBucketType(big.NewInt(100), 100)
require.NotNil(bt)
require.EqualValues(1, id)
require.EqualValues(100, bt.Amount.Int64())
require.EqualValues(100, bt.Duration)
Expand Down
6 changes: 3 additions & 3 deletions blockindex/contractstaking/dirty_cache.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ func (dirty *contractStakingDirty) deleteBucketInfo(id uint64) {
}

func (dirty *contractStakingDirty) putBucketType(bt *BucketType) {
id, _, ok := dirty.matchBucketType(bt.Amount, bt.Duration)
if !ok {
id, old := dirty.matchBucketType(bt.Amount, bt.Duration)
if old == nil {
id = dirty.getBucketTypeCount()
dirty.addBucketType(id, bt)
}
Expand Down Expand Up @@ -112,7 +112,7 @@ func (dirty *contractStakingDirty) addBucketType(id uint64, bt *BucketType) {
dirty.cache.PutBucketType(id, bt)
}

func (dirty *contractStakingDirty) matchBucketType(amount *big.Int, duration uint64) (uint64, *BucketType, bool) {
func (dirty *contractStakingDirty) matchBucketType(amount *big.Int, duration uint64) (uint64, *BucketType) {
return dirty.cache.MatchBucketType(amount, duration)
}

Expand Down
11 changes: 5 additions & 6 deletions blockindex/contractstaking/dirty_cache_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,24 +96,23 @@ func TestContractStakingDirty_matchBucketType(t *testing.T) {
dirty := newContractStakingDirty(clean)

// no bucket type
id, bt, ok := dirty.matchBucketType(big.NewInt(100), 100)
require.False(ok)
id, bt := dirty.matchBucketType(big.NewInt(100), 100)
require.Nil(bt)
require.EqualValues(0, id)

// bucket type in clean cache
clean.PutBucketType(1, &BucketType{Amount: big.NewInt(100), Duration: 100, ActivatedAt: 1})
id, bt, ok = dirty.matchBucketType(big.NewInt(100), 100)
require.True(ok)
id, bt = dirty.matchBucketType(big.NewInt(100), 100)
require.NotNil(bt)
require.EqualValues(100, bt.Amount.Int64())
require.EqualValues(100, bt.Duration)
require.EqualValues(1, bt.ActivatedAt)
require.EqualValues(1, id)

// added bucket type
dirty.addBucketType(2, &BucketType{Amount: big.NewInt(200), Duration: 200, ActivatedAt: 2})
id, bt, ok = dirty.matchBucketType(big.NewInt(200), 200)
require.True(ok)
id, bt = dirty.matchBucketType(big.NewInt(200), 200)
require.NotNil(bt)
require.EqualValues(200, bt.Amount.Int64())
require.EqualValues(200, bt.Duration)
require.EqualValues(2, bt.ActivatedAt)
Expand Down
20 changes: 10 additions & 10 deletions blockindex/contractstaking/event_handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -491,8 +491,8 @@ func (eh *contractStakingEventHandler) handleBucketTypeDeactivatedEvent(event ev
return err
}

id, bt, ok := eh.dirty.matchBucketType(amountParam, durationParam.Uint64())
if !ok {
id, bt := eh.dirty.matchBucketType(amountParam, durationParam.Uint64())
if bt == nil {
return errors.Wrapf(errBucketTypeNotExist, "amount %d, duration %d", amountParam.Int64(), durationParam.Uint64())
}
bt.ActivatedAt = maxBlockNumber
Expand All @@ -519,8 +519,8 @@ func (eh *contractStakingEventHandler) handleStakedEvent(event eventParam, heigh
return err
}

btIdx, _, ok := eh.dirty.matchBucketType(amountParam, durationParam.Uint64())
if !ok {
btIdx, bt := eh.dirty.matchBucketType(amountParam, durationParam.Uint64())
if bt == nil {
return errors.Wrapf(errBucketTypeNotExist, "amount %d, duration %d", amountParam.Int64(), durationParam.Uint64())
}
owner, ok := eh.tokenOwner[tokenIDParam.Uint64()]
Expand Down Expand Up @@ -557,8 +557,8 @@ func (eh *contractStakingEventHandler) handleLockedEvent(event eventParam) error
if !ok {
return errors.Wrapf(errBucketTypeNotExist, "id %d", b.TypeIndex)
}
newBtIdx, _, ok := eh.dirty.matchBucketType(bt.Amount, durationParam.Uint64())
if !ok {
newBtIdx, newBt := eh.dirty.matchBucketType(bt.Amount, durationParam.Uint64())
if newBt == nil {
return errors.Wrapf(errBucketTypeNotExist, "amount %v, duration %d", bt.Amount, durationParam.Uint64())
}
b.TypeIndex = newBtIdx
Expand Down Expand Up @@ -615,8 +615,8 @@ func (eh *contractStakingEventHandler) handleMergedEvent(event eventParam) error
}

// merge to the first bucket
btIdx, _, ok := eh.dirty.matchBucketType(amountParam, durationParam.Uint64())
if !ok {
btIdx, bt := eh.dirty.matchBucketType(amountParam, durationParam.Uint64())
if bt == nil {
return errors.Wrapf(errBucketTypeNotExist, "amount %d, duration %d", amountParam.Int64(), durationParam.Uint64())
}
b, ok := eh.dirty.getBucketInfo(tokenIDsParam[0].Uint64())
Expand Down Expand Up @@ -651,8 +651,8 @@ func (eh *contractStakingEventHandler) handleBucketExpandedEvent(event eventPara
if !ok {
return errors.Wrapf(ErrBucketNotExist, "token id %d", tokenIDParam.Uint64())
}
newBtIdx, _, ok := eh.dirty.matchBucketType(amountParam, durationParam.Uint64())
if !ok {
newBtIdx, newBucketType := eh.dirty.matchBucketType(amountParam, durationParam.Uint64())
if newBucketType == nil {
return errors.Wrapf(errBucketTypeNotExist, "amount %d, duration %d", amountParam.Int64(), durationParam.Uint64())
}
b.TypeIndex = newBtIdx
Expand Down
4 changes: 2 additions & 2 deletions blockindex/contractstaking/indexer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,8 @@ func (s *Indexer) LoadStakeView(ctx context.Context, sr protocol.StateReader) (s
if buckets[i] == nil {
return nil, errors.New("bucket is nil")
}
tid, _, ok := cache.MatchBucketType(buckets[i].StakedAmount, buckets[i].StakedDuration)
if !ok {
tid, bt := cache.MatchBucketType(buckets[i].StakedAmount, buckets[i].StakedDuration)
if bt == nil {
return nil, errors.Errorf(
"no bucket type found for bucket %d with staked amount %s and duration %d",
id,
Expand Down
12 changes: 6 additions & 6 deletions blockindex/contractstaking/wrappedcache.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,8 +198,8 @@ func (wc *wrappedCache) PutBucketType(id uint64, bt *BucketType) {
panic("bucket type amount or duration cannot be changed")
}
}
oldId, _, ok := wc.matchBucketType(bt.Amount, bt.Duration)
if ok && oldId != id {
oldId, oldBucketType := wc.matchBucketType(bt.Amount, bt.Duration)
if oldBucketType != nil && oldId != id {
panic("bucket type with same amount and duration already exists")
}
if _, ok := wc.propertyBucketTypeMap[bt.Amount.Uint64()]; !ok {
Expand Down Expand Up @@ -313,21 +313,21 @@ func (wc *wrappedCache) DeleteBucketInfo(id uint64) {
wc.updatedBucketInfos[id] = nil
}

func (wc *wrappedCache) MatchBucketType(amount *big.Int, duration uint64) (uint64, *BucketType, bool) {
func (wc *wrappedCache) MatchBucketType(amount *big.Int, duration uint64) (uint64, *BucketType) {
wc.mu.RLock()
defer wc.mu.RUnlock()
return wc.matchBucketType(amount, duration)
}

func (wc *wrappedCache) matchBucketType(amount *big.Int, duration uint64) (uint64, *BucketType, bool) {
func (wc *wrappedCache) matchBucketType(amount *big.Int, duration uint64) (uint64, *BucketType) {
amountUint64 := amount.Uint64()
if amountMap, ok := wc.propertyBucketTypeMap[amountUint64]; ok {
if id, ok := amountMap[duration]; ok {
if bt, ok := wc.updatedBucketTypes[id]; ok {
if bt != nil {
return id, bt, true
return id, bt
}
return 0, nil, false
return 0, nil
}
}
}
Expand Down