protocol

Documentation

Index

• Constants
• Variables
• func ComputeNewDifficultyTargetHash(prevTargetHash []byte, targetNumRelays, newRelaysEma uint64) []byte
• func GetPathForProof(blockHash []byte, sessionId string) []byte
• func GetRelayDifficultyMultiplier(relayDifficultyHash []byte) *big.Rat
• func GetRelayDifficultyMultiplierToFloat32(relayDifficultyHash []byte) float32
• func GetRelayDifficultyProbability(relayDifficultyHash []byte) *big.Rat
• func GetRelayHashFromBytes(relayBz []byte) (hash [RelayHasherSize]byte)
• func IsRelayVolumeApplicable(relayHash, targetHash []byte) bool
• func NewSMTSpec() *smt.TrieSpec
• func SMTValueHasher() smt.TrieSpecOption
• func ScaleRelayDifficultyHash(initialDifficultyHashBz []byte, difficultyScalingRatio *big.Rat) []byte

Constants

const (
	RelayHasherSize = sha256.Size
	TrieHasherSize  = sha256.Size
	TrieRootSize    = TrieHasherSize + trieRootMetadataSize
	TrieRootSumSize = 8 // TODO_CONSIDERATION: Export this from the SMT package.

)

Variables

var (
	NewRelayHasher = sha256.New
	NewTrieHasher  = sha256.New
)

var (
	// BaseRelayDifficultyHashBz is the chosen "highest" (easiest) target hash,
	// which corresponds to the lowest possible difficulty.
	//
	// In simple terms, it mean "every relay is a volume applicable relay".
	//
	// It other words, it is used to normalize all relay mining difficulties.
	//
	// Bitcoin uses a similar concept, where the target hash is defined as the hash:
	// - https://bitcoin.stackexchange.com/questions/107976/bitcoin-difficulty-why-leading-0s
	// - https://bitcoin.stackexchange.com/questions/121920/is-it-always-possible-to-find-a-number-whose-hash-starts-with-a-certain-number-o
	BaseRelayDifficultyHashHex   = "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" // all relays are payable
	BaseRelayDifficultyHashBz, _ = hex.DecodeString(BaseRelayDifficultyHashHex)
)

Functions

func ComputeNewDifficultyTargetHash

func ComputeNewDifficultyTargetHash(prevTargetHash []byte, targetNumRelays, newRelaysEma uint64) []byte

ComputeNewDifficultyTargetHash computes the new difficulty target hash based on the target number of relays we want the network to mine and the new EMA of the number of relays.

func GetPathForProof

func GetPathForProof(blockHash []byte, sessionId string) []byte

GetPathForProof computes the path to be used for proof validation by hashing the block hash and session id.

func GetRelayDifficultyMultiplier

func GetRelayDifficultyMultiplier(relayDifficultyHash []byte) *big.Rat

GetRelayDifficultyMultiplier returns the inverse of GetRelayDifficultyProbability to scale onchain volume applicable relays to estimated serviced offchain relays.

func GetRelayDifficultyMultiplierToFloat32

func GetRelayDifficultyMultiplierToFloat32(relayDifficultyHash []byte) float32

GetRelayDifficultyMultiplierToFloat32 returns a human readable integer representation of GetRelayDifficultyProbability. THIS IS TO BE USED FOR TELEMETRY PURPOSES ONLY. See the following discussing for why we're using a float32: https://github.com/pokt-network/poktroll/pull/771#discussion_r1761517063

func GetRelayDifficultyProbability

func GetRelayDifficultyProbability(relayDifficultyHash []byte) *big.Rat

GetRelayDifficultyProbability returns a fraction that determines the probability that a target (i.e. difficulty) hash is relative to the baseline.

func GetRelayHashFromBytes

func GetRelayHashFromBytes(relayBz []byte) (hash [RelayHasherSize]byte)

GetRelayHashFromBytes returns the hash of the relay (full, request or response) bytes. It is used as helper in the case that the relay is already marshaled and centralizes the hasher used.

func IsRelayVolumeApplicable

func IsRelayVolumeApplicable(relayHash, targetHash []byte) bool

IsRelayVolumeApplicable returns true if the relay IS reward / volume applicable. A relay is reward / volume applicable IFF its hash is less than the target hash.

• relayHash is the hash of the relay to be checked.
• targetHash is the hash of the relay difficulty target for a particular service.

func NewSMTSpec

func NewSMTSpec() *smt.TrieSpec

NewSMTSpec returns the SMT specification used for proof verification. A new hasher is created for each call to prevent concurrency issues from shared state.

func SMTValueHasher

func SMTValueHasher() smt.TrieSpecOption

func ScaleRelayDifficultyHash

func ScaleRelayDifficultyHash(
	initialDifficultyHashBz []byte,
	difficultyScalingRatio *big.Rat,
) []byte

ScaleRelayDifficultyHash scales the provided hash based on the given ratio. If the ratio is less than 1, the hash will be scaled down. DEV_NOTE: Only exposed publicly for testing purposes.