keeper

package
v0.15.0-rc2 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2022 License: Apache-2.0 Imports: 42 Imported by: 0

Documentation

Overview

nolint

Index

Constants

This section is empty.

Variables

View Source 
var (
	ValPubKeys = simapp.CreateTestPubKeys(5)

	Addrs = []sdk.AccAddress{
		sdk.AccAddress(pubKeys[0].Address()),
		sdk.AccAddress(pubKeys[1].Address()),
		sdk.AccAddress(pubKeys[2].Address()),
		sdk.AccAddress(pubKeys[3].Address()),
		sdk.AccAddress(pubKeys[4].Address()),
	}

	ValAddrs = []sdk.ValAddress{
		sdk.ValAddress(pubKeys[0].Address()),
		sdk.ValAddress(pubKeys[1].Address()),
		sdk.ValAddress(pubKeys[2].Address()),
		sdk.ValAddress(pubKeys[3].Address()),
		sdk.ValAddress(pubKeys[4].Address()),
	}

	InitTokens = sdk.TokensFromConsensusPower(200, sdk.DefaultPowerReduction)
	InitCoins  = sdk.NewCoins(sdk.NewCoin(common.DenomNIBI, InitTokens))

	OracleDecPrecision = 8
)

Test addresses

View Source 
var ModuleBasics = module.NewBasicManager(
	auth.AppModuleBasic{},
	bank.AppModuleBasic{},
	distr.AppModuleBasic{},
	staking.AppModuleBasic{},
	params.AppModuleBasic{},
)

ModuleBasics nolint

Functions

func AllocateRewards added in v0.15.0 

func AllocateRewards(t *testing.T, input TestInput, pair string, rewards sdk.Coins, votePeriods uint64)

func FundAccount 

func FundAccount(input TestInput, addr sdk.AccAddress, amounts sdk.Coins) error

FundAccount is a utility function that funds an account by minting and sending the coins to the address. This should be used for testing purposes only!

func MakeEncodingConfig 

func MakeEncodingConfig(_ *testing.T) simparams.EncodingConfig

MakeEncodingConfig nolint

func MakeTestCodec 

func MakeTestCodec(t *testing.T) codec.Codec

MakeTestCodec nolint

func NewMsgServerImpl 

func NewMsgServerImpl(keeper Keeper) types.MsgServer

NewMsgServerImpl returns an implementation of the oracle MsgServer interface for the provided Keeper.

func NewQuerier 

func NewQuerier(keeper Keeper) types.QueryServer

NewQuerier returns an implementation of the oracle QueryServer interface for the provided Keeper.

func NewTestMsgCreateValidator 

func NewTestMsgCreateValidator(address sdk.ValAddress, pubKey cryptotypes.PubKey, amt sdk.Int) *stakingtypes.MsgCreateValidator

NewTestMsgCreateValidator test msg creator

func RemoveInvalidBallots added in v0.15.0 

func RemoveInvalidBallots(ctx sdk.Context, k Keeper, voteTargets map[string]struct{}, voteMap map[string]types.ExchangeRateBallot)

RemoveInvalidBallots removes the ballots which have not reached the vote threshold or which are not part of the vote targets anymore: example when params change during a vote period but some votes were already made.

func Tally added in v0.14.0 

func Tally(_ sdk.Context, pb types.ExchangeRateBallot, rewardBand sdk.Dec, validatorClaimMap map[string]types.ValidatorPerformance) (weightedMedian sdk.Dec)

Tally calculates the median and returns it. Sets the set of voters to be rewarded, i.e. voted within a reasonable spread from the weighted median to the store CONTRACT: pb must be sorted

Types

type Keeper 

type Keeper struct {
	StakingKeeper types.StakingKeeper

	// TODO(mercilex): use asset pair
	ExchangeRates     collections.Map[string, sdk.Dec]
	FeederDelegations collections.Map[sdk.ValAddress, sdk.AccAddress]
	MissCounters      collections.Map[sdk.ValAddress, uint64]
	Prevotes          collections.Map[sdk.ValAddress, types.AggregateExchangeRatePrevote]
	Votes             collections.Map[sdk.ValAddress, types.AggregateExchangeRateVote]
	// TODO(mercilex): use asset pair
	Pairs         collections.KeySet[string]
	PairRewards   collections.IndexedMap[uint64, types.PairReward, PairRewardsIndexes]
	PairRewardsID collections.Sequence
	// contains filtered or unexported fields
}

Keeper of the oracle store

func NewKeeper 

func NewKeeper(cdc codec.BinaryCodec, storeKey sdk.StoreKey,
	paramspace paramstypes.Subspace, accountKeeper types.AccountKeeper,
	bankKeeper types.BankKeeper, distrKeeper types.DistributionKeeper,
	stakingKeeper types.StakingKeeper, distrName string) Keeper

NewKeeper constructs a new keeper for oracle

func (Keeper) AccrueVotePeriodPairRewards added in v0.15.0 

func (k Keeper) AccrueVotePeriodPairRewards(ctx sdk.Context, pair string) sdk.Coins

AccrueVotePeriodPairRewards retrieves the vote period rewards for the provided pair. And decreases the distribution period count of each pair reward instance. If the distribution period count drops to 0: the reward instance is removed. TODO(mercilex): don't like API name

func (Keeper) AllocatePairRewards added in v0.15.0 

func (k Keeper) AllocatePairRewards(ctx sdk.Context, funderModule string, pair string, totalCoins sdk.Coins, votePeriods uint64) error

func (Keeper) ApplyWhitelist 

func (k Keeper) ApplyWhitelist(ctx sdk.Context, whitelist types.PairList, voteTargets map[string]struct{})

ApplyWhitelist updates the whitelist by detecting possible changes between the current vote targets and the current updated whitelist.

func (Keeper) ClearBallots 

func (k Keeper) ClearBallots(ctx sdk.Context, votePeriod uint64)

ClearBallots clears all tallied prevotes and votes from the store

func (Keeper) GetOracleAccount 

func (k Keeper) GetOracleAccount(ctx sdk.Context) authtypes.ModuleAccountI

GetOracleAccount returns oracle ModuleAccount

func (Keeper) GetParams 

func (k Keeper) GetParams(ctx sdk.Context) (params types.Params)

GetParams returns the total set of oracle parameters.

func (Keeper) GetVoteTargets 

func (k Keeper) GetVoteTargets(ctx sdk.Context) (voteTargets []string)

GetVoteTargets returns the voting target list on current vote period

func (Keeper) IsVoteTarget 

func (k Keeper) IsVoteTarget(ctx sdk.Context, pair string) bool

IsVoteTarget returns existence of a pair in the voting target list

func (Keeper) Logger 

func (k Keeper) Logger(ctx sdk.Context) log.Logger

Logger returns a module-specific logger.

func (Keeper) MinValidPerWindow 

func (k Keeper) MinValidPerWindow(ctx sdk.Context) (res sdk.Dec)

MinValidPerWindow returns oracle slashing threshold

func (Keeper) OrganizeBallotByPair 

func (k Keeper) OrganizeBallotByPair(ctx sdk.Context, validatorsPerformance map[string]types.ValidatorPerformance) (ballots map[string]types.ExchangeRateBallot)

OrganizeBallotByPair collects all oracle votes for the period, categorized by the votes' pair parameter

func (Keeper) RewardBallotWinners 

func (k Keeper) RewardBallotWinners(
	ctx sdk.Context,
	voteTargets map[string]struct{},
	ballotWinners map[string]types.ValidatorPerformance,
)

RewardBallotWinners implements at the end of every VotePeriod, give out a portion of spread fees collected in the oracle reward pool to the oracle voters that voted faithfully.

func (Keeper) RewardBand 

func (k Keeper) RewardBand(ctx sdk.Context) (res sdk.Dec)

RewardBand returns the ratio of allowable exchange rate error that a validator can be rewared

func (Keeper) SetParams 

func (k Keeper) SetParams(ctx sdk.Context, params types.Params)

SetParams sets the total set of oracle parameters.

func (Keeper) SetWhitelist 

func (k Keeper) SetWhitelist(ctx sdk.Context, whitelist types.PairList)

SetWhitelist store new whitelist to param store this function is only for test purpose

func (Keeper) SlashAndResetMissCounters 

func (k Keeper) SlashAndResetMissCounters(ctx sdk.Context)

SlashAndResetMissCounters do slash any operator who over criteria & clear all operators miss counter to zero

func (Keeper) SlashFraction 

func (k Keeper) SlashFraction(ctx sdk.Context) (res sdk.Dec)

SlashFraction returns oracle voting penalty rate

func (Keeper) SlashWindow 

func (k Keeper) SlashWindow(ctx sdk.Context) (res uint64)

SlashWindow returns # of vote period for oracle slashing

func (Keeper) UpdateExchangeRates added in v0.14.0 

func (k Keeper) UpdateExchangeRates(ctx sdk.Context)

func (Keeper) ValidateFeeder 

func (k Keeper) ValidateFeeder(ctx sdk.Context, feederAddr sdk.AccAddress, validatorAddr sdk.ValAddress) error

ValidateFeeder return the given feeder is allowed to feed the message or not

func (Keeper) VotePeriod 

func (k Keeper) VotePeriod(ctx sdk.Context) (res uint64)

VotePeriod returns the number of blocks during which voting takes place.

func (Keeper) VoteThreshold 

func (k Keeper) VoteThreshold(ctx sdk.Context) (res sdk.Dec)

VoteThreshold returns the minimum percentage of votes that must be received for a ballot to pass.

func (Keeper) Whitelist 

func (k Keeper) Whitelist(ctx sdk.Context) (res types.PairList)

Whitelist returns the pair list that can be activated

type PairRewardsIndexes added in v0.15.0 

type PairRewardsIndexes struct {
	// RewardsByPair is the index that maps rewards associated with specific pairs.
	RewardsByPair collections.MultiIndex[string, uint64, types.PairReward]
}

func (PairRewardsIndexes) IndexerList added in v0.15.0 

func (p PairRewardsIndexes) IndexerList() []collections.Indexer[uint64, types.PairReward]

type TestInput 

type TestInput struct {
	Ctx           sdk.Context
	Cdc           *codec.LegacyAmino
	AccountKeeper authkeeper.AccountKeeper
	BankKeeper    bankkeeper.Keeper
	OracleKeeper  Keeper
	StakingKeeper stakingkeeper.Keeper
	DistrKeeper   distrkeeper.Keeper
}

TestInput nolint

func CreateTestInput 

func CreateTestInput(t *testing.T) TestInput

CreateTestInput nolint Creates a base app, with 5 accounts,

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.