protocol

Documentation

Index

• Constants
• Variables
• func GetDifficultyFromHash(hashBz [RelayHasherSize]byte) int64
• func GetPathForProof(blockHash []byte, sessionId string) []byte
• func GetRelayHashFromBytes(relayBz []byte) (hash [RelayHasherSize]byte)
• func IsRelayVolumeApplicable(relayHash, targetHash []byte) bool

Constants

const (
	RelayHasherSize = sha256.Size
	TrieHasherSize  = sha256.Size
	TrieRootSize    = TrieHasherSize + trieRootMetadataSize
)

Variables

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

var (
	// BaseRelayDifficultyHashBz is the chosen "highest" (easiest) target hash, which
	// corresponds to the lowest possible difficulty.
	//
	// It effectively normalizes the difficulty number (which is returned by GetDifficultyFromHash)
	// by defining the hash which corresponds to the base difficulty.
	//
	// When this is the difficulty of a particular service, all relays are reward / volume applicable.
	//
	// 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
	BaseRelayDifficultyHashBz, _ = hex.DecodeString("ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff")
)

var (
	SmtSpec smt.TrieSpec
)

SMT specification used for the proof verification.

Functions

func GetDifficultyFromHash

func GetDifficultyFromHash(hashBz [RelayHasherSize]byte) int64

GetDifficultyFromHash returns the "difficulty" of the given hash, with respect to the "highest" (easiest) target hash, BaseRelayDifficultyHash. The resultant value is not used for any business logic but is simplify there to have a human-readable version of the hash. TODO_MAINNET: Can this cause an integer overflow?

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 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.

TODO_MAINNET: Devise a test that tries to attack the network and ensure that there is sufficient telemetry.