2014-12-05 21:14:55 +00:00
|
|
|
package eth
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bytes"
|
|
|
|
"math"
|
|
|
|
"math/big"
|
|
|
|
|
|
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
|
|
"github.com/ethereum/go-ethereum/ethutil"
|
|
|
|
"github.com/ethereum/go-ethereum/p2p"
|
2014-12-09 23:55:50 +00:00
|
|
|
"github.com/ethereum/go-ethereum/rlp"
|
2014-12-05 21:14:55 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
// ethProtocol represents the ethereum wire protocol
|
|
|
|
// instance is running on each peer
|
|
|
|
type ethProtocol struct {
|
2014-12-14 18:04:50 +00:00
|
|
|
txPool txPool
|
|
|
|
chainManager chainManager
|
|
|
|
blockPool blockPool
|
|
|
|
peer *p2p.Peer
|
|
|
|
id string
|
|
|
|
rw p2p.MsgReadWriter
|
2014-12-14 18:04:50 +00:00
|
|
|
}
|
2014-12-05 21:14:55 +00:00
|
|
|
|
|
|
|
// backend is the interface the ethereum protocol backend should implement
|
|
|
|
// used as an argument to EthProtocol
|
2014-12-14 18:04:50 +00:00
|
|
|
type txPool interface {
|
2014-12-09 23:55:50 +00:00
|
|
|
AddTransactions([]*types.Transaction)
|
2014-12-14 18:04:50 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
type chainManager interface {
|
|
|
|
GetBlockHashesFromHash(hash []byte, amount uint64) (hashes [][]byte)
|
2014-12-05 21:14:55 +00:00
|
|
|
GetBlock(hash []byte) (block *types.Block)
|
|
|
|
Status() (td *big.Int, currentBlock []byte, genesisBlock []byte)
|
|
|
|
}
|
|
|
|
|
2014-12-14 18:04:50 +00:00
|
|
|
type blockPool interface {
|
|
|
|
AddBlockHashes(next func() ([]byte, bool), peerId string)
|
|
|
|
AddBlock(block *types.Block, peerId string)
|
|
|
|
AddPeer(td *big.Int, currentBlock []byte, peerId string, requestHashes func([]byte) error, requestBlocks func([][]byte) error, peerError func(int, string, ...interface{})) (best bool)
|
|
|
|
RemovePeer(peerId string)
|
|
|
|
}
|
|
|
|
|
2014-12-05 21:14:55 +00:00
|
|
|
const (
|
2014-12-09 23:55:50 +00:00
|
|
|
ProtocolVersion = 43
|
2014-12-05 21:14:55 +00:00
|
|
|
NetworkId = 0
|
|
|
|
ProtocolLength = uint64(8)
|
|
|
|
ProtocolMaxMsgSize = 10 * 1024 * 1024
|
|
|
|
)
|
|
|
|
|
|
|
|
// eth protocol message codes
|
|
|
|
const (
|
|
|
|
StatusMsg = iota
|
|
|
|
GetTxMsg // unused
|
|
|
|
TxMsg
|
|
|
|
GetBlockHashesMsg
|
|
|
|
BlockHashesMsg
|
|
|
|
GetBlocksMsg
|
|
|
|
BlocksMsg
|
|
|
|
NewBlockMsg
|
|
|
|
)
|
|
|
|
|
|
|
|
// message structs used for rlp decoding
|
|
|
|
type newBlockMsgData struct {
|
|
|
|
Block *types.Block
|
|
|
|
TD *big.Int
|
|
|
|
}
|
|
|
|
|
|
|
|
type getBlockHashesMsgData struct {
|
|
|
|
Hash []byte
|
2014-12-14 18:04:50 +00:00
|
|
|
Amount uint64
|
2014-12-05 21:14:55 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// main entrypoint, wrappers starting a server running the eth protocol
|
2014-12-09 23:55:50 +00:00
|
|
|
// use this constructor to attach the protocol ("class") to server caps
|
|
|
|
// the Dev p2p layer then runs the protocol instance on each peer
|
2014-12-14 18:04:50 +00:00
|
|
|
func EthProtocol(txPool txPool, chainManager chainManager, blockPool blockPool) p2p.Protocol {
|
|
|
|
return p2p.Protocol{
|
2014-12-05 21:14:55 +00:00
|
|
|
Name: "eth",
|
|
|
|
Version: ProtocolVersion,
|
|
|
|
Length: ProtocolLength,
|
|
|
|
Run: func(peer *p2p.Peer, rw p2p.MsgReadWriter) error {
|
2014-12-14 18:04:50 +00:00
|
|
|
return runEthProtocol(txPool, chainManager, blockPool, peer, rw)
|
2014-12-05 21:14:55 +00:00
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-12-09 23:55:50 +00:00
|
|
|
// the main loop that handles incoming messages
|
|
|
|
// note RemovePeer in the post-disconnect hook
|
2014-12-14 18:04:50 +00:00
|
|
|
func runEthProtocol(txPool txPool, chainManager chainManager, blockPool blockPool, peer *p2p.Peer, rw p2p.MsgReadWriter) (err error) {
|
2014-12-14 18:04:50 +00:00
|
|
|
self := ðProtocol{
|
|
|
|
txPool: txPool,
|
|
|
|
chainManager: chainManager,
|
|
|
|
blockPool: blockPool,
|
|
|
|
rw: rw,
|
|
|
|
peer: peer,
|
|
|
|
id: (string)(peer.Identity().Pubkey()),
|
2014-12-05 21:14:55 +00:00
|
|
|
}
|
|
|
|
err = self.handleStatus()
|
|
|
|
if err == nil {
|
|
|
|
go func() {
|
|
|
|
for {
|
|
|
|
err = self.handle()
|
|
|
|
if err != nil {
|
2014-12-14 18:04:50 +00:00
|
|
|
self.blockPool.RemovePeer(self.id)
|
2014-12-05 21:14:55 +00:00
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}()
|
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
func (self *ethProtocol) handle() error {
|
|
|
|
msg, err := self.rw.ReadMsg()
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if msg.Size > ProtocolMaxMsgSize {
|
|
|
|
return ProtocolError(ErrMsgTooLarge, "%v > %v", msg.Size, ProtocolMaxMsgSize)
|
|
|
|
}
|
|
|
|
// make sure that the payload has been fully consumed
|
|
|
|
defer msg.Discard()
|
|
|
|
|
|
|
|
switch msg.Code {
|
|
|
|
|
|
|
|
case StatusMsg:
|
|
|
|
return ProtocolError(ErrExtraStatusMsg, "")
|
|
|
|
|
2014-12-05 21:14:55 +00:00
|
|
|
case TxMsg:
|
2014-12-09 23:55:50 +00:00
|
|
|
// TODO: rework using lazy RLP stream
|
2014-12-05 21:14:55 +00:00
|
|
|
var txs []*types.Transaction
|
|
|
|
if err := msg.Decode(&txs); err != nil {
|
|
|
|
return ProtocolError(ErrDecode, "%v", err)
|
|
|
|
}
|
2014-12-14 18:04:50 +00:00
|
|
|
self.txPool.AddTransactions(txs)
|
2014-12-05 21:14:55 +00:00
|
|
|
|
|
|
|
case GetBlockHashesMsg:
|
|
|
|
var request getBlockHashesMsgData
|
|
|
|
if err := msg.Decode(&request); err != nil {
|
|
|
|
return ProtocolError(ErrDecode, "%v", err)
|
|
|
|
}
|
2014-12-14 18:04:50 +00:00
|
|
|
hashes := self.chainManager.GetBlockHashesFromHash(request.Hash, request.Amount)
|
2014-12-05 21:14:55 +00:00
|
|
|
return self.rw.EncodeMsg(BlockHashesMsg, ethutil.ByteSliceToInterface(hashes)...)
|
|
|
|
|
|
|
|
case BlockHashesMsg:
|
|
|
|
// TODO: redo using lazy decode , this way very inefficient on known chains
|
2014-12-09 23:55:50 +00:00
|
|
|
msgStream := rlp.NewListStream(msg.Payload, uint64(msg.Size))
|
|
|
|
var err error
|
|
|
|
iter := func() (hash []byte, ok bool) {
|
|
|
|
hash, err = msgStream.Bytes()
|
|
|
|
if err == nil {
|
|
|
|
ok = true
|
2014-12-05 21:14:55 +00:00
|
|
|
}
|
2014-12-09 23:55:50 +00:00
|
|
|
return
|
2014-12-05 21:14:55 +00:00
|
|
|
}
|
2014-12-14 18:04:50 +00:00
|
|
|
self.blockPool.AddBlockHashes(iter, self.id)
|
2014-12-09 23:55:50 +00:00
|
|
|
if err != nil && err != rlp.EOL {
|
|
|
|
return ProtocolError(ErrDecode, "%v", err)
|
2014-12-05 21:14:55 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
case GetBlocksMsg:
|
|
|
|
var blockHashes [][]byte
|
|
|
|
if err := msg.Decode(&blockHashes); err != nil {
|
|
|
|
return ProtocolError(ErrDecode, "%v", err)
|
|
|
|
}
|
2014-12-09 23:55:50 +00:00
|
|
|
max := int(math.Min(float64(len(blockHashes)), blockHashesBatchSize))
|
2014-12-05 21:14:55 +00:00
|
|
|
var blocks []interface{}
|
|
|
|
for i, hash := range blockHashes {
|
|
|
|
if i >= max {
|
|
|
|
break
|
|
|
|
}
|
2014-12-14 18:04:50 +00:00
|
|
|
block := self.chainManager.GetBlock(hash)
|
2014-12-05 21:14:55 +00:00
|
|
|
if block != nil {
|
|
|
|
blocks = append(blocks, block.Value().Raw())
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return self.rw.EncodeMsg(BlocksMsg, blocks...)
|
|
|
|
|
|
|
|
case BlocksMsg:
|
2014-12-09 23:55:50 +00:00
|
|
|
msgStream := rlp.NewListStream(msg.Payload, uint64(msg.Size))
|
|
|
|
for {
|
|
|
|
var block *types.Block
|
|
|
|
if err := msgStream.Decode(&block); err != nil {
|
|
|
|
if err == rlp.EOL {
|
|
|
|
break
|
|
|
|
} else {
|
|
|
|
return ProtocolError(ErrDecode, "%v", err)
|
2014-12-05 21:14:55 +00:00
|
|
|
}
|
|
|
|
}
|
2014-12-14 18:04:50 +00:00
|
|
|
self.blockPool.AddBlock(block, self.id)
|
2014-12-05 21:14:55 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
case NewBlockMsg:
|
|
|
|
var request newBlockMsgData
|
|
|
|
if err := msg.Decode(&request); err != nil {
|
|
|
|
return ProtocolError(ErrDecode, "%v", err)
|
|
|
|
}
|
2014-12-09 23:55:50 +00:00
|
|
|
hash := request.Block.Hash()
|
|
|
|
// to simplify backend interface adding a new block
|
|
|
|
// uses AddPeer followed by AddHashes, AddBlock only if peer is the best peer
|
|
|
|
// (or selected as new best peer)
|
2014-12-14 18:04:50 +00:00
|
|
|
if self.blockPool.AddPeer(request.TD, hash, self.id, self.requestBlockHashes, self.requestBlocks, self.protoErrorDisconnect) {
|
2014-12-09 23:55:50 +00:00
|
|
|
called := true
|
|
|
|
iter := func() (hash []byte, ok bool) {
|
|
|
|
if called {
|
|
|
|
called = false
|
|
|
|
return hash, true
|
|
|
|
} else {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
}
|
2014-12-14 18:04:50 +00:00
|
|
|
self.blockPool.AddBlockHashes(iter, self.id)
|
|
|
|
self.blockPool.AddBlock(request.Block, self.id)
|
2014-12-05 21:14:55 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
default:
|
|
|
|
return ProtocolError(ErrInvalidMsgCode, "%v", msg.Code)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
type statusMsgData struct {
|
|
|
|
ProtocolVersion uint
|
|
|
|
NetworkId uint
|
|
|
|
TD *big.Int
|
|
|
|
CurrentBlock []byte
|
|
|
|
GenesisBlock []byte
|
|
|
|
}
|
|
|
|
|
|
|
|
func (self *ethProtocol) statusMsg() p2p.Msg {
|
2014-12-14 18:04:50 +00:00
|
|
|
td, currentBlock, genesisBlock := self.chainManager.Status()
|
2014-12-05 21:14:55 +00:00
|
|
|
|
|
|
|
return p2p.NewMsg(StatusMsg,
|
|
|
|
uint32(ProtocolVersion),
|
|
|
|
uint32(NetworkId),
|
|
|
|
td,
|
|
|
|
currentBlock,
|
|
|
|
genesisBlock,
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (self *ethProtocol) handleStatus() error {
|
|
|
|
// send precanned status message
|
|
|
|
if err := self.rw.WriteMsg(self.statusMsg()); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// read and handle remote status
|
|
|
|
msg, err := self.rw.ReadMsg()
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
if msg.Code != StatusMsg {
|
|
|
|
return ProtocolError(ErrNoStatusMsg, "first msg has code %x (!= %x)", msg.Code, StatusMsg)
|
|
|
|
}
|
|
|
|
|
|
|
|
if msg.Size > ProtocolMaxMsgSize {
|
|
|
|
return ProtocolError(ErrMsgTooLarge, "%v > %v", msg.Size, ProtocolMaxMsgSize)
|
|
|
|
}
|
|
|
|
|
|
|
|
var status statusMsgData
|
|
|
|
if err := msg.Decode(&status); err != nil {
|
|
|
|
return ProtocolError(ErrDecode, "%v", err)
|
|
|
|
}
|
|
|
|
|
2014-12-14 18:04:50 +00:00
|
|
|
_, _, genesisBlock := self.chainManager.Status()
|
2014-12-05 21:14:55 +00:00
|
|
|
|
|
|
|
if bytes.Compare(status.GenesisBlock, genesisBlock) != 0 {
|
|
|
|
return ProtocolError(ErrGenesisBlockMismatch, "%x (!= %x)", status.GenesisBlock, genesisBlock)
|
|
|
|
}
|
|
|
|
|
|
|
|
if status.NetworkId != NetworkId {
|
|
|
|
return ProtocolError(ErrNetworkIdMismatch, "%d (!= %d)", status.NetworkId, NetworkId)
|
|
|
|
}
|
|
|
|
|
|
|
|
if ProtocolVersion != status.ProtocolVersion {
|
|
|
|
return ProtocolError(ErrProtocolVersionMismatch, "%d (!= %d)", status.ProtocolVersion, ProtocolVersion)
|
|
|
|
}
|
|
|
|
|
2014-12-09 23:55:50 +00:00
|
|
|
self.peer.Infof("Peer is [eth] capable (%d/%d). TD = %v ~ %x", status.ProtocolVersion, status.NetworkId, status.CurrentBlock)
|
|
|
|
|
2014-12-14 18:04:50 +00:00
|
|
|
self.blockPool.AddPeer(status.TD, status.CurrentBlock, self.id, self.requestBlockHashes, self.requestBlocks, self.protoErrorDisconnect)
|
2014-12-05 21:14:55 +00:00
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2014-12-09 23:55:50 +00:00
|
|
|
func (self *ethProtocol) requestBlockHashes(from []byte) error {
|
|
|
|
self.peer.Debugf("fetching hashes (%d) %x...\n", blockHashesBatchSize, from[0:4])
|
|
|
|
return self.rw.EncodeMsg(GetBlockHashesMsg, from, blockHashesBatchSize)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (self *ethProtocol) requestBlocks(hashes [][]byte) error {
|
|
|
|
self.peer.Debugf("fetching %v blocks", len(hashes))
|
|
|
|
return self.rw.EncodeMsg(GetBlocksMsg, ethutil.ByteSliceToInterface(hashes))
|
|
|
|
}
|
|
|
|
|
|
|
|
func (self *ethProtocol) protoError(code int, format string, params ...interface{}) (err *protocolError) {
|
|
|
|
err = ProtocolError(code, format, params...)
|
|
|
|
if err.Fatal() {
|
|
|
|
self.peer.Errorln(err)
|
|
|
|
} else {
|
|
|
|
self.peer.Debugln(err)
|
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
2014-12-14 18:04:50 +00:00
|
|
|
|
|
|
|
func (self *ethProtocol) protoErrorDisconnect(code int, format string, params ...interface{}) {
|
|
|
|
err := ProtocolError(code, format, params...)
|
|
|
|
if err.Fatal() {
|
|
|
|
self.peer.Errorln(err)
|
|
|
|
// disconnect
|
|
|
|
} else {
|
|
|
|
self.peer.Debugln(err)
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|