provider

Documentation

Index

• Constants
• func NewChallenge(difficulty int, multiplier int) (Challenge, Verifier)
• type Challenge
• type Solution
• type Verifier
  • func (verifier Verifier) Verify(solution Solution) bool

Constants

const (

	// Suggested min difficulty
	DifficultyMin int = 10
	// Suggested max difficulty
	DifficultyMax int = 1000000
	// Suggested min multiplier
	MultiplierMin int = 10
	// Suggested max multiplier
	MultiplierMax int = 1000000
)

Functions

func NewChallenge

func NewChallenge(difficulty int, multiplier int) (Challenge, Verifier)

Generate a new challenge and the matching verifier

difficulty affects how much work both the server and the user have to do multiplier indicates the upper bound of how much more work the user has to do compared to the server

Types

type Challenge

type Challenge struct {
	Id         string `json:"id"`
	Query      []byte `json:"q"`
	Challenge  []byte `json:"c"`
	Difficulty int    `json:"d"`
}

The representation of a challenge to a user's browser

type Solution

type Solution struct {
	Id       string `json:"id"`
	Response []byte `json:"r"`
}

A solution to a Challenge

type Verifier

type Verifier struct {
	Id       string
	Expected []byte
}

A verifier to be stored by the server

func (Verifier) Verify

func (verifier Verifier) Verify(solution Solution) bool

Returns true if the solution is valid