consensus

Documentation

Index

• type ConsensusValidator
  • func NewConsensusValidator(state stateInfoProvider, tm types.Time) (*ConsensusValidator, error)
  • func (cv *ConsensusValidator) RangeForGeneratingBalanceByHeight(height uint64) (uint64, uint64)
  • func (cv *ConsensusValidator) ValidateHeaders(headers []proto.BlockHeader, startHeight uint64) error
• type FairPosCalculatorV1
  • func (calc *FairPosCalculatorV1) CalculateBaseTarget(targetBlockDelaySeconds uint64, confirmedHeight uint64, confirmedTarget uint64, ...) (types.BaseTarget, error)
  • func (calc *FairPosCalculatorV1) CalculateDelay(hit *Hit, confirmedTarget types.BaseTarget, balance uint64) (uint64, error)
  • func (calc *FairPosCalculatorV1) HeightForHit(height uint64) uint64
• type FairPosCalculatorV2
  • func (calc *FairPosCalculatorV2) CalculateBaseTarget(targetBlockDelaySeconds uint64, confirmedHeight uint64, confirmedTarget uint64, ...) (types.BaseTarget, error)
  • func (calc *FairPosCalculatorV2) CalculateDelay(hit *Hit, confirmedTarget types.BaseTarget, balance uint64) (uint64, error)
  • func (calc *FairPosCalculatorV2) HeightForHit(height uint64) uint64
• type GenerationSignatureProvider
• type Hit
  • func GenHit(source []byte) (*Hit, error)
• type NXTGenerationSignatureProvider
  • func (p *NXTGenerationSignatureProvider) GenerationSignature(key [crypto.KeySize]byte, msg []byte) ([]byte, error)
  • func (p *NXTGenerationSignatureProvider) HitSource(key [crypto.KeySize]byte, msg []byte) ([]byte, error)
  • func (p *NXTGenerationSignatureProvider) VerifyGenerationSignature(pk crypto.PublicKey, msg, sig []byte) (bool, []byte, error)
• type NxtPosCalculator
  • func (calc *NxtPosCalculator) CalculateBaseTarget(targetBlockDelaySeconds uint64, prevHeight uint64, prevTarget uint64, ...) (types.BaseTarget, error)
  • func (calc *NxtPosCalculator) CalculateDelay(hit *Hit, parentTarget types.BaseTarget, balance uint64) (uint64, error)
  • func (calc *NxtPosCalculator) HeightForHit(height uint64) uint64
• type PosCalculator
• type VRFGenerationSignatureProvider
  • func (p *VRFGenerationSignatureProvider) GenerationSignature(key [crypto.KeySize]byte, msg []byte) ([]byte, error)
  • func (p *VRFGenerationSignatureProvider) HitSource(key [crypto.KeySize]byte, msg []byte) ([]byte, error)
  • func (p *VRFGenerationSignatureProvider) VerifyGenerationSignature(pk crypto.PublicKey, msg, sig []byte) (bool, []byte, error)

Types

type ConsensusValidator

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

func NewConsensusValidator

func NewConsensusValidator(state stateInfoProvider, tm types.Time) (*ConsensusValidator, error)

func (*ConsensusValidator) RangeForGeneratingBalanceByHeight

func (cv *ConsensusValidator) RangeForGeneratingBalanceByHeight(height uint64) (uint64, uint64)

func (*ConsensusValidator) ValidateHeaders

func (cv *ConsensusValidator) ValidateHeaders(headers []proto.BlockHeader, startHeight uint64) error

type FairPosCalculatorV1

type FairPosCalculatorV1 struct {
}

func (*FairPosCalculatorV1) CalculateBaseTarget

func (calc *FairPosCalculatorV1) CalculateBaseTarget(
	targetBlockDelaySeconds uint64,
	confirmedHeight uint64,
	confirmedTarget uint64,
	confirmedTimestamp uint64,
	greatGrandParentTimestamp uint64,
	applyingBlockTimestamp uint64,
) (types.BaseTarget, error)

func (*FairPosCalculatorV1) CalculateDelay

func (calc *FairPosCalculatorV1) CalculateDelay(hit *Hit, confirmedTarget types.BaseTarget, balance uint64) (uint64, error)

func (*FairPosCalculatorV1) HeightForHit

func (calc *FairPosCalculatorV1) HeightForHit(height uint64) uint64

type FairPosCalculatorV2

type FairPosCalculatorV2 struct {
}

func (*FairPosCalculatorV2) CalculateBaseTarget

func (calc *FairPosCalculatorV2) CalculateBaseTarget(
	targetBlockDelaySeconds uint64,
	confirmedHeight uint64,
	confirmedTarget uint64,
	confirmedTimestamp uint64,
	greatGrandParentTimestamp uint64,
	applyingBlockTimestamp uint64,
) (types.BaseTarget, error)

func (*FairPosCalculatorV2) CalculateDelay

func (calc *FairPosCalculatorV2) CalculateDelay(hit *Hit, confirmedTarget types.BaseTarget, balance uint64) (uint64, error)

func (*FairPosCalculatorV2) HeightForHit

func (calc *FairPosCalculatorV2) HeightForHit(height uint64) uint64

type GenerationSignatureProvider

type GenerationSignatureProvider interface {
	// GenerationSignature calculates generation signature from given message using secret or public key of block's generator.
	GenerationSignature(key [crypto.KeySize]byte, msg []byte) ([]byte, error)

	// HitSource calculates hit source bytes for given message and key.
	HitSource(key [crypto.KeySize]byte, msg []byte) ([]byte, error)

	// VerifyGenerationSignature checks that generation signature is valid for given message and generator's public key.
	// It returns verification result and error if any.
	VerifyGenerationSignature(pk crypto.PublicKey, msg, sig []byte) (bool, []byte, error)
}

type Hit

type Hit = big.Int

func GenHit

func GenHit(source []byte) (*Hit, error)

type NXTGenerationSignatureProvider

type NXTGenerationSignatureProvider struct {
}

NXTGenerationSignatureProvider implements the original NXT way to create generation signature using generator's public key and generation signature from the previous block.

func (*NXTGenerationSignatureProvider) GenerationSignature

func (p *NXTGenerationSignatureProvider) GenerationSignature(key [crypto.KeySize]byte, msg []byte) ([]byte, error)

Only generator's public key is used then building NXT generation signature.

func (*NXTGenerationSignatureProvider) HitSource

func (p *NXTGenerationSignatureProvider) HitSource(key [crypto.KeySize]byte, msg []byte) ([]byte, error)

func (*NXTGenerationSignatureProvider) VerifyGenerationSignature

func (p *NXTGenerationSignatureProvider) VerifyGenerationSignature(pk crypto.PublicKey, msg, sig []byte) (bool, []byte, error)

type NxtPosCalculator

type NxtPosCalculator struct {
}

func (*NxtPosCalculator) CalculateBaseTarget

func (calc *NxtPosCalculator) CalculateBaseTarget(
	targetBlockDelaySeconds uint64,
	prevHeight uint64,
	prevTarget uint64,
	parentTimestamp uint64,
	greatGrandParentTimestamp uint64,
	currentTimestamp uint64,
) (types.BaseTarget, error)

func (*NxtPosCalculator) CalculateDelay

func (calc *NxtPosCalculator) CalculateDelay(hit *Hit, parentTarget types.BaseTarget, balance uint64) (uint64, error)

func (*NxtPosCalculator) HeightForHit

func (calc *NxtPosCalculator) HeightForHit(height uint64) uint64

type PosCalculator

type PosCalculator interface {
	HeightForHit(height uint64) uint64
	CalculateBaseTarget(
		targetBlockDelaySeconds uint64,
		prevHeight uint64,
		prevTarget uint64,
		parentTimestamp uint64,
		greatGrandParentTimestamp uint64,
		currentTimestamp uint64,
	) (uint64, error)
	CalculateDelay(hit *big.Int, parentTarget, balance uint64) (uint64, error)
}

type VRFGenerationSignatureProvider

type VRFGenerationSignatureProvider struct {
}

VRFGenerationSignatureProvider implements generation of VRF pseudo-random value calculated from generation signature of previous block and generator's secret key.

func (*VRFGenerationSignatureProvider) GenerationSignature

func (p *VRFGenerationSignatureProvider) GenerationSignature(key [crypto.KeySize]byte, msg []byte) ([]byte, error)

func (*VRFGenerationSignatureProvider) HitSource

func (p *VRFGenerationSignatureProvider) HitSource(key [crypto.KeySize]byte, msg []byte) ([]byte, error)

func (*VRFGenerationSignatureProvider) VerifyGenerationSignature

func (p *VRFGenerationSignatureProvider) VerifyGenerationSignature(pk crypto.PublicKey, msg, sig []byte) (bool, []byte, error)

Verify checks that provided signature is valid against given generator's public key and message.