0g-chain/x/incentive/spec/03_messages.md

23 lines
852 B
Markdown
Raw Normal View History

<!--
order: 3
-->
2020-05-07 17:46:48 +00:00
# Messages
Users claim rewards using a `MsgClaimReward`.
```go
// MsgClaimReward message type used to claim rewards
type MsgClaimReward struct {
Sender sdk.AccAddress `json:"sender" yaml:"sender"`
CollateralType string `json:"collateral_type" yaml:"collateral_type"`
MultiplierName string `json:"multiplier_name" yaml:"multiplier_name"`
2020-05-07 17:46:48 +00:00
}
```
## State Modifications
* Accumulated rewards for active claims are transferred from the `kavadist` module account to the users account as vesting coins
* The number of coins transferred is determined by the multiplier in the message. For example, the multiplier equals 1.0, 100% of the claim's reward value is transferred. If the multiplier equals 0.5, 50% of the claim's reward value is transferred.
2020-05-07 17:46:48 +00:00
* The corresponding claim object(s) are deleted from the store