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

feat: refactor collectbudget #62

Merged
merged 1 commit into from
Oct 15, 2021
Merged

feat: refactor collectbudget #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 17 additions & 33 deletions x/budget/keeper/budget.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@ func (k Keeper) CollectBudgets(ctx sdk.Context) error {
return nil
}

var inputs []banktypes.Input
var outputs []banktypes.Output

// Get a map GetBudgetsBySourceMap that has a list of budgets and their total rate, which
// contain the same BudgetSourceAddress
budgetsBySourceMap := types.GetBudgetsBySourceMap(budgets)
Expand All @@ -30,56 +27,43 @@ func (k Keeper) CollectBudgets(ctx sdk.Context) error {
if budgetSourceBalances.IsZero() {
continue
}
expectedCollectionCoins, _ := budgetSourceBalances.MulDecTruncate(budgetsBySource.TotalRate).TruncateDecimal()
var validatedExpectedCollectionCoins sdk.Coins
for _, coin := range expectedCollectionCoins {
if coin.IsValid() && coin.IsZero() {
validatedExpectedCollectionCoins = append(validatedExpectedCollectionCoins, coin)
}
}
expectedDiffCoins := expectedCollectionCoins.Sub(validatedExpectedCollectionCoins)

var totalCollectionCoins sdk.Coins
var totalChangeCoins sdk.DecCoins
for _, budget := range budgetsBySource.Budgets {
var inputs []banktypes.Input
var outputs []banktypes.Output
budgetsBySource.CollectionCoins = make([]sdk.Coins, len(budgetsBySource.Budgets))
for i, budget := range budgetsBySource.Budgets {
collectionAcc, err := sdk.AccAddressFromBech32(budget.CollectionAddress)
if err != nil {
continue
}
collectionCoins, changeCoins := budgetSourceBalances.MulDecTruncate(budget.Rate).TruncateDecimal()
totalCollectionCoins = totalCollectionCoins.Add(collectionCoins...)
totalChangeCoins = totalChangeCoins.Add(changeCoins...)

if !collectionCoins.Empty() && collectionCoins.IsValid() {
inputs = append(inputs, banktypes.NewInput(budgetSourceAcc, collectionCoins))
outputs = append(outputs, banktypes.NewOutput(collectionAcc, collectionCoins))
collectionCoins, _ := budgetSourceBalances.MulDecTruncate(budget.Rate).TruncateDecimal()
if collectionCoins.Empty() || !collectionCoins.IsValid() {
continue
}

k.AddTotalCollectedCoins(ctx, budget.Name, collectionCoins)
inputs = append(inputs, banktypes.NewInput(budgetSourceAcc, collectionCoins))
outputs = append(outputs, banktypes.NewOutput(collectionAcc, collectionCoins))
budgetsBySource.CollectionCoins[i] = collectionCoins
}

if err := k.bankKeeper.InputOutputCoins(ctx, inputs, outputs); err != nil {
continue
}
for i, budget := range budgetsBySource.Budgets {
k.AddTotalCollectedCoins(ctx, budget.Name, budgetsBySource.CollectionCoins[i])
ctx.EventManager().EmitEvents(sdk.Events{
sdk.NewEvent(
types.EventTypeBudgetCollected,
sdk.NewAttribute(types.AttributeValueName, budget.Name),
sdk.NewAttribute(types.AttributeValueCollectionAddress, budget.CollectionAddress),
sdk.NewAttribute(types.AttributeValueBudgetSourceAddress, budget.BudgetSourceAddress),
sdk.NewAttribute(types.AttributeValueRate, budget.Rate.String()),
sdk.NewAttribute(types.AttributeValueAmount, collectionCoins.String()),
sdk.NewAttribute(types.AttributeValueAmount, budgetsBySource.CollectionCoins[i].String()),
),
})
}
// temporary validation logic
if totalCollectionCoins.IsAnyGT(validatedExpectedCollectionCoins) {
panic("totalCollectionCoins.IsAnyGT(expectedCollectionCoins)")
}
if _, neg := sdk.NewDecCoinsFromCoins(expectedDiffCoins...).SafeSub(totalChangeCoins); neg {
panic("expectedChangeCoins.Sub(totalChangeCoins).IsAnyNegative()")
}
}
if err := k.bankKeeper.InputOutputCoins(ctx, inputs, outputs); err != nil {
return err
}
// TODO: add metric
return nil
}

Expand Down
29 changes: 0 additions & 29 deletions x/budget/keeper/invariants.go
View file
Open in desktop

This file was deleted.

4 changes: 1 addition & 3 deletions x/budget/module.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,7 @@ func (AppModule) Name() string {
}

// RegisterInvariants registers the budget module invariants.
func (am AppModule) RegisterInvariants(ir sdk.InvariantRegistry) {
keeper.RegisterInvariants(ir, am.keeper)
}
func (AppModule) RegisterInvariants(_ sdk.InvariantRegistry) {}

// Route returns the message routing key for the budget module.
func (am AppModule) Route() sdk.Route {
Expand Down
7 changes: 4 additions & 3 deletions x/budget/types/budget.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,15 @@ func ValidateName(name string) error {

// BudgetsBySource defines the total rate of budget lists.
type BudgetsBySource struct {
Budgets []Budget
TotalRate sdk.Dec
Budgets []Budget
CollectionCoins []sdk.Coins
TotalRate sdk.Dec
}

type BudgetsBySourceMap map[string]BudgetsBySource

// GetBudgetsBySourceMap returns BudgetsBySourceMap that has a list of budgets and their total rate
// which contain the same BudgetSourceAddress. It can be used to track of what budgets are avilable with BudgetSourceAddress
// which contain the same BudgetSourceAddress. It can be used to track of what budgets are available with BudgetSourceAddress
// and validate their total rate.
func GetBudgetsBySourceMap(budgets []Budget) BudgetsBySourceMap {
budgetsMap := make(BudgetsBySourceMap)
Expand Down