gitlab.com/SkynetLabs/skyd@v1.6.9/skymodules/renter/hostdb/update.go

package hostdb

import (
	"time"

	"gitlab.com/NebulousLabs/errors"
	"gitlab.com/SkynetLabs/skyd/build"
	"gitlab.com/SkynetLabs/skyd/skymodules"
	"go.sia.tech/siad/modules"
	"go.sia.tech/siad/types"
)

// findHostAnnouncements returns a list of the host announcements found within
// a given block. No check is made to see that the ip address found in the
// announcement is actually a valid ip address.
func findHostAnnouncements(b types.Block) (announcements []skymodules.HostDBEntry) {
	for _, t := range b.Transactions {
		// the HostAnnouncement must be prefaced by the standard host
		// announcement string
		for _, arb := range t.ArbitraryData {
			addr, pubKey, err := modules.DecodeAnnouncement(arb)
			if err != nil {
				continue
			}

			// Add the announcement to the slice being returned.
			var host skymodules.HostDBEntry
			host.NetAddress = addr
			host.PublicKey = pubKey
			announcements = append(announcements, host)
		}
	}
	return
}

// insertBlockchainHost adds a host entry to the state. The host will be inserted
// into the set of all hosts, and if it is online and responding to requests it
// will be put into the list of active hosts.
func (hdb *HostDB) insertBlockchainHost(host skymodules.HostDBEntry) {
	// Remove garbage hosts and local hosts (but allow local hosts in testing).
	if err := host.NetAddress.IsValid(); err != nil {
		hdb.staticLog.Debugf("WARN: host '%v' has an invalid NetAddress: %v", host.NetAddress, err)
		return
	}
	// Ignore all local hosts announced through the blockchain.
	if build.Release == "standard" && host.NetAddress.IsLocal() {
		return
	}

	// Make sure the host gets into the host tree so it does not get dropped if
	// shutdown occurs before a scan can be performed.
	oldEntry, exists := hdb.staticHostTree.Select(host.PublicKey)
	if exists {
		// Replace the netaddress with the most recently announced netaddress.
		// Also replace the FirstSeen value with the current block height if
		// the first seen value has been set to zero (no hosts actually have a
		// first seen height of zero, but due to rescans hosts can end up with
		// a zero-value FirstSeen field.
		oldEntry.NetAddress = host.NetAddress
		if oldEntry.FirstSeen == 0 {
			oldEntry.FirstSeen = hdb.blockHeight
		}
		// Resolve the host's used subnets and update the timestamp if they
		// changed. We only update the timestamp if resolving the ipNets was
		// successful.
		ipNets, err := hdb.staticLookupIPNets(oldEntry.NetAddress)
		if err == nil && !equalIPNets(ipNets, oldEntry.IPNets) {
			oldEntry.IPNets = ipNets
			oldEntry.LastIPNetChange = time.Now()
		}
		// Modify hosttree
		err = hdb.modify(oldEntry)
		if errors.Contains(err, errHostDomainBlocked) {
			// Host is blocked, remove from the hosttree
			err = errors.AddContext(hdb.remove(oldEntry.PublicKey), "unable to remove blocked host from host tree")
		}
		if err != nil {
			hdb.staticLog.Println("ERROR: unable to modify host entry of host tree after a blockchain scan:", err)
		}
	} else {
		host.FirstSeen = hdb.blockHeight
		// Insert into hosttree
		err := hdb.insert(host)
		if errors.Contains(err, errHostDomainBlocked) {
			hdb.staticLog.Debugf("Could not insert host %v to the hostdb. Host domain blocked %v\n", host.PublicKey.String(), host.NetAddress)
		} else if err != nil {
			hdb.staticLog.Println("ERROR: unable to insert host entry into host tree after a blockchain scan:", err)
		}
	}

	// Add the host to the scan queue.
	hdb.queueScan(host)
}

// ProcessConsensusChange will be called by the consensus set every time there
// is a change in the blockchain. Updates will always be called in order.
func (hdb *HostDB) ProcessConsensusChange(cc modules.ConsensusChange) {
	hdb.mu.Lock()
	defer hdb.mu.Unlock()

	// Update the hostdb's understanding of the block height.
	for _, block := range cc.RevertedBlocks {
		// Only doing the block check if the height is above zero saves hashing
		// and saves a nontrivial amount of time during IBD.
		if hdb.blockHeight > 0 || block.ID() != types.GenesisID {
			hdb.blockHeight--
		} else if hdb.blockHeight != 0 {
			// Sanity check - if the current block is the genesis block, the
			// hostdb height should be set to zero.
			hdb.staticLog.Critical("Hostdb has detected a genesis block, but the height of the hostdb is set to ", hdb.blockHeight)
			hdb.blockHeight = 0
		}
	}
	for _, block := range cc.AppliedBlocks {
		// Only doing the block check if the height is above zero saves hashing
		// and saves a nontrivial amount of time during IBD.
		if hdb.blockHeight > 0 || block.ID() != types.GenesisID {
			hdb.blockHeight++
		} else if hdb.blockHeight != 0 {
			// Sanity check - if the current block is the genesis block, the
			// hostdb height should be set to zero.
			hdb.staticLog.Critical("Hostdb has detected a genesis block, but the height of the hostdb is set to ", hdb.blockHeight)
			hdb.blockHeight = 0
		}
	}

	// Add hosts announced in blocks that were applied.
	for _, block := range cc.AppliedBlocks {
		for _, host := range findHostAnnouncements(block) {
			hdb.staticLog.Debugln("Found a host in a host announcement:", host.NetAddress, host.PublicKey)
			hdb.insertBlockchainHost(host)
		}
	}

	hdb.synced = cc.Synced
	hdb.lastChange = cc.ID
}