core-chain/eth/handler_diff.go

// Copyright 2020 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 eth

import (
	"fmt"

	"github.com/ethereum/go-ethereum/core"
	"github.com/ethereum/go-ethereum/eth/protocols/diff"
	"github.com/ethereum/go-ethereum/p2p/enode"
)

// diffHandler implements the diff.Backend interface to handle the various network
// packets that are sent as replies or broadcasts.
type diffHandler handler

func (h *diffHandler) Chain() *core.BlockChain { return h.chain }

// RunPeer is invoked when a peer joins on the `diff` protocol.
func (h *diffHandler) RunPeer(peer *diff.Peer, hand diff.Handler) error {
	if err := peer.Handshake(h.diffSync); err != nil {
		// ensure that waitDiffExtension receives the exit signal normally
		// otherwise, can't graceful shutdown
		ps := h.peers
		id := peer.ID()

		// Ensure nobody can double connect
		ps.lock.Lock()
		if wait, ok := ps.diffWait[id]; ok {
			delete(ps.diffWait, id)
			wait <- peer
		}
		ps.lock.Unlock()
		return err
	}
	return (*handler)(h).runDiffExtension(peer, hand)
}

// PeerInfo retrieves all known `diff` information about a peer.
func (h *diffHandler) PeerInfo(id enode.ID) interface{} {
	if p := h.peers.peer(id.String()); p != nil && p.diffExt != nil {
		return p.diffExt.info()
	}
	return nil
}

// Handle is invoked from a peer's message handler when it receives a new remote
// message that the handler couldn't consume and serve itself.
func (h *diffHandler) Handle(peer *diff.Peer, packet diff.Packet) error {
	// DeliverSnapPacket is invoked from a peer's message handler when it transmits a
	// data packet for the local node to consume.
	switch packet := packet.(type) {
	case *diff.DiffLayersPacket:
		return h.handleDiffLayerPackage(packet, peer.ID(), false)

	case *diff.FullDiffLayersPacket:
		return h.handleDiffLayerPackage(&packet.DiffLayersPacket, peer.ID(), true)

	default:
		return fmt.Errorf("unexpected diff packet type: %T", packet)
	}
}

func (h *diffHandler) handleDiffLayerPackage(packet *diff.DiffLayersPacket, pid string, fulfilled bool) error {
	diffs, err := packet.Unpack()

	if err != nil {
		return err
	}
	for _, d := range diffs {
		if d != nil {
			if err := d.Validate(); err != nil {
				return err
			}
		}
	}
	for _, diff := range diffs {
		err := h.chain.HandleDiffLayer(diff, pid, fulfilled)
		if err != nil {
			return err
		}
	}
	return nil
}