host

Documentation

Index

• Constants
• Variables
• type Host
  • func New(cs *consensus.State, tpool modules.TransactionPool, wallet modules.Wallet, ...) (h *Host, err error)
  • func (h *Host) Address() modules.NetAddress
  • func (h *Host) Announce() error
  • func (h *Host) HostNotify() <-chan struct{}
  • func (h *Host) Info() modules.HostInfo
  • func (h *Host) ReceiveConsensusSetUpdate(revertedBlocks []types.Block, appliedBlocks []types.Block)
  • func (h *Host) SetSettings(settings modules.HostSettings)
  • func (h *Host) Settings() modules.HostSettings

Constants

const (
	// StorageProofReorgDepth states how many blocks to wait before submitting
	// a storage proof. This reduces the chance of needing to resubmit because
	// of a reorg.
	StorageProofReorgDepth = 20
)

Variables

var (
	HostCapacityErr = errors.New("host is at capacity and can not take more files")
)

Types

type Host

type Host struct {
	modules.HostSettings
	// contains filtered or unexported fields
}

A Host contains all the fields necessary for storing files for clients and performing the storage proofs on the received files.

func New

func New(cs *consensus.State, tpool modules.TransactionPool, wallet modules.Wallet, addr string, saveDir string) (h *Host, err error)

New returns an initialized Host.

func (*Host) Address

func (h *Host) Address() modules.NetAddress

func (*Host) Announce

func (h *Host) Announce() error

Announce creates a host announcement transaction, adding information to the arbitrary data, signing the transaction, and submitting it to the transaction pool.

func (*Host) HostNotify

func (h *Host) HostNotify() <-chan struct{}

HostNotify returns a channel that will be sent a struct{} every time there is an update received from another module.

func (*Host) Info

func (h *Host) Info() modules.HostInfo

func (*Host) ReceiveConsensusSetUpdate

func (h *Host) ReceiveConsensusSetUpdate(revertedBlocks []types.Block, appliedBlocks []types.Block)

RecieveConsensusSetUpdate will be called by the consensus set every time there is a new block or a fork of some kind.

func (*Host) SetSettings

func (h *Host) SetSettings(settings modules.HostSettings)

SetConfig updates the host's internal HostSettings object. To modify a specific field, use a combination of Info and SetConfig

func (*Host) Settings

func (h *Host) Settings() modules.HostSettings

Settings returns the settings of a host.