pow

Documentation

Index

• type Handler
  • func New(log *logger.Logger, targetScore float64, refreshTipsInterval time.Duration, ...) *Handler
  • func (h *Handler) Close()
  • func (h *Handler) DoPoW(msg *iotago.Message, shutdownSignal <-chan struct{}, parallelism int, ...) (err error)
  • func (h *Handler) GetPoWType() string
• type RefreshTipsFunc

Types

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

Handler handles PoW requests of the node and tunnels them to powsrv.io or uses local PoW if no API key was specified or the connection failed.

func New

func New(log *logger.Logger, targetScore float64, refreshTipsInterval time.Duration, powsrvAPIKey string, powsrvInitCooldown time.Duration) *Handler

New creates a new PoW handler instance. If the given powsrv.io API key is not empty, powsrv.io will be used to do proof-of-work.

func (*Handler) Close

func (h *Handler) Close()

Close closes the PoW handler

func (*Handler) DoPoW

func (h *Handler) DoPoW(msg *iotago.Message, shutdownSignal <-chan struct{}, parallelism int, refreshTipsFunc ...RefreshTipsFunc) (err error)

DoPoW does the proof-of-work required to hit the target score configured on this Handler. The given iota.Message's nonce is automatically updated. If a powsrv.io key was provided, then powsrv.io is used to commence the proof-of-work.

func (*Handler) GetPoWType

func (h *Handler) GetPoWType() string

GetPoWType returns the fastest available PoW type which gets used for PoW requests

type RefreshTipsFunc

type RefreshTipsFunc = func() (tips hornet.MessageIDs, err error)

RefreshTipsFunc refreshes tips of the message if PoW takes longer than a configured duration.