refactor: remove duplicated EventListener interface

vitelabs · May 4, 2022 · 06e966c · 06e966c
1 parent 3decfc2
commit 06e966c
Show file tree

Hide file tree

Showing 8 changed files with 151 additions and 160 deletions.
diff --git a/interfaces/chain.go b/interfaces/chain.go
@@ -9,6 +9,20 @@ import (
 	"github.com/vitelabs/go-vite/v2/interfaces/core"
 )
 
+type EventListener interface {
+	PrepareInsertAccountBlocks(blocks []*VmAccountBlock) error
+	InsertAccountBlocks(blocks []*VmAccountBlock) error
+
+	PrepareInsertSnapshotBlocks(chunks []*core.SnapshotChunk) error
+	InsertSnapshotBlocks(chunks []*core.SnapshotChunk) error
+
+	PrepareDeleteAccountBlocks(blocks []*core.AccountBlock) error
+	DeleteAccountBlocks(blocks []*core.AccountBlock) error
+
+	PrepareDeleteSnapshotBlocks(chunks []*core.SnapshotChunk) error
+	DeleteSnapshotBlocks(chunks []*core.SnapshotChunk) error
+}
+
 type StorageIterator interface {
 	Last() bool
 	Prev() bool

diff --git a/ledger/chain/event_manager.go b/ledger/chain/event_manager.go
@@ -24,7 +24,7 @@ const (
 )
 
 type eventManager struct {
-	listenerList []EventListener
+	listenerList []interfaces.EventListener
 
 	chain        *chain
 	maxHandlerId uint32
@@ -35,7 +35,7 @@ func newEventManager(chain *chain) *eventManager {
 	return &eventManager{
 		chain:        chain,
 		maxHandlerId: 0,
-		listenerList: make([]EventListener, 0),
+		listenerList: make([]interfaces.EventListener, 0),
 	}
 }
 
@@ -150,14 +150,14 @@ func (em *eventManager) TriggerDeleteSbs(eventType byte, chunks []*ledger.Snapsh
 	return nil
 }
 
-func (em *eventManager) Register(listener EventListener) {
+func (em *eventManager) Register(listener interfaces.EventListener) {
 	em.mu.Lock()
 	defer em.mu.Unlock()
 
 	em.listenerList = append(em.listenerList, listener)
 }
 
-func (em *eventManager) UnRegister(listener EventListener) {
+func (em *eventManager) UnRegister(listener interfaces.EventListener) {
 	em.mu.Lock()
 	defer em.mu.Unlock()
 
@@ -169,10 +169,10 @@ func (em *eventManager) UnRegister(listener EventListener) {
 	}
 }
 
-func (c *chain) Register(listener EventListener) {
+func (c *chain) Register(listener interfaces.EventListener) {
 	c.em.Register(listener)
 }
 
-func (c *chain) UnRegister(listener EventListener) {
+func (c *chain) UnRegister(listener interfaces.EventListener) {
 	c.em.UnRegister(listener)
 }
diff --git a/ledger/chain/interface.go b/ledger/chain/interface.go
@@ -18,20 +18,6 @@ import (
 	"github.com/vitelabs/go-vite/v2/vm/contracts/dex"
 )
 
-type EventListener interface {
-	PrepareInsertAccountBlocks(blocks []*interfaces.VmAccountBlock) error
-	InsertAccountBlocks(blocks []*interfaces.VmAccountBlock) error
-
-	PrepareInsertSnapshotBlocks(chunks []*ledger.SnapshotChunk) error
-	InsertSnapshotBlocks(chunks []*ledger.SnapshotChunk) error
-
-	PrepareDeleteAccountBlocks(blocks []*ledger.AccountBlock) error
-	DeleteAccountBlocks(blocks []*ledger.AccountBlock) error
-
-	PrepareDeleteSnapshotBlocks(chunks []*ledger.SnapshotChunk) error
-	DeleteSnapshotBlocks(chunks []*ledger.SnapshotChunk) error
-}
-
 type Consensus interface {
 	VerifyAccountProducer(block *ledger.AccountBlock) (bool, error)
 	SBPReader() core.SBPStatReader
@@ -53,8 +39,8 @@ type Chain interface {
 	/*
 	*	Event Manager
 	 */
-	Register(listener EventListener)
-	UnRegister(listener EventListener)
+	Register(listener interfaces.EventListener)
+	UnRegister(listener interfaces.EventListener)
 
 	/*
 	 *	C(Create)

diff --git a/ledger/chain/state/interface.go b/ledger/chain/state/interface.go
@@ -13,20 +13,6 @@ import (
 	"github.com/vitelabs/go-vite/v2/ledger/consensus/core"
 )
 
-type EventListener interface {
-	PrepareInsertAccountBlocks(blocks []*interfaces.VmAccountBlock) error
-	InsertAccountBlocks(blocks []*interfaces.VmAccountBlock) error
-
-	PrepareInsertSnapshotBlocks(snapshotBlocks []*ledger.SnapshotBlock) error
-	InsertSnapshotBlocks(snapshotBlocks []*ledger.SnapshotBlock) error
-
-	PrepareDeleteAccountBlocks(blocks []*ledger.AccountBlock) error
-	DeleteAccountBlocks(blocks []*ledger.AccountBlock) error
-
-	PrepareDeleteSnapshotBlocks(chunks []*ledger.SnapshotChunk) error
-	DeleteSnapshotBlocks(chunks []*ledger.SnapshotChunk) error
-}
-
 type Consensus interface {
 	VerifyAccountProducer(block *ledger.AccountBlock) (bool, error)
 	SBPReader() core.SBPStatReader

diff --git a/ledger/consensus/README.md b/ledger/consensus/README.md
@@ -0,0 +1,5 @@
+Generate `MockChain`:
+
+```
+~/go/bin/mockgen -source=ledger/consensus/chain_rw.go -destination=ledger/consensus/mock_ch.go -package=consensus
+```
diff --git a/ledger/consensus/chain_rw.go b/ledger/consensus/chain_rw.go
@@ -7,13 +7,14 @@ import (
 	"sync"
 	"time"
 
-	"github.com/hashicorp/golang-lru"
+	lru "github.com/hashicorp/golang-lru"
 	"github.com/pkg/errors"
 	"github.com/syndtr/goleveldb/leveldb"
 
 	"github.com/vitelabs/go-vite/v2/common/types"
+	"github.com/vitelabs/go-vite/v2/interfaces"
 	ledger "github.com/vitelabs/go-vite/v2/interfaces/core"
-	"github.com/vitelabs/go-vite/v2/ledger/chain"
+
 	"github.com/vitelabs/go-vite/v2/ledger/consensus/cdb"
 	"github.com/vitelabs/go-vite/v2/ledger/consensus/core"
 	"github.com/vitelabs/go-vite/v2/ledger/pool/lock"
@@ -28,8 +29,8 @@ type Chain interface {
 	/*
 	*	Event Manager
 	 */
-	Register(listener chain.EventListener)
-	UnRegister(listener chain.EventListener)
+	Register(listener interfaces.EventListener)
+	UnRegister(listener interfaces.EventListener)
 
 	GetConsensusGroupList(snapshotHash types.Hash) ([]*types.ConsensusGroupInfo, error)                                                 // Get all consensus group
 	GetRegisterList(snapshotHash types.Hash, gid types.Gid) ([]*types.Registration, error)                                              // Get register for consensus group