[IIP-13] introduce read contract staking buckets (2/3 split by 3853) #3862
Conversation
Codecov Report
@@ Coverage Diff @@
## master #3862 +/- ##
==========================================
- Coverage 75.38% 75.16% -0.23%
==========================================
Files 303 306 +3
Lines 25923 26160 +237
==========================================
+ Hits 19541 19662 +121
- Misses 5360 5479 +119
+ Partials 1022 1019 -3
... and 3 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
| return cache | ||
| } | ||
|
|
||
| func (s *contractStakingCache) GetHeight() uint64 { |
| return s.height | ||
| } | ||
|
|
||
| func (s *contractStakingCache) GetCandidateVotes(candidate address.Address) *big.Int { |
There was a problem hiding this comment.
rename to CandidateVotes
| return votes | ||
| } | ||
|
|
||
| func (s *contractStakingCache) GetBuckets() ([]*Bucket, error) { |
| return vbs, nil | ||
| } | ||
|
|
||
| func (s *contractStakingCache) GetBucket(id uint64) (*Bucket, error) { |
| return s.getBucket(id) | ||
| } | ||
|
|
||
| func (s *contractStakingCache) GetBucketsByCandidate(candidate address.Address) ([]*Bucket, error) { |
There was a problem hiding this comment.
rename to BucketsByCandidate
| return vbs, nil | ||
| } | ||
|
|
||
| func (s *contractStakingCache) GetTotalBucketCount() uint64 { |
There was a problem hiding this comment.
rename to TotalBucketCount
| return s.totalBucketCount | ||
| } | ||
|
|
||
| func (s *contractStakingCache) GetActiveBucketTypes() map[uint64]*BucketType { |
There was a problem hiding this comment.
rename to ActiveBucketTypes
| const ( | ||
| // StakingContractAddress is the address of system staking contract | ||
| // TODO (iip-13): replace with the real system staking contract address | ||
| StakingContractAddress = "io19ys8f4uhwms6lq6ulexr5fwht9gsjes8mvuugd" |
There was a problem hiding this comment.
will be implemented in the integrate PR
| // kvstore: persistent storage, used to initialize index cache at startup | ||
| // cache: in-memory index for clean data, used to query index data | ||
| // dirty: the cache to update during event processing, will be merged to clean cache after all events are processed. If errors occur during event processing, dirty cache will be discarded. |
| // Main functions: | ||
| // 1. handle contract staking contract events when new block comes to generate index data | ||
| // 2. provide query interface for contract staking index data | ||
| // Generate index data flow: |
There was a problem hiding this comment.
flow explanation should not be here
There was a problem hiding this comment.
removed and should be added in #3863 at PutBlock
| propertyBucketTypeMap: make(map[int64]map[uint64]uint64), | ||
| candidateBucketMap: make(map[string]map[uint64]bool), | ||
| } | ||
| return cache |
There was a problem hiding this comment.
nit:
cache := contractStakingCache{
return &cache
|
Kudos, SonarCloud Quality Gate passed!
|
|
add integration testing,improve test coverage |
tests are added in next PR #3863 |
| } | ||
|
|
||
| func (s *contractStakingCache) mustGetBucketInfo(id uint64) *bucketInfo { | ||
| bt, ok := s.bucketInfoMap[id] |
| } | ||
|
|
||
| func (s *contractStakingCache) mustGetBucketType(id uint64) *BucketType { | ||
| bt, ok := s.bucketTypeMap[id] |
| // 1. handle contract staking contract events when new block comes to generate index data | ||
| // 2. provide query interface for contract staking index data | ||
| Indexer struct { | ||
| kvstore db.KVStore // persistent storage, used to initialize index cache at startup |
There was a problem hiding this comment.
kvstore and contractAddress where is it used?
There was a problem hiding this comment.
will be used in next PR #3863
Description
For #3853 is too large to review, it has been splited into three small pr. This is the second one.
It's based on #3861
Fixes #(issue)
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Test Configuration:
Checklist: