Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: emit rewards_withdrawn event #166

Merged
merged 3 commits into from Oct 14, 2021
Merged

fix: emit rewards_withdrawn event #166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7e80245
fix: emit `rewards_withdrawn` event
hallazzang Oct 14, 2021
7d2783a
fix: rollback `harvest` event
hallazzang Oct 14, 2021
fa5b587
docs: update spec doc
hallazzang Oct 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 11 additions & 1 deletion x/farming/keeper/reward.go
View file
Open in desktop
Expand Up @@ -2,6 +2,7 @@ package keeper

import (
"strconv"
"strings"

sdk "github.com/cosmos/cosmos-sdk/types"
gogotypes "github.com/gogo/protobuf/types"
Expand Down Expand Up @@ -184,6 +185,15 @@ func (k Keeper) WithdrawRewards(ctx sdk.Context, farmerAcc sdk.AccAddress, staki
staking.StartingEpoch = currentEpoch
k.SetStaking(ctx, stakingCoinDenom, farmerAcc, staking)

ctx.EventManager().EmitEvents(sdk.Events{
sdk.NewEvent(
types.EventTypeRewardsWithdrawn,
sdk.NewAttribute(types.AttributeKeyFarmer, farmerAcc.String()),
sdk.NewAttribute(types.AttributeKeyStakingCoinDenom, stakingCoinDenom),
sdk.NewAttribute(types.AttributeKeyRewardCoins, truncatedRewards.String()),
),
})

return truncatedRewards, nil
}

Expand Down Expand Up @@ -230,7 +240,7 @@ func (k Keeper) Harvest(ctx sdk.Context, farmerAcc sdk.AccAddress, stakingCoinDe
sdk.NewEvent(
types.EventTypeHarvest,
sdk.NewAttribute(types.AttributeKeyFarmer, farmerAcc.String()),
sdk.NewAttribute(types.AttributeKeyRewardCoins, totalRewards.String()),
sdk.NewAttribute(types.AttributeKeyStakingCoinDenoms, strings.Join(stakingCoinDenoms, ",")),
),
})

Expand Down
49 changes: 28 additions & 21 deletions x/farming/spec/06_events.md
View file
Open in desktop
Expand Up @@ -6,13 +6,16 @@ The farming module emits the following events:

## EndBlocker

| Type | Attribute Key | Attribute Value |
| ----------------- | -------------------- | ------------------------ |
| plan_terminated | plan_id | {planID} |
| plan_terminated | farming_pool_address | {farmingPoolAddress} |
| plan_terminated | termination_address | {terminationAddress} |
| rewards_allocated | plan_id | {planID} |
| rewards_allocated | amount | {totalAllocatedAmount} |
| Type | Attribute Key | Attribute Value |
| ----------------- | -------------------- | ---------------------- |
| plan_terminated | plan_id | {planID} |
| plan_terminated | farming_pool_address | {farmingPoolAddress} |
| plan_terminated | termination_address | {terminationAddress} |
| rewards_allocated | plan_id | {planID} |
| rewards_allocated | amount | {totalAllocatedAmount} |
| rewards_withdrawn | farmer | {farmer} |
| rewards_withdrawn | staking_coin_denom | {stakingCoinDenom} |
| rewards_withdrawn | rewards_coins | {rewardCoins} |

## Handlers

Expand Down Expand Up @@ -56,23 +59,27 @@ The farming module emits the following events:

### MsgUnstake

| Type | Attribute Key | Attribute Value |
| ------- | --------------- | ---------------- |
| unstake | farmer | {farmer} |
| unstake | unstaking_coins | {unstakingCoins} |
| message | module | farming |
| message | action | unstake |
| message | sender | {senderAddress} |
| Type | Attribute Key | Attribute Value |
| ----------------- | ------------------ | ------------------ |
| unstake | farmer | {farmer} |
| unstake | unstaking_coins | {unstakingCoins} |
| rewards_withdrawn | farmer | {farmer} |
| rewards_withdrawn | staking_coin_denom | {stakingCoinDenom} |
| rewards_withdrawn | rewards_coins | {rewardCoins} |
| message | module | farming |
| message | action | unstake |
| message | sender | {senderAddress} |

### MsgHarvest

| Type | Attribute Key | Attribute Value |
| ------- | ------------- | --------------- |
| harvest | farmer | {farmer} |
| harvest | reward_coins | {rewardCoins} |
| message | module | farming |
| message | action | harvest |
| message | sender | {senderAddress} |
| Type | Attribute Key | Attribute Value |
| ------- | ------------------- | ------------------- |
| harvest | farmer | {farmer} |
| harvest | staking_coin_denoms | {stakingCoinDenoms} |
| message | module | farming |
| message | action | harvest |
| message | sender | {senderAddress} |

### MsgAdvanceEpoch

This message is for testing purpose. It is only available when you build `farmingd` binary by `make install-testing` command.
3 changes: 3 additions & 0 deletions x/farming/types/events.go
View file
Open in desktop
Expand Up @@ -7,6 +7,7 @@ const (
EventTypeStake = "stake"
EventTypeUnstake = "unstake"
EventTypeHarvest = "harvest"
EventTypeRewardsWithdrawn = "rewards_withdrawn"
EventTypePlanTerminated = "plan_terminated"
EventTypeRewardsAllocated = "rewards_allocated"

Expand All @@ -23,4 +24,6 @@ const (
AttributeKeyEpochRatio = "epoch_ratio"
AttributeKeyFarmer = "farmer"
AttributeKeyAmount = "amount"
AttributeKeyStakingCoinDenom = "staking_coin_denom"
AttributeKeyStakingCoinDenoms = "staking_coin_denoms"
)