pow

package

v2.0.0-...-2cd5660 Latest Latest Go to latest Published: Apr 4, 2021 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/GalRogozinski/iota.go

Documentation ¶

Overview ¶

Package pow implements the Curl-based proof of work for arbitrary binary data.

Index ¶

Variables
func Score(msg []byte) float64
type Worker
- func New(numWorkers ...int) *Worker
- func (w *Worker) Mine(ctx context.Context, data []byte, targetScore float64) (uint64, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrCancelled = errors.New("canceled")
	ErrDone      = errors.New("done")
)

errors returned by the PoW

View Source

var Hash = crypto.BLAKE2b_256

Hash defines the hash function that is used to compute the PoW digest.

Functions ¶

func Score ¶

func Score(msg []byte) float64

Score returns the PoW score of msg.

Types ¶

type Worker ¶

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

The Worker performs the PoW.

func New ¶

func New(numWorkers ...int) *Worker

New creates a new PoW Worker. The optional numWorkers specifies how many go routines should be used to perform the PoW.

func (*Worker) Mine ¶

func (w *Worker) Mine(ctx context.Context, data []byte, targetScore float64) (uint64, error)

Mine performs the PoW for data. It returns a nonce that appended to data results in a PoW score of at least targetScore. The computation can be canceled anytime using ctx.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL