feat: add x/farm module #362
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| func BeginBlocker(ctx sdk.Context, k keeper.Keeper) { | ||
| defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyBeginBlocker) | ||
|
|
||
| if err := k.AllocateRewards(ctx); err != nil { |
Check warning
Code scanning / CodeQL
Panic in BeginBock or EndBlock consensus methods
| defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyBeginBlocker) | ||
|
|
||
| if err := k.AllocateRewards(ctx); err != nil { | ||
| panic(err) |
Check warning
Code scanning / CodeQL
Panic in BeginBock or EndBlock consensus methods
| if err := k.AllocateRewards(ctx); err != nil { | ||
| panic(err) | ||
| } | ||
| k.SetLastBlockTime(ctx, ctx.BlockTime()) |
Check warning
Code scanning / CodeQL
Panic in BeginBock or EndBlock consensus methods
| if err := k.AllocateRewards(ctx); err != nil { | ||
| panic(err) | ||
| } | ||
| k.SetLastBlockTime(ctx, ctx.BlockTime()) |
Check warning
Code scanning / CodeQL
Panic in BeginBock or EndBlock consensus methods
also: - rename some methods and variables - add spec docs skeleton
| func BeginBlocker(ctx sdk.Context, k keeper.Keeper) { | ||
| defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyBeginBlocker) | ||
|
|
||
| if err := k.TerminateEndedPlans(ctx); err != nil { |
Check warning
Code scanning / CodeQL
Panic in BeginBock or EndBlock consensus methods
| defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyBeginBlocker) | ||
|
|
||
| if err := k.TerminateEndedPlans(ctx); err != nil { | ||
| panic(err) |
Check warning
Code scanning / CodeQL
Panic in BeginBock or EndBlock consensus methods
also: - make `IncrementFarmPeriod` unexported - bump `conventional-pre-commit` version
also: - reorganize `AllocateRewards` code for better readability - implement missing gRPC query implementations
|
As a side note in case I forget during the future code review, the |
| for _, rewards := range allocs { | ||
| totalRewards = totalRewards.Add(rewards...) | ||
| } |
Check warning
Code scanning / CodeQL
Iteration over map
| for denom := range totalFarmingAmtByDenom { | ||
| if !totalFarmingAmtByDenom[denom].Equal(farmingAmtSumByDenom[denom]) { | ||
| msg += fmt.Sprintf( | ||
| "\tfarm %s total farming amount %s != sum %s\n", | ||
| denom, totalFarmingAmtByDenom[denom], farmingAmtSumByDenom[denom], | ||
| ) | ||
| cnt++ | ||
| } | ||
| } |
Check warning
Code scanning / CodeQL
Iteration over map
this optimizes the gas usage when calling `CreatePrivatePlan`
also add explanatory comments for core logics
also add a few safety checks when sending coins
Description
The new x/farm module will be the successor of the x/farming module.
Tasks
Farm,Unfarm,HarvestSplit protobuf messages(Farm,Position, ...)RenamePlantoFarmingPlan?References
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/)godoccomments.Files changedin the Github PR explorerCodecov Reportin the comment section below once CI passes