forked from celo-org/celo-blockchain
-
Notifications
You must be signed in to change notification settings - Fork 0
/
protocol.go
63 lines (58 loc) · 2.57 KB
/
protocol.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
// Copyright 2017 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
// Package consensus implements different Ethereum consensus engines.
package consensus
import (
"github.com/conclave-dev/celo-blockchain/core/types"
"github.com/conclave-dev/celo-blockchain/p2p"
"github.com/conclave-dev/celo-blockchain/p2p/enode"
)
// Broadcaster defines the interface to enqueue blocks to fetcher, find peer
type Broadcaster interface {
// Enqueue add a block into fetcher queue
Enqueue(id string, block *types.Block)
// FindPeers retrives peers by addresses
FindPeers(targets map[enode.ID]bool, purpose p2p.PurposeFlag) map[enode.ID]Peer
}
// P2PServer defines the interface for a p2p.server to get the local node's enode and to add/remove for static/trusted peers
type P2PServer interface {
// Gets this node's enode
Self() *enode.Node
// AddPeer will add a peer to the p2p server instance
AddPeer(node *enode.Node, purpose p2p.PurposeFlag)
// RemovePeer will remove a peer from the p2p server instance
RemovePeer(node *enode.Node, purpose p2p.PurposeFlag)
// AddTrustedPeer will add a trusted peer to the p2p server instance
AddTrustedPeer(node *enode.Node, purpose p2p.PurposeFlag)
// RemoveTrustedPeer will remove a trusted peer from the p2p server instance
RemoveTrustedPeer(node *enode.Node, purpose p2p.PurposeFlag)
}
// Peer defines the interface for a p2p.peer
type Peer interface {
// Send sends the message to this peer
Send(msgcode uint64, data interface{}) error
// Node returns the peer's enode
Node() *enode.Node
// Version returns the peer's version
Version() int
// Blocks until a message is read directly from the peer.
// This should only be used during a handshake.
ReadMsg() (p2p.Msg, error)
// Inbound returns if the peer connection is inbound
Inbound() bool
// PurposeIsSet returns if the peer has a purpose set
PurposeIsSet(purpose p2p.PurposeFlag) bool
}