progpow

package
v0.16.0-rc.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 13, 2023 License: GPL-3.0 Imports: 41 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ContextTimeFactor = big10
	ZoneBlockReward   = big.NewInt(5e+18)
	RegionBlockReward = new(big.Int).Mul(ZoneBlockReward, big3)
	PrimeBlockReward  = new(big.Int).Mul(RegionBlockReward, big3)
)

Progpow proof-of-work protocol constants.

View Source 
var ErrInvalidDumpMagic = errors.New("invalid dump magic")

Functions

func SeedHash 

func SeedHash(block uint64) []byte

SeedHash is the seed to use for generating a verification cache and the mining dataset.

Types

type API 

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

API exposes progpow related methods for the RPC interface.

func (*API) GetWork 

func (api *API) GetWork() ([4]string, error)

GetWork returns a work package for external miner.

The work package consists of 3 strings: 

result[0] - 32 bytes hex encoded current block header pow-hash
result[1] - 32 bytes hex encoded seed hash used for DAG
result[2] - 32 bytes hex encoded boundary condition ("target"), 2^256/difficulty
result[3] - hex encoded block number

func (*API) Gprogpowrate 

func (api *API) Gprogpowrate() uint64

Gprogpowrate returns the current hashrate for local CPU miner and remote miner.

func (*API) SubmitHashrate 

func (api *API) SubmitHashrate(rate hexutil.Uint64, id common.Hash) bool

SubmitHashrate can be used for remote miners to submit their hash rate. This enables the node to report the combined hash rate of all miners which submit work through this node.

It accepts the miner hash rate and an identifier which must be unique between nodes.

func (*API) SubmitWork 

func (api *API) SubmitWork(nonce types.BlockNonce, hash, digest common.Hash) bool

SubmitWork can be used by external miner to submit their POW solution. It returns an indication if the work was accepted. Note either an invalid solution, a stale work a non-existent work will return false.

type Config 

type Config struct {
	PowMode Mode

	CacheDir       string
	CachesInMem    int
	CachesOnDisk   int
	CachesLockMmap bool
	DurationLimit  *big.Int
	GasCeil        uint64

	// When set, notifications sent by the remote sealer will
	// be block header JSON objects instead of work package arrays.
	NotifyFull bool

	Log *log.Logger `toml:"-"`
}

Config are the configuration parameters of the progpow.

type Mode 

type Mode uint

Mode defines the type and amount of PoW verification a progpow engine makes. 

const (
	ModeNormal Mode = iota
	ModeShared
	ModeTest
	ModeFake
	ModeFullFake
)

type Progpow 

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

Progpow is a proof-of-work consensus engine using the blake3 hash algorithm

func New 

func New(config Config, notify []string, noverify bool) *Progpow

New creates a full sized progpow PoW scheme and starts a background thread for remote mining, also optionally notifying a batch of remote services of new work packages.

func NewFakeDelayer 

func NewFakeDelayer(delay time.Duration) *Progpow

NewFakeDelayer creates a progpow consensus engine with a fake PoW scheme that accepts all blocks as valid, but delays verifications by some time, though they still have to conform to the Quai consensus rules.

func NewFakeFailer 

func NewFakeFailer(fail uint64) *Progpow

NewFakeFailer creates a progpow consensus engine with a fake PoW scheme that accepts all blocks as valid apart from the single one specified, though they still have to conform to the Quai consensus rules.

func NewFaker 

func NewFaker() *Progpow

NewFaker creates a progpow consensus engine with a fake PoW scheme that accepts all blocks' seal as valid, though they still have to conform to the Quai consensus rules.

func NewFullFaker 

func NewFullFaker() *Progpow

NewFullFaker creates an progpow consensus engine with a full fake scheme that accepts all blocks as valid, without checking any consensus rules whatsoever.

func NewShared 

func NewShared() *Progpow

NewShared creates a full sized progpow PoW shared between all requesters running in the same process.

func NewTester 

func NewTester(notify []string, noverify bool) *Progpow

NewTester creates a small sized progpow PoW scheme useful only for testing purposes.

func (*Progpow) APIs 

func (progpow *Progpow) APIs(chain consensus.ChainHeaderReader) []rpc.API

APIs implements consensus.Engine, returning the user facing RPC APIs.

func (*Progpow) Author 

func (progpow *Progpow) Author(header *types.Header) (common.Address, error)

Author implements consensus.Engine, returning the header's coinbase as the proof-of-work verified author of the block.

func (*Progpow) CalcDifficulty 

func (progpow *Progpow) CalcDifficulty(chain consensus.ChainHeaderReader, parent *types.Header) *big.Int

CalcDifficulty is the difficulty adjustment algorithm. It returns the difficulty that a new block should have when created at time given the parent block's time and difficulty.

func (*Progpow) CalcOrder 

func (progpow *Progpow) CalcOrder(header *types.Header) (*big.Int, int, error)

CalcOrder returns the order of the block within the hierarchy of chains

func (*Progpow) Close 

func (progpow *Progpow) Close() error

Close closes the exit channel to notify all backend threads exiting.

func (*Progpow) ComputePowLight 

func (progpow *Progpow) ComputePowLight(header *types.Header) (mixHash, powHash common.Hash)

func (*Progpow) DeltaLogS 

func (progpow *Progpow) DeltaLogS(header *types.Header) *big.Int

func (*Progpow) Finalize 

func (progpow *Progpow) Finalize(chain consensus.ChainHeaderReader, header *types.Header, state *state.StateDB, txs []*types.Transaction, uncles []*types.Header)

Finalize implements consensus.Engine, accumulating the block and uncle rewards, setting the final state on the header

func (*Progpow) FinalizeAndAssemble 

func (progpow *Progpow) FinalizeAndAssemble(chain consensus.ChainHeaderReader, header *types.Header, state *state.StateDB, txs []*types.Transaction, uncles []*types.Header, etxs []*types.Transaction, subManifest types.BlockManifest, receipts []*types.Receipt) (*types.Block, error)

FinalizeAndAssemble implements consensus.Engine, accumulating the block and uncle rewards, setting the final state and assembling the block.

func (*Progpow) Hashrate 

func (progpow *Progpow) Hashrate() float64

Hashrate implements PoW, returning the measured rate of the search invocations per second over the last minute. Note the returned hashrate includes local hashrate, but also includes the total hashrate of all remote miner.

func (*Progpow) IntrinsicLogS 

func (progpow *Progpow) IntrinsicLogS(powHash common.Hash) *big.Int

IntrinsicLogS returns the logarithm of the intrinsic entropy reduction of a PoW hash

func (*Progpow) IsDomCoincident 

func (progpow *Progpow) IsDomCoincident(chain consensus.ChainHeaderReader, header *types.Header) bool

func (*Progpow) Prepare 

func (progpow *Progpow) Prepare(chain consensus.ChainHeaderReader, header *types.Header, parent *types.Header) error

Prepare implements consensus.Engine, initializing the difficulty field of a header to conform to the progpow protocol. The changes are done inline.

func (*Progpow) Seal 

func (progpow *Progpow) Seal(header *types.Header, results chan<- *types.Header, stop <-chan struct{}) error

Seal implements consensus.Engine, attempting to find a nonce that satisfies the header's difficulty requirements.

func (*Progpow) SetThreads 

func (progpow *Progpow) SetThreads(threads int)

SetThreads updates the number of mining threads currently enabled. Calling this method does not start mining, only sets the thread count. If zero is specified, the miner will use all cores of the machine. Setting a thread count below zero is allowed and will cause the miner to idle, without any work being done.

func (*Progpow) SubmitHashrate 

func (progpow *Progpow) SubmitHashrate(rate hexutil.Uint64, id common.Hash) bool

SubmitHashrate can be used for remote miners to submit their hash rate. This enables the node to report the combined hash rate of all miners which submit work through this node.

It accepts the miner hash rate and an identifier which must be unique between nodes.

func (*Progpow) Threads 

func (progpow *Progpow) Threads() int

Threads returns the number of mining threads currently enabled. This doesn't necessarily mean that mining is running!

func (*Progpow) TotalLogPhS 

func (progpow *Progpow) TotalLogPhS(header *types.Header) *big.Int

func (*Progpow) TotalLogS 

func (progpow *Progpow) TotalLogS(header *types.Header) *big.Int

TotalLogS() returns the total entropy reduction if the chain since genesis to the given header

func (*Progpow) VerifyHeader 

func (progpow *Progpow) VerifyHeader(chain consensus.ChainHeaderReader, header *types.Header) error

VerifyHeader checks whether a header conforms to the consensus rules of the stock Quai progpow engine.

func (*Progpow) VerifyHeaders 

func (progpow *Progpow) VerifyHeaders(chain consensus.ChainHeaderReader, headers []*types.Header) (chan<- struct{}, <-chan error)

VerifyHeaders is similar to VerifyHeader, but verifies a batch of headers concurrently. The method returns a quit channel to abort the operations and a results channel to retrieve the async verifications.

func (*Progpow) VerifyUncles 

func (progpow *Progpow) VerifyUncles(chain consensus.ChainReader, block *types.Block) error

VerifyUncles verifies that the given block's uncles conform to the consensus rules of the stock Quai progpow engine.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.