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

add function EscrowAccountHasBalance #1042

Merged
merged 6 commits into from
Mar 3, 2022
Merged

add function EscrowAccountHasBalance #1042

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
16e4a2d
add function EscrowAccountHasBalance
colin-axner Mar 2, 2022
fdb0a07
change API to use sdk.Coins
colin-axner Mar 2, 2022
941318c
Merge branch 'ics29-fee-middleware' into colin/add-escrow-account-bal…
colin-axner Mar 2, 2022
6154144
Merge branch 'ics29-fee-middleware' into colin/add-escrow-account-bal…
colin-axner Mar 3, 2022
c5e6ef3
fix merge conflict
colin-axner Mar 3, 2022
2c928f5
Merge branch 'colin/add-escrow-account-balance-check' of github.com:c…
colin-axner Mar 3, 2022
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
11 changes: 11 additions & 0 deletions modules/apps/29-fee/keeper/keeper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,17 @@ func (k Keeper) GetFeeModuleAddress() sdk.AccAddress {
return k.authKeeper.GetModuleAddress(types.ModuleName)
}

// EscrowAccountHasBalance verifies if the escrow account has the provided fee.
func (k Keeper) EscrowAccountHasBalance(ctx sdk.Context, fee types.Fee) bool {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The API changes the usage of this. If I swap fee to be sdk.Coins then I could call this within distributeFee. If I leave as is then I need to call twice, one for DistributePacketFees and one for DistributePacketFeesOnTimeout.

I'm kinda leaning towards just calling with distributeFee. Might be best to isolate all fee distribution/locking logic to a single funciton. Thoughts?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree here, I think it would be cleaner as sdk.Coins and call in distributeFee. Like you say, that way everything is encapsulated inside a single function, and it's easier to reason about 👍

for _, coin := range fee.Total() {
if !k.bankKeeper.HasBalance(ctx, k.GetFeeModuleAddress(), coin) {
return false
}
}

return true
}

// SetFeeEnabled sets a flag to determine if fee handling logic should run for the given channel
// identified by channel and port identifiers.
func (k Keeper) SetFeeEnabled(ctx sdk.Context, portID, channelID string) {
Expand Down
21 changes: 21 additions & 0 deletions modules/apps/29-fee/keeper/keeper_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,27 @@ func TestKeeperTestSuite(t *testing.T) {
suite.Run(t, new(KeeperTestSuite))
}

func (suite *KeeperTestSuite) TestEscrowAccountHasBalance() {
fee := types.Fee{
AckFee: defaultAckFee,
RecvFee: defaultReceiveFee,
TimeoutFee: defaultTimeoutFee,
}

suite.Require().False(suite.chainA.GetSimApp().IBCFeeKeeper.EscrowAccountHasBalance(suite.chainA.GetContext(), fee))

// set fee in escrow account
err := suite.chainA.GetSimApp().BankKeeper.SendCoinsFromAccountToModule(suite.chainA.GetContext(), suite.chainA.SenderAccount.GetAddress(), types.ModuleName, fee.Total())
suite.Require().Nil(err)

suite.Require().True(suite.chainA.GetSimApp().IBCFeeKeeper.EscrowAccountHasBalance(suite.chainA.GetContext(), fee))

// increase ack fee
fee.AckFee = fee.AckFee.Add(defaultAckFee...)
suite.Require().False(suite.chainA.GetSimApp().IBCFeeKeeper.EscrowAccountHasBalance(suite.chainA.GetContext(), fee))

}

func (suite *KeeperTestSuite) TestFeeInEscrow() {
suite.coordinator.Setup(suite.path)

Expand Down