chore: merge feature/v2.0.0 to develop (#1242)

* refactor: calculated gas limit using formula for reveal transaction (#1231)

* chore: updated deployment parameters for 5 min epoch europa contracts   (#1229)

* chore: updated deployement parameters for 5 min europa chain

* refactor: fixed statelength and epochlength change tests

* chore: updated version to v2.0.0

* refactor: updated the chain name to EUROPA in chainId info

* refactor: added validation on buffer percent limits (#1228)

* refactor: added validation on buffer percent limits

* refactor: fixed tests

* refactor: updated default value when builded from source in config script

* refactor: fixed lint error

* refactor: fixed vote tests

* refactor: fixed getBufferPercent() tests

* refactor: recorrected the comment for max buffer formula used

* chore: updated config variable default and limits for 5 min epoch (#1232)

* refactor: created the local cache instance only once (#1233)

* refactor: replaced goroutine cleanuploop with normal cleanup function

* refactor: initialised local cache only once an reused again

* refactor: fixed tests

* chore: update default wait time in config.sh (#1234)

* chore: updated npm version and mainnet contract addresses to official contracts for 5 min epoch (#1243)

* chore: updated mainnet contract addresses to official 5 min epoch contracts

* chore: updated contracts version in dependencies

* chore: updated node-version in workflows

* refactor: update package-lock.json and reinstall dependencies

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: "18"
+          node-version: "20"
       - name: Setup Go
         uses: actions/setup-go@v2
         with:
@@ -85,7 +85,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: "18"
+          node-version: "20"
 
       - name: Setup Go
         uses: actions/setup-go@v2
@@ -136,7 +136,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: "18"
+          node-version: "20"
 
       - name: Setup Go
         uses: actions/setup-go@v2
@@ -194,7 +194,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: "18"
+          node-version: "20"
 
       - name: Download Artifacts AMD
         uses: actions/download-artifact@v3

.github/workflows/develop.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: "18"
+          node-version: "20"
       - name: Setup Go
         uses: actions/setup-go@v2
         with:

.github/workflows/release.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: "18"
+          node-version: "20"
       - name: Setup Go
         uses: actions/setup-go@v2
         with:

addresses/mainnet.json

@@ -1,12 +1,12 @@
 {
-    "Governance": "0xAc40E8dA38B5a381008059a38bb9bf45f0D3C4e2",
-    "BlockManager": "0x11aB70d78f1Dd2c3F967180d8A64858Db03A0aBa",
-    "CollectionManager": "0x367962d1462C568A0dDd0e2448311469451bF5a3",
-    "StakeManager": "0xe0bC695203d9C9f379bcdE9260B9F71B64B85298",
-    "RewardManager": "0x301779E4c95f951D2E17B4c3EdDC717551df2EBb",
-    "VoteManager": "0x641BAD0641eB5B94B19568C0a22a55AEbDAF1870",
-    "Delegator": "0xC74745eA5a3fac1864FAcd8f48d72C21A4ab883D",
-    "RAZOR": "0xcbf70914Fae03B3acB91E953De60CfDAaCA8145f",
-    "StakedTokenFactory": "0xEffA78888Dc1b6033286E5dF9b170bc5223178AB",
-    "RandomNoManager": "0xC6eF45F5Add040800D30FE6dEe01b4EBC4BfC467"
+    "Governance": "0x4a33c6f8CEc5a8D8A5Dca2ec43bc0f78f132d31b",
+    "BlockManager": "0x2B28f0C3c74ADf9c5C6B3e1a998Ed37BDfF64f53",
+    "CollectionManager": "0xFe8627C79E85447c3ea643F388613D5E69C8Ca4a",
+    "StakeManager": "0xC5d2795324B40475F99739017DeA9eD946008006",
+    "RewardManager": "0x161F55f7019B67D24E05D0f018cc7f9ba2cdFC22",
+    "VoteManager": "0xeDA9a9c1F7E36cB2F90f902dF06acE880EC18e83",
+    "Delegator": "0x7e325b078Cee5De7795672EE59b7Cd7DF4e7a79b",
+    "RAZOR": "0xCA46B70cA3c510Ce9D0c43D25817032e2F5354c0",
+    "StakedTokenFactory": "0x24f11293993f71CAcA17bD182F3351E5c46910c5",
+    "RandomNoManager": "0x59AE1bE01C74ABCBb4AE0c24CCF9C30d7f638A0F"
 }

addresses/testnet.json

@@ -1,13 +1,12 @@
 {
-    "Governance": "0x0b9CC11E7f7D3D4f9bBc0cCaB85b73B96C322c78",
-    "BlockManager": "0x076df1c2d81C40D30DF115Ab68A13251fBD3FFA4",
-    "CollectionManager": "0x83f4D7ad6dD366c3F04Af45a1437c77636b03388",
-    "StakeManager": "0xf99a873a6afdF1b24388ac02ea0f1CFE3c70A80b",
-    "RewardManager": "0x522d2A51639332388dA4788DF59fB4E598278fAd",
-    "VoteManager": "0x2399D4d92b4D8762971605d0bC9597F780852CC4",
-    "Delegator": "0x81c72fB60d19Bfc3A0adDfE394501150d290cd66",
-    "RAZOR": "0x504C6635af1e7E6fdc586c8A89973783b9281A77",
-    "StakedTokenFactory": "0xf271bd91104946Cb8e43BC0e83423ed073ab136e",
-    "RandomNoManager": "0x2dc9E4663675c933f78D97cDD44463ee9C43144c",
-    "DelegatorV2": "0x4e9E5AE58Fb6d7Ca5b79A196b8d0FCF7CA15C100"
+    "Governance": "0x0C91e21D91510A1e95cd3507474c0ac1F620389d",
+    "BlockManager": "0x1eB1aD4C24cf2CA2027C05a28e78A117fDACD9F9",
+    "CollectionManager": "0xAFC593871Ab8EE89fd79B2ebd9F1f502268732b9",
+    "StakeManager": "0x7ce95141358FeF127d3F79f7a5C21C6c2afa1cA3",
+    "RewardManager": "0xbaa2e7509AdB5762f33064Ad762dF1136184Ef7D",
+    "VoteManager": "0x57a996015D831F6f4818ff962ffE405b6c6d4B21",
+    "Delegator": "0x63F82745aBe00c43a71ff2A48E65B281f72Bb54D",
+    "RAZOR": "0x91d07a181e2Fb787204Ae82B28c69e278C05ac70",
+    "StakedTokenFactory": "0x047f5865e666DCc278ad3bd8de8503D35d5278Ea",
+    "RandomNoManager": "0x3A6bbfBBe24F5F5D20F6a7265A0F602d155C2471"
 }

cache/cache.go

@@ -11,53 +11,17 @@ type cachedData struct {
 }
 
 type LocalCache struct {
-	stop chan struct{}
-
-	wg   sync.WaitGroup
 	mu   sync.RWMutex
 	URLs map[string]cachedData //URLs
 }
 
-func NewLocalCache(cleanupInterval time.Duration) *LocalCache {
-	lc := &LocalCache{
+// NewLocalCache creates a new LocalCache instance
+func NewLocalCache() *LocalCache {
+	return &LocalCache{
 		URLs: make(map[string]cachedData),
-		stop: make(chan struct{}),
-	}
-
-	lc.wg.Add(1)
-	go func(cleanupInterval time.Duration) {
-		defer lc.wg.Done()
-		lc.cleanupLoop(cleanupInterval)
-	}(cleanupInterval)
-
-	return lc
-}
-
-func (lc *LocalCache) cleanupLoop(interval time.Duration) {
-	t := time.NewTicker(interval)
-	defer t.Stop()
-
-	for {
-		select {
-		case <-lc.stop:
-			return
-		case <-t.C:
-			lc.mu.Lock()
-			for url, cu := range lc.URLs {
-				if cu.expireAtTimestamp <= time.Now().Unix() {
-					delete(lc.URLs, url)
-				}
-			}
-			lc.mu.Unlock()
-		}
 	}
 }
 
-func (lc *LocalCache) StopCleanup() {
-	close(lc.stop)
-	lc.wg.Wait()
-}
-
 func (lc *LocalCache) Update(data []byte, url string, expireAtTimestamp int64) {
 	lc.mu.Lock()
 	defer lc.mu.Unlock()
@@ -80,3 +44,26 @@ func (lc *LocalCache) Read(url string) ([]byte, bool) {
 
 	return cacheData.Result, true
 }
+
+// ClearAll deletes all entries in the cache
+func (lc *LocalCache) ClearAll() {
+	lc.mu.Lock()
+	defer lc.mu.Unlock()
+
+	for key := range lc.URLs {
+		delete(lc.URLs, key)
+	}
+}
+
+// Cleanup removes expired cache entries
+func (lc *LocalCache) Cleanup() {
+	lc.mu.Lock()
+	defer lc.mu.Unlock()
+
+	for url, data := range lc.URLs {
+		// Remove expired data after the expireAtTimestamp is passed
+		if data.expireAtTimestamp <= time.Now().Unix() {
+			delete(lc.URLs, url)
+		}
+	}
+}

cmd/cmd-utils.go

@@ -23,6 +23,10 @@ func (*UtilsStruct) GetEpochAndState(client *ethclient.Client) (uint32, int64, e
 	if err != nil {
 		return 0, 0, err
 	}
+	err = ValidateBufferPercentLimit(client, bufferPercent)
+	if err != nil {
+		return 0, 0, err
+	}
 	latestHeader, err := clientUtils.GetLatestBlockWithRetry(client)
 	if err != nil {
 		log.Error("Error in fetching block: ", err)

cmd/cmd-utils_test.go

@@ -20,6 +20,8 @@ func TestGetEpochAndState(t *testing.T) {
 		latestHeaderErr  error
 		bufferPercent    int32
 		bufferPercentErr error
+		stateBuffer      uint64
+		stateBufferErr   error
 		state            int64
 		stateErr         error
 		stateName        string
@@ -37,6 +39,7 @@ func TestGetEpochAndState(t *testing.T) {
 				epoch:         4,
 				latestHeader:  &Types.Header{},
 				bufferPercent: 20,
+				stateBuffer:   5,
 				state:         0,
 				stateName:     "commit",
 			},
@@ -50,6 +53,7 @@ func TestGetEpochAndState(t *testing.T) {
 				epochErr:      errors.New("epoch error"),
 				latestHeader:  &Types.Header{},
 				bufferPercent: 20,
+				stateBuffer:   5,
 				state:         0,
 				stateName:     "commit",
 			},
@@ -76,6 +80,7 @@ func TestGetEpochAndState(t *testing.T) {
 				epoch:         4,
 				latestHeader:  &Types.Header{},
 				bufferPercent: 20,
+				stateBuffer:   5,
 				stateErr:      errors.New("state error"),
 			},
 			wantEpoch: 0,
@@ -88,20 +93,46 @@ func TestGetEpochAndState(t *testing.T) {
 				epoch:           4,
 				latestHeaderErr: errors.New("header error"),
 				bufferPercent:   20,
+				stateBuffer:     5,
 				state:           0,
 				stateName:       "commit",
 			},
 			wantEpoch: 0,
 			wantState: 0,
 			wantErr:   errors.New("header error"),
 		},
+		{
+			name: "Test 6: When validating buffer percent limit fails",
+			args: args{
+				epoch:         4,
+				latestHeader:  &Types.Header{},
+				bufferPercent: 50,
+				stateBuffer:   10,
+			},
+			wantEpoch: 0,
+			wantState: 0,
+			wantErr:   errors.New("buffer percent exceeds limit"),
+		},
+		{
+			name: "Test 7: When there is an error in validating buffer percent limit",
+			args: args{
+				epoch:          4,
+				latestHeader:   &Types.Header{},
+				bufferPercent:  50,
+				stateBufferErr: errors.New("state buffer error"),
+			},
+			wantEpoch: 0,
+			wantState: 0,
+			wantErr:   errors.New("state buffer error"),
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			SetUpMockInterfaces()
 
 			utilsMock.On("GetEpoch", mock.AnythingOfType("*ethclient.Client")).Return(tt.args.epoch, tt.args.epochErr)
 			cmdUtilsMock.On("GetBufferPercent").Return(tt.args.bufferPercent, tt.args.bufferPercentErr)
+			utilsMock.On("GetStateBuffer", mock.Anything).Return(tt.args.stateBuffer, tt.args.stateBufferErr)
 			clientUtilsMock.On("GetLatestBlockWithRetry", mock.Anything).Return(tt.args.latestHeader, tt.args.latestHeaderErr)
 			utilsMock.On("GetBufferedState", mock.Anything, mock.Anything, mock.Anything).Return(tt.args.state, tt.args.stateErr)
 

cmd/commit.go

@@ -4,16 +4,13 @@ package cmd
 import (
 	"encoding/hex"
 	"errors"
+	Types "github.com/ethereum/go-ethereum/core/types"
 	"math/big"
-	"razor/cache"
 	"razor/core"
 	"razor/core/types"
 	"razor/pkg/bindings"
 	"razor/utils"
 	"sync"
-	"time"
-
-	Types "github.com/ethereum/go-ethereum/core/types"
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/ethclient"
@@ -79,8 +76,8 @@ func (*UtilsStruct) HandleCommitState(client *ethclient.Client, epoch uint32, se
 
 	var wg sync.WaitGroup
 
-	log.Debug("Creating a local cache which will store API result and expire at the end of commit state")
-	commitParams.LocalCache = cache.NewLocalCache(time.Second * time.Duration(core.StateLength))
+	// Clean up any expired API results cache data before performing the commit
+	commitParams.LocalCache.Cleanup()
 
 	log.Debug("Iterating over all the collections...")
 	for i := 0; i < int(numActiveCollections); i++ {
@@ -129,7 +126,6 @@ func (*UtilsStruct) HandleCommitState(client *ethclient.Client, epoch uint32, se
 			if err != nil {
 				// Returning the first error from the error channel
 				log.Error("Error in getting collection data: ", err)
-				commitParams.LocalCache.StopCleanup()
 				return types.CommitData{}, err
 			}
 		}
@@ -139,8 +135,6 @@ func (*UtilsStruct) HandleCommitState(client *ethclient.Client, epoch uint32, se
 	log.Debug("HandleCommitState: SeqAllottedCollections: ", seqAllottedCollections)
 	log.Debug("HandleCommitState: Leaves: ", leavesOfTree)
 
-	commitParams.LocalCache.StopCleanup()
-
 	return types.CommitData{
 		AssignedCollections:    assignedCollections,
 		SeqAllottedCollections: seqAllottedCollections,

cmd/commit_test.go

@@ -16,7 +16,6 @@ import (
 	"razor/utils"
 	"reflect"
 	"testing"
-	"time"
 )
 
 func TestCommit(t *testing.T) {
@@ -226,7 +225,7 @@ func TestHandleCommitState(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			localCache := cache.NewLocalCache(time.Second * 10)
+			localCache := cache.NewLocalCache()
 			commitParams := &types.CommitParams{
 				LocalCache: localCache,
 			}
@@ -396,7 +395,7 @@ func BenchmarkHandleCommitState(b *testing.B) {
 	for _, v := range table {
 		b.Run(fmt.Sprintf("Number_Of_Active_Collections%d", v.numActiveCollections), func(b *testing.B) {
 			for i := 0; i < b.N; i++ {
-				localCache := cache.NewLocalCache(time.Second * 10)
+				localCache := cache.NewLocalCache()
 				commitParams := &types.CommitParams{
 					LocalCache: localCache,
 				}