nip13

Documentation

Index

• Variables
• func Check(id string, minDifficulty int) error
• func CommittedDifficulty(event *nostr.Event) int
• func Difficulty(id string) int
• func DoWork(ctx context.Context, event nostr.Event, targetDifficulty int) (nostr.Tag, error)

Variables

var (
	ErrDifficultyTooLow = errors.New("nip13: insufficient difficulty")
	ErrGenerateTimeout  = errors.New("nip13: generating proof of work took too long")
	ErrMissingPubKey    = errors.New("nip13: attempting to work on an event without a pubkey, which makes no sense")
)

Functions

func Check

func Check(id string, minDifficulty int) error

Check reports whether the event ID demonstrates a sufficient proof of work difficulty. Note that Check performs no validation other than counting leading zero bits in an event ID. It is up to the callers to verify the event with other methods, such as nostr.Event.CheckSignature.

func CommittedDifficulty

func CommittedDifficulty(event *nostr.Event) int

CommittedDifficulty returns the Difficulty but checks the "nonce" tag for a target.

if the target is smaller than the actual difficulty then the value of the target is used. if the target is bigger than the actual difficulty then it returns 0.

func Difficulty

func Difficulty(id string) int

Difficulty counts the number of leading zero bits in an event ID.

func DoWork

func DoWork(ctx context.Context, event nostr.Event, targetDifficulty int) (nostr.Tag, error)

DoWork() performs work in multiple threads (given by runtime.NumCPU()) and returns the first nonce (as a nostr.Tag) that yields the required work. Returns an error if the context expires before that.