provideroptimizer

Documentation

Index

• Constants
• Variables
• func CumulativeProbabilityFunctionForPoissonDist(k_events uint64, lambda float64) float64
• type ConcurrentBlockStore
• type Entry
• type Exploration
• type ProviderData
• type ProviderOptimizer
  • func NewProviderOptimizer(strategy Strategy, averageBlockTIme, baseWorldLatency time.Duration, ...) *ProviderOptimizer
  • func (po *ProviderOptimizer) AppendProbeRelayData(providerAddress string, latency time.Duration, success bool)
  • func (po *ProviderOptimizer) AppendRelayData(providerAddress string, latency time.Duration, isHangingApi bool, ...)
  • func (po *ProviderOptimizer) AppendRelayFailure(providerAddress string)
  • func (po *ProviderOptimizer) CalculateProbabilityOfBlockError(requestedBlock int64, providerData ProviderData) float64
  • func (po *ProviderOptimizer) CalculateProbabilityOfTimeout(availabilityScore score.ScoreStore) float64
  • func (po *ProviderOptimizer) CalculateQoSScoresForMetrics(allAddresses []string, ignoredProviders map[string]struct{}, cu uint64, ...) []*metrics.OptimizerQoSReport
  • func (po *ProviderOptimizer) CalculateSelectionTiers(allAddresses []string, ignoredProviders map[string]struct{}, cu uint64, ...) (SelectionTier, Exploration, map[string]*metrics.OptimizerQoSReport)
  • func (po *ProviderOptimizer) ChooseProvider(allAddresses []string, ignoredProviders map[string]struct{}, cu uint64, ...) (addresses []string, tier int)
  • func (po *ProviderOptimizer) GetExcellenceQoSReportForProvider(providerAddress string) (qosReport *pairingtypes.QualityOfServiceReport, ...)
  • func (po *ProviderOptimizer) Strategy() Strategy
  • func (po *ProviderOptimizer) UpdateWeights(weights map[string]int64, epoch uint64)
• type SelectionTier
  • func NewSelectionTier() SelectionTier
• type SelectionTierInst
  • func (st *SelectionTierInst) AddScore(entry string, score float64)
  • func (st *SelectionTierInst) GetRawScores() []Entry
  • func (st *SelectionTierInst) GetTier(tier int, numTiers int, minimumEntries int) []Entry
  • func (st *SelectionTierInst) ScoresCount() int
  • func (st *SelectionTierInst) SelectTierRandomly(numTiers int, tierChances map[int]float64) int
  • func (st *SelectionTierInst) ShiftTierChance(numTiers int, initialTierChances map[int]float64) map[int]float64
• type SelectionWeighter
  • func NewSelectionWeighter() SelectionWeighter
• type Strategy

Constants

const (
	CacheMaxCost               = 20000 // each item cost would be 1
	CacheNumCounters           = 20000 // expect 2000 items
	INITIAL_DATA_STALENESS     = 24
	HALF_LIFE_TIME             = time.Hour
	MAX_HALF_TIME              = 3 * time.Hour
	PROBE_UPDATE_WEIGHT        = 0.25
	RELAY_UPDATE_WEIGHT        = 1
	DEFAULT_EXPLORATION_CHANCE = 0.1
	COST_EXPLORATION_CHANCE    = 0.01
	WANTED_PRECISION           = int64(8)
)

Variables

var (
	OptimizerNumTiers = 4
	MinimumEntries    = 5
	ATierChance       = 0.75
	LastTierChance    = 0.0
)

Functions

func CumulativeProbabilityFunctionForPoissonDist

func CumulativeProbabilityFunctionForPoissonDist(k_events uint64, lambda float64) float64

Types

type ConcurrentBlockStore

type ConcurrentBlockStore struct {
	Lock  sync.Mutex
	Time  time.Time
	Block uint64
}

type Entry

type Entry struct {
	Address string
	Score   float64
	Part    float64
}

type Exploration

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

type ProviderData

type ProviderData struct {
	Availability score.ScoreStore // will be used to calculate the probability of error
	Latency      score.ScoreStore // will be used to calculate the latency score
	Sync         score.ScoreStore // will be used to calculate the sync score for spectypes.LATEST_BLOCK/spectypes.NOT_APPLICABLE requests
	SyncBlock    uint64           // will be used to calculate the probability of block error
	LatencyRaw   score.ScoreStore // will be used when reporting reputation to the node (Latency = LatencyRaw / baseLatency)
	SyncRaw      score.ScoreStore // will be used when reporting reputation to the node (Sync = SyncRaw / baseSync)
}

type ProviderOptimizer

type ProviderOptimizer struct {
	OptimizerNumTiers int
	// contains filtered or unexported fields
}

func NewProviderOptimizer

func NewProviderOptimizer(strategy Strategy, averageBlockTIme, baseWorldLatency time.Duration, wantedNumProvidersInConcurrency uint, consumerOptimizerQoSClientInf consumerOptimizerQoSClientInf, chainId string) *ProviderOptimizer

func (*ProviderOptimizer) AppendProbeRelayData

func (po *ProviderOptimizer) AppendProbeRelayData(providerAddress string, latency time.Duration, success bool)

func (*ProviderOptimizer) AppendRelayData

func (po *ProviderOptimizer) AppendRelayData(providerAddress string, latency time.Duration, isHangingApi bool, cu, syncBlock uint64)

func (*ProviderOptimizer) AppendRelayFailure

func (po *ProviderOptimizer) AppendRelayFailure(providerAddress string)

func (*ProviderOptimizer) CalculateProbabilityOfBlockError

func (po *ProviderOptimizer) CalculateProbabilityOfBlockError(requestedBlock int64, providerData ProviderData) float64

func (*ProviderOptimizer) CalculateProbabilityOfTimeout

func (po *ProviderOptimizer) CalculateProbabilityOfTimeout(availabilityScore score.ScoreStore) float64

func (*ProviderOptimizer) CalculateQoSScoresForMetrics

func (po *ProviderOptimizer) CalculateQoSScoresForMetrics(allAddresses []string, ignoredProviders map[string]struct{}, cu uint64, requestedBlock int64) []*metrics.OptimizerQoSReport

func (*ProviderOptimizer) CalculateSelectionTiers

func (po *ProviderOptimizer) CalculateSelectionTiers(allAddresses []string, ignoredProviders map[string]struct{}, cu uint64, requestedBlock int64) (SelectionTier, Exploration, map[string]*metrics.OptimizerQoSReport)

func (*ProviderOptimizer) ChooseProvider

func (po *ProviderOptimizer) ChooseProvider(allAddresses []string, ignoredProviders map[string]struct{}, cu uint64, requestedBlock int64) (addresses []string, tier int)

returns a sub set of selected providers according to their scores, perturbation factor will be added to each score in order to randomly select providers that are not always on top

func (*ProviderOptimizer) GetExcellenceQoSReportForProvider

func (po *ProviderOptimizer) GetExcellenceQoSReportForProvider(providerAddress string) (qosReport *pairingtypes.QualityOfServiceReport, rawQosReport *pairingtypes.QualityOfServiceReport)

func (*ProviderOptimizer) Strategy

func (po *ProviderOptimizer) Strategy() Strategy

func (*ProviderOptimizer) UpdateWeights

func (po *ProviderOptimizer) UpdateWeights(weights map[string]int64, epoch uint64)

type SelectionTier

type SelectionTier interface {
	AddScore(entry string, score float64)
	GetTier(tier int, numTiers int, minimumEntries int) []Entry
	SelectTierRandomly(numTiers int, tierChances map[int]float64) int
	ShiftTierChance(numTiers int, initialYierChances map[int]float64) map[int]float64
	ScoresCount() int
	GetRawScores() []Entry
}

selectionTier is a utility to get a tier of addresses based on their scores

func NewSelectionTier

func NewSelectionTier() SelectionTier

type SelectionTierInst

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

func (*SelectionTierInst) AddScore

func (st *SelectionTierInst) AddScore(entry string, score float64)

func (*SelectionTierInst) GetRawScores

func (st *SelectionTierInst) GetRawScores() []Entry

func (*SelectionTierInst) GetTier

func (st *SelectionTierInst) GetTier(tier int, numTiers int, minimumEntries int) []Entry

func (*SelectionTierInst) ScoresCount

func (st *SelectionTierInst) ScoresCount() int

func (*SelectionTierInst) SelectTierRandomly

func (st *SelectionTierInst) SelectTierRandomly(numTiers int, tierChances map[int]float64) int

func (*SelectionTierInst) ShiftTierChance

func (st *SelectionTierInst) ShiftTierChance(numTiers int, initialTierChances map[int]float64) map[int]float64

type SelectionWeighter

type SelectionWeighter interface {
	Weight(address string) int64
	SetWeights(weights map[string]int64)
	WeightedChoice(possibilities []Entry) string
}

SelectionWeighter is a utility to select an address based on a weight.

func NewSelectionWeighter

func NewSelectionWeighter() SelectionWeighter

type Strategy

type Strategy int

const (
	STRATEGY_BALANCED Strategy = iota
	STRATEGY_LATENCY
	STRATEGY_SYNC_FRESHNESS
	STRATEGY_COST
	STRATEGY_PRIVACY
	STRATEGY_ACCURACY
	STRATEGY_DISTRIBUTED
)