package kava.incentive.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the incentive Msg service.

• rpc ClaimUSDXMintingReward (MsgClaimUSDXMintingReward, MsgClaimUSDXMintingRewardResponse)

  tx.proto:11

  ClaimUSDXMintingReward is a message type used to claim USDX minting rewards

  message MsgClaimUSDXMintingReward

  tx.proto:40

  MsgClaimUSDXMintingReward message type used to claim USDX minting rewards

  • string sender = 1

  • string multiplier_name = 2

  message MsgClaimUSDXMintingRewardResponse

  tx.proto:49

  MsgClaimUSDXMintingRewardResponse defines the Msg/ClaimUSDXMintingReward response type.

  (message has no fields)

• rpc ClaimHardReward (MsgClaimHardReward, MsgClaimHardRewardResponse)

  tx.proto:14

  ClaimHardReward is a message type used to claim Hard liquidity provider rewards

  message MsgClaimHardReward

  tx.proto:52

  MsgClaimHardReward message type used to claim Hard liquidity provider rewards

  • string sender = 1

  • repeated Selection denoms_to_claim = 2

  message MsgClaimHardRewardResponse

  tx.proto:64

  MsgClaimHardRewardResponse defines the Msg/ClaimHardReward response type.

  (message has no fields)

• rpc ClaimDelegatorReward (MsgClaimDelegatorReward, MsgClaimDelegatorRewardResponse)

  tx.proto:17

  ClaimDelegatorReward is a message type used to claim delegator rewards

  message MsgClaimDelegatorReward

  tx.proto:67

  MsgClaimDelegatorReward message type used to claim delegator rewards

  • string sender = 1

  • repeated Selection denoms_to_claim = 2

  message MsgClaimDelegatorRewardResponse

  tx.proto:79

  MsgClaimDelegatorRewardResponse defines the Msg/ClaimDelegatorReward response type.

  (message has no fields)

• rpc ClaimSwapReward (MsgClaimSwapReward, MsgClaimSwapRewardResponse)

  tx.proto:20

  ClaimSwapReward is a message type used to claim swap rewards

  message MsgClaimSwapReward

  tx.proto:82

  MsgClaimSwapReward message type used to claim delegator rewards

  • string sender = 1

  • repeated Selection denoms_to_claim = 2

  message MsgClaimSwapRewardResponse

  tx.proto:94

  MsgClaimSwapRewardResponse defines the Msg/ClaimSwapReward response type.

  (message has no fields)

• rpc ClaimSavingsReward (MsgClaimSavingsReward, MsgClaimSavingsRewardResponse)

  tx.proto:23

  ClaimSavingsReward is a message type used to claim savings rewards

  message MsgClaimSavingsReward

  tx.proto:97

  MsgClaimSavingsReward message type used to claim savings rewards

  • string sender = 1

  • repeated Selection denoms_to_claim = 2

  message MsgClaimSavingsRewardResponse

  tx.proto:109

  MsgClaimSavingsRewardResponse defines the Msg/ClaimSavingsReward response type.

  (message has no fields)

• rpc ClaimEarnReward (MsgClaimEarnReward, MsgClaimEarnRewardResponse)

  tx.proto:26

  ClaimEarnReward is a message type used to claim earn rewards

  message MsgClaimEarnReward

  tx.proto:112

  MsgClaimEarnReward message type used to claim earn rewards

  • string sender = 1

  • repeated Selection denoms_to_claim = 2

  message MsgClaimEarnRewardResponse

  tx.proto:124

  MsgClaimEarnRewardResponse defines the Msg/ClaimEarnReward response type.

  (message has no fields)

Query defines the gRPC querier service for incentive module.

• rpc Params (QueryParamsRequest, QueryParamsResponse)

  query.proto:15

  Params queries module params.

  message QueryParamsRequest

  query.proto:36

  QueryParamsRequest is the request type for the Query/Params RPC method.

  (message has no fields)

  message QueryParamsResponse

  query.proto:39

  QueryParamsResponse is the response type for the Query/Params RPC method.

  • optional Params params = 1

• rpc Rewards (QueryRewardsRequest, QueryRewardsResponse)

  query.proto:20

  Rewards queries reward information for a given user.

  message QueryRewardsRequest

  query.proto:44

  QueryRewardsRequest is the request type for the Query/Rewards RPC method.

  • string owner = 1

    owner is the address of the user to query rewards for.

  • string reward_type = 2

    reward_type is the type of reward to query rewards for, e.g. hard, earn, swap.

  • bool unsynchronized = 3

    unsynchronized is a flag to query rewards that are not simulated for reward synchronized for the current block.

  message QueryRewardsResponse

  query.proto:56

  QueryRewardsResponse is the response type for the Query/Rewards RPC method.

  • repeated USDXMintingClaim usdx_minting_claims = 1

  • repeated HardLiquidityProviderClaim hard_liquidity_provider_claims = 2

  • repeated DelegatorClaim delegator_claims = 3

  • repeated SwapClaim swap_claims = 4

  • repeated SavingsClaim savings_claims = 5

  • repeated EarnClaim earn_claims = 6

• rpc RewardFactors (QueryRewardFactorsRequest, QueryRewardFactorsResponse)

  query.proto:25

  Rewards queries the reward factors.

  message QueryRewardFactorsRequest

  query.proto:90

  QueryRewardFactorsRequest is the request type for the Query/RewardFactors RPC method.

  (message has no fields)

  message QueryRewardFactorsResponse

  query.proto:93

  QueryRewardFactorsResponse is the response type for the Query/RewardFactors RPC method.

  • repeated RewardIndex usdx_minting_reward_factors = 1

  • repeated MultiRewardIndex hard_supply_reward_factors = 2

  • repeated MultiRewardIndex hard_borrow_reward_factors = 3

  • repeated MultiRewardIndex delegator_reward_factors = 4

  • repeated MultiRewardIndex swap_reward_factors = 5

  • repeated MultiRewardIndex savings_reward_factors = 6

  • repeated MultiRewardIndex earn_reward_factors = 7

• rpc Apy (QueryApyRequest, QueryApyResponse)

  query.proto:30

  Apy queries incentive reward apy for a reward.

  message QueryApyRequest

  query.proto:125

  QueryApysRequest is the request type for the Query/Apys RPC method.

  (message has no fields)

  message QueryApyResponse

  query.proto:128

  QueryApysResponse is the response type for the Query/Apys RPC method.

  • repeated Apy earn = 1

AccumulationTime stores the previous reward distribution time and its corresponding collateral type

Used in: GenesisRewardState

• string collateral_type = 1

• optional google.protobuf.Timestamp previous_accumulation_time = 2

Apy contains the calculated APY for a given collateral type at a specific instant in time.

Used in: QueryApyResponse

• string collateral_type = 1

• string apy = 2

BaseClaim is a claim with a single reward coin types

Used in: USDXMintingClaim

• bytes owner = 1

• optional cosmos.base.v1beta1.Coin reward = 2

BaseMultiClaim is a claim with multiple reward coin types

Used in: DelegatorClaim, EarnClaim, HardLiquidityProviderClaim, SavingsClaim, SwapClaim

• bytes owner = 1

• repeated cosmos.base.v1beta1.Coin reward = 2

DelegatorClaim stores delegation rewards that can be claimed by owner

Used in: GenesisState, QueryRewardsResponse

• optional BaseMultiClaim base_claim = 1

• repeated MultiRewardIndex reward_indexes = 2

EarnClaim stores the earn rewards that can be claimed by owner

Used in: GenesisState, QueryRewardsResponse

• optional BaseMultiClaim base_claim = 1

• repeated MultiRewardIndex reward_indexes = 2

GenesisRewardState groups together the global state for a particular reward so it can be exported in genesis.

Used in: GenesisState

• repeated AccumulationTime accumulation_times = 1

• repeated MultiRewardIndex multi_reward_indexes = 2

GenesisState is the state that must be provided at genesis.

• optional Params params = 1

• optional GenesisRewardState usdx_reward_state = 2

• optional GenesisRewardState hard_supply_reward_state = 3

• optional GenesisRewardState hard_borrow_reward_state = 4

• optional GenesisRewardState delegator_reward_state = 5

• optional GenesisRewardState swap_reward_state = 6

• repeated USDXMintingClaim usdx_minting_claims = 7

• repeated HardLiquidityProviderClaim hard_liquidity_provider_claims = 8

• repeated DelegatorClaim delegator_claims = 9

• repeated SwapClaim swap_claims = 10

• optional GenesisRewardState savings_reward_state = 11

• repeated SavingsClaim savings_claims = 12

• optional GenesisRewardState earn_reward_state = 13

• repeated EarnClaim earn_claims = 14

HardLiquidityProviderClaim stores the hard liquidity provider rewards that can be claimed by owner

Used in: GenesisState, QueryRewardsResponse

• optional BaseMultiClaim base_claim = 1

• repeated MultiRewardIndex supply_reward_indexes = 2

• repeated MultiRewardIndex borrow_reward_indexes = 3

MultiRewardIndex stores reward accumulation information on multiple reward types

Used in: DelegatorClaim, EarnClaim, GenesisRewardState, HardLiquidityProviderClaim, MultiRewardIndexesProto, QueryRewardFactorsResponse, SavingsClaim, SwapClaim

• string collateral_type = 1

• repeated RewardIndex reward_indexes = 2

MultiRewardIndexesProto defines a Protobuf wrapper around a MultiRewardIndexes slice

• repeated MultiRewardIndex multi_reward_indexes = 1

MultiRewardPeriod supports multiple reward types

Used in: Params

• bool active = 1

• string collateral_type = 2

• optional google.protobuf.Timestamp start = 3

• optional google.protobuf.Timestamp end = 4

• repeated cosmos.base.v1beta1.Coin rewards_per_second = 5

Multiplier amount the claim rewards get increased by, along with how long the claim rewards are locked

Used in: MultipliersPerDenom

• string name = 1

• int64 months_lockup = 2

• bytes factor = 3

MultipliersPerDenom is a map of denoms to a set of multipliers

Used in: Params

• string denom = 1

• repeated Multiplier multipliers = 2

Params

Used in: GenesisState, QueryParamsResponse

• repeated RewardPeriod usdx_minting_reward_periods = 1

• repeated MultiRewardPeriod hard_supply_reward_periods = 2

• repeated MultiRewardPeriod hard_borrow_reward_periods = 3

• repeated MultiRewardPeriod delegator_reward_periods = 4

• repeated MultiRewardPeriod swap_reward_periods = 5

• repeated MultipliersPerDenom claim_multipliers = 6

• optional google.protobuf.Timestamp claim_end = 7

• repeated MultiRewardPeriod savings_reward_periods = 8

• repeated MultiRewardPeriod earn_reward_periods = 9

RewardIndex stores reward accumulation information

Used in: MultiRewardIndex, QueryRewardFactorsResponse, RewardIndexesProto, USDXMintingClaim

• string collateral_type = 1

• bytes reward_factor = 2

RewardIndexesProto defines a Protobuf wrapper around a RewardIndexes slice

• repeated RewardIndex reward_indexes = 1

RewardPeriod stores the state of an ongoing reward

Used in: Params

• bool active = 1

• string collateral_type = 2

• optional google.protobuf.Timestamp start = 3

• optional google.protobuf.Timestamp end = 4

• optional cosmos.base.v1beta1.Coin rewards_per_second = 5

SavingsClaim stores the savings rewards that can be claimed by owner

Used in: GenesisState, QueryRewardsResponse

• optional BaseMultiClaim base_claim = 1

• repeated MultiRewardIndex reward_indexes = 2

Selection is a pair of denom and multiplier name. It holds the choice of multiplier a user makes when they claim a denom.

Used in: MsgClaimDelegatorReward, MsgClaimEarnReward, MsgClaimHardReward, MsgClaimSavingsReward, MsgClaimSwapReward

• string denom = 1

• string multiplier_name = 2

SwapClaim stores the swap rewards that can be claimed by owner

Used in: GenesisState, QueryRewardsResponse

• optional BaseMultiClaim base_claim = 1

• repeated MultiRewardIndex reward_indexes = 2

USDXMintingClaim is for USDX minting rewards

Used in: GenesisState, QueryRewardsResponse

• optional BaseClaim base_claim = 1

• repeated RewardIndex reward_indexes = 2