options.go

/*
 * Copyright (c) 2017-2020 The qitmeer developers
 */

package p2p

import (
	"crypto/ecdsa"
	"fmt"
	"github.com/Qitmeer/qitmeer/version"
	"github.com/libp2p/go-libp2p-peerstore/pstoreds"
	"net"
	"path"
	"time"

	ds "github.com/ipfs/go-ds-leveldb"
	"github.com/libp2p/go-libp2p"
	"github.com/libp2p/go-libp2p-noise"
	"github.com/libp2p/go-libp2p-secio"
	ma "github.com/multiformats/go-multiaddr"
)

var (
	// userAgentName is the user agent name and is used to help identify
	// ourselves to other peers.
	userAgentName = "qitmeer"

	// userAgentVersion is the user agent version and is used to help
	// identify ourselves to other peers.
	userAgentVersion = fmt.Sprintf("%d.%d.%d", version.Major, version.Minor,
		version.Patch)
)

const (
	// Period that we allocate each new peer before we mark them as valid
	// for trimming.
	gracePeriod = 2 * time.Minute
	// Buffer for the number of peers allowed to connect above max peers before the
	// connection manager begins trimming them.
	peerBuffer = 5
)

// buildOptions for the libp2p host.
func (s *Service) buildOptions(ip net.IP, priKey *ecdsa.PrivateKey) []libp2p.Option {
	cfg := s.cfg
	listen, err := multiAddressBuilder(ip.String(), cfg.TCPPort)
	if err != nil {
		log.Error(fmt.Sprintf("Failed to p2p listen: %v", err))
		return nil
	}
	options := []libp2p.Option{
		privKeyOption(priKey),
		libp2p.ListenAddrs(listen),
		libp2p.UserAgent(s.cfg.UserAgent),
		libp2p.ConnectionGater(s),
	}
	if s.cfg.EnableNoise {
		options = append(options, libp2p.Security(noise.ID, noise.New), libp2p.Security(secio.ID, secio.New))
	} else {
		options = append(options, libp2p.Security(secio.ID, secio.New))
	}
	if cfg.EnableUPnP {
		options = append(options, libp2p.NATPortMap()) //Allow to use UPnP
	}

	if len(cfg.RelayNodeAddr) > 0 ||
		len(cfg.HostAddress) > 0 ||
		len(cfg.HostDNS) > 0 {

		if len(cfg.RelayNodeAddr) > 0 {
			options = append(options, libp2p.EnableRelay())
		}

		options = append(options, libp2p.AddrsFactory(func(addrs []ma.Multiaddr) []ma.Multiaddr {
			if len(cfg.HostDNS) > 0 {
				external, err := ma.NewMultiaddr(fmt.Sprintf("/dns4/%s/tcp/%d", cfg.HostDNS, cfg.TCPPort))
				if err != nil {
					log.Error(fmt.Sprintf("Unable to create external multiaddress:%v", err))
				} else {
					addrs = append(addrs, external)
				}
			}
			if len(cfg.HostAddress) > 0 {
				external, err := multiAddressBuilder(cfg.HostAddress, cfg.TCPPort)
				if err != nil {
					log.Error(fmt.Sprintf("Unable to create external multiaddress:%v", err))
				} else {
					addrs = append(addrs, external)
				}
			}
			if len(cfg.RelayNodeAddr) > 0 {
				relayAddr, err := ma.NewMultiaddr(cfg.RelayNodeAddr + "/p2p-circuit")
				if err != nil {
					log.Error(fmt.Sprintf("Failed to create multiaddress for relay node: %v", err))
				} else {
					addrs = append(addrs, relayAddr)
				}
			}
			return addrs
		}))
	}

	if cfg.LocalIP != "" {
		if net.ParseIP(cfg.LocalIP) == nil {
			log.Error(fmt.Sprintf("Invalid local ip provided: %s", cfg.LocalIP))
			return options
		}
		listen, err = multiAddressBuilder(cfg.LocalIP, cfg.TCPPort)
		if err != nil {
			log.Error(fmt.Sprintf("Failed to p2p listen: %v", err))
			return nil
		}
		options = append(options, libp2p.ListenAddrs(listen))
	}

	dsPath := path.Join(s.cfg.DataDir, PeerStore)
	peerDS, err := ds.NewDatastore(dsPath, nil)
	if err != nil {
		log.Error(err.Error())
		return nil
	}
	log.Info(fmt.Sprintf("Start Peers from:%s", dsPath))

	ps, err := pstoreds.NewPeerstore(s.ctx, peerDS, pstoreds.DefaultOpts())
	if err != nil {
		log.Error(err.Error())
		return nil
	}
	options = append(options, libp2p.Peerstore(ps))

	return options
}

func multiAddressBuilder(ipAddr string, port uint) (ma.Multiaddr, error) {
	parsedIP := net.ParseIP(ipAddr)
	if parsedIP.To4() == nil && parsedIP.To16() == nil {
		return nil, fmt.Errorf("invalid ip address provided: %s", ipAddr)
	}
	if parsedIP.To4() != nil {
		return ma.NewMultiaddr(fmt.Sprintf("/ip4/%s/tcp/%d", ipAddr, port))
	}
	return ma.NewMultiaddr(fmt.Sprintf("/ip6/%s/tcp/%d", ipAddr, port))
}

// Adds a private key to the libp2p option if the option was provided.
// If the private key file is missing or cannot be read, or if the
// private key contents cannot be marshaled, an exception is thrown.
func privKeyOption(privkey *ecdsa.PrivateKey) libp2p.Option {
	return func(cfg *libp2p.Config) error {
		log.Debug("ECDSA private key generated")
		return cfg.Apply(libp2p.Identity(ConvertToInterfacePrivkey(privkey)))
	}
}