pow

Documentation

Index

• Constants
• Variables
• func DoPOW(msg []byte) (uint64, error)
• func Plugin() *node.Plugin
• func Tune(d int)
• func Worker() *pow.Worker
• type PowDoneEvent
• type PowEvents
  • func Events() *PowEvents

Constants

const (
	// CfgPOWDifficulty defines the config flag of the PoW difficulty.
	CfgPOWDifficulty = "pow.difficulty"
	// CfgPOWNumThreads defines the config flag of the number of threads used to do the PoW.
	CfgPOWNumThreads = "pow.numThreads"
	// CfgPOWTimeout defines the config flag for the PoW timeout.
	CfgPOWTimeout = "pow.timeout"
)

const PluginName = "PoW"

PluginName is the name of the PoW plugin.

Variables

var (
	// ErrMessageTooSmall is returned when the message is smaller than the 8-byte nonce.
	ErrMessageTooSmall = errors.New("message too small")
)

Functions

func DoPOW

func DoPOW(msg []byte) (uint64, error)

DoPOW performs the PoW on the provided msg and returns the nonce.

func Plugin

func Plugin() *node.Plugin

Plugin gets the plugin instance.

func Tune

func Tune(d int)

Tune changes pow difficulty at runtime.

func Worker

func Worker() *pow.Worker

Worker returns the PoW worker instance of the PoW plugin.

Types

type PowDoneEvent

type PowDoneEvent struct {
	Difficulty int
	Duration   time.Duration
}

PowDoneEvent is used to pass information through a PowDone event.

type PowEvents

type PowEvents struct {
	// PowDone defines the pow done event.
	PowDone *events.Event
}

func Events

func Events() *PowEvents

Events returns the pow events.