Fee Middleware: Escrow logic #465
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,106 @@ | ||||||
| package keeper | ||||||
|
|
||||||
| import ( | ||||||
| "fmt" | ||||||
|
|
||||||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||||||
|
|
||||||
| sdkerrors "github.com/cosmos/cosmos-sdk/types/errors" | ||||||
|
|
||||||
| "github.com/cosmos/ibc-go/modules/apps/29-fee/types" | ||||||
| channeltypes "github.com/cosmos/ibc-go/modules/core/04-channel/types" | ||||||
| ) | ||||||
|
|
||||||
| // EscrowPacketFee sends the packet fee to the 29-fee module account to hold in escrow | ||||||
| func (k Keeper) EscrowPacketFee(ctx sdk.Context, refundAcc sdk.AccAddress, identifiedFee *types.IdentifiedPacketFee) error { | ||||||
|
There was a problem hiding this comment. Does identifiedFee need to be a pointer? |
||||||
| // check if the refund account exists | ||||||
| hasRefundAcc := k.authKeeper.GetAccount(ctx, refundAcc) | ||||||
| if hasRefundAcc == nil { | ||||||
| return sdkerrors.Wrap(types.ErrRefundAccNotFound, fmt.Sprintf("Account with address: %s not found", refundAcc)) | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| } | ||||||
|
|
||||||
| coins := identifiedFee.Fee.ReceiveFee | ||||||
| coins = coins.Add(identifiedFee.Fee.AckFee...) | ||||||
| coins = coins.Add(identifiedFee.Fee.TimeoutFee...) | ||||||
|
|
||||||
| if err := k.bankKeeper.SendCoinsFromAccountToModule( | ||||||
| ctx, refundAcc, types.ModuleName, coins, | ||||||
| ); err != nil { | ||||||
| return err | ||||||
| } | ||||||
|
|
||||||
| // Store fee in state for reference later | ||||||
| // feeInEscrow/<port-id>/<channel-id>/packet/<sequence-id>/ -> Fee (timeout, ack, onrecv) | ||||||
|
There was a problem hiding this comment. This can be removed imo. If we change the storage path, we will probably forget to remove this. We can indicate the storage path in the |
||||||
| k.SetFeeInEscrow(ctx, identifiedFee) | ||||||
| return nil | ||||||
| } | ||||||
|
|
||||||
| // DistributeFee pays the acknowledgement fee & receive fee for a given packetId while refunding the timeout fee to the refund account associated with the Fee | ||||||
| func (k Keeper) DistributeFee(ctx sdk.Context, refundAcc, forwardRelayer, reverseRelayer sdk.AccAddress, packetID *channeltypes.PacketId) error { | ||||||
|
There was a problem hiding this comment. ditto on PacketId being a pointer? |
||||||
| // check if there is a Fee in escrow for the given packetId | ||||||
| feeInEscrow, found := k.GetFeeInEscrow(ctx, packetID) | ||||||
| if !found { | ||||||
| return sdkerrors.Wrap(types.ErrFeeNotFound, fmt.Sprintf("with channelID: %s, sequenceId %d", packetID.ChannelId, packetID.Sequence)) | ||||||
seantking marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| } | ||||||
|
|
||||||
| // get module accAddr | ||||||
| feeModuleAccAddr := k.authKeeper.GetModuleAddress(types.ModuleName) | ||||||
|
|
||||||
| // send receive fee to forward relayer | ||||||
| err := k.bankKeeper.SendCoins(ctx, feeModuleAccAddr, forwardRelayer, feeInEscrow.Fee.ReceiveFee) | ||||||
| if err != nil { | ||||||
| return sdkerrors.Wrap(err, "error sending fee to forward relayer") | ||||||
seantking marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| } | ||||||
|
|
||||||
| // send ack fee to reverse relayer | ||||||
| err = k.bankKeeper.SendCoins(ctx, feeModuleAccAddr, reverseRelayer, feeInEscrow.Fee.AckFee) | ||||||
| if err != nil { | ||||||
| return sdkerrors.Wrap(err, "error sending fee to reverse relayer") | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| } | ||||||
|
|
||||||
| // refund timeout fee to refundAddr | ||||||
| err = k.bankKeeper.SendCoins(ctx, feeModuleAccAddr, refundAcc, feeInEscrow.Fee.TimeoutFee) | ||||||
| if err != nil { | ||||||
| return sdkerrors.Wrap(err, "error refunding timeout fee") | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| } | ||||||
|
|
||||||
| // removes the fee from the store as fee is now paid | ||||||
| k.DeleteFeeInEscrow(ctx, packetID) | ||||||
|
|
||||||
| return nil | ||||||
| } | ||||||
|
|
||||||
| // DistributeFeeTimeout pays the timeout fee for a given packetId while refunding the acknowledgement fee & receive fee to the refund account associated with the Fee | ||||||
| func (k Keeper) DistributeFeeTimeout(ctx sdk.Context, refundAcc, timeoutRelayer sdk.AccAddress, packetID *channeltypes.PacketId) error { | ||||||
| // check if there is a Fee in escrow for the given packetId | ||||||
| feeInEscrow, hasFee := k.GetFeeInEscrow(ctx, packetID) | ||||||
| if !hasFee { | ||||||
| return sdkerrors.Wrap(types.ErrFeeNotFound, fmt.Sprintf("%s", refundAcc.String())) | ||||||
| } | ||||||
seantking marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| // get module accAddr | ||||||
| feeModuleAccAddr := k.authKeeper.GetModuleAddress(types.ModuleName) | ||||||
|
|
||||||
| // refund the receive fee | ||||||
| err := k.bankKeeper.SendCoins(ctx, feeModuleAccAddr, refundAcc, feeInEscrow.Fee.ReceiveFee) | ||||||
| if err != nil { | ||||||
| return sdkerrors.Wrap(err, "error refunding receive fee") | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| } | ||||||
|
|
||||||
| // refund the ack fee | ||||||
| err = k.bankKeeper.SendCoins(ctx, feeModuleAccAddr, refundAcc, feeInEscrow.Fee.AckFee) | ||||||
| if err != nil { | ||||||
| return sdkerrors.Wrap(err, "error refunding ack fee") | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| } | ||||||
|
|
||||||
| // pay the timeout fee to the reverse relayer | ||||||
| err = k.bankKeeper.SendCoins(ctx, feeModuleAccAddr, timeoutRelayer, feeInEscrow.Fee.TimeoutFee) | ||||||
| if err != nil { | ||||||
| return sdkerrors.Wrap(err, "error sending fee to timeout relayer") | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| } | ||||||
|
|
||||||
| // removes the fee from the store as fee is now paid | ||||||
| k.DeleteFeeInEscrow(ctx, packetID) | ||||||
|
|
||||||
| return nil | ||||||
| } | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.