786afb37f8
Closes: #10685 --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
31 lines
1.2 KiB
Go
31 lines
1.2 KiB
Go
package feegrant
|
|
|
|
import (
|
|
"time"
|
|
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
)
|
|
|
|
// FeeAllowance implementations are tied to a given fee delegator and delegatee,
|
|
// and are used to enforce fee grant limits.
|
|
type FeeAllowanceI interface {
|
|
// Accept can use fee payment requested as well as timestamp of the current block
|
|
// to determine whether or not to process this. This is checked in
|
|
// Keeper.UseGrantedFees and the return values should match how it is handled there.
|
|
//
|
|
// If it returns an error, the fee payment is rejected, otherwise it is accepted.
|
|
// The FeeAllowance implementation is expected to update it's internal state
|
|
// and will be saved again after an acceptance.
|
|
//
|
|
// If remove is true (regardless of the error), the FeeAllowance will be deleted from storage
|
|
// (eg. when it is used up). (See call to RevokeAllowance in Keeper.UseGrantedFees)
|
|
Accept(ctx sdk.Context, fee sdk.Coins, msgs []sdk.Msg) (remove bool, err error)
|
|
|
|
// ValidateBasic should evaluate this FeeAllowance for internal consistency.
|
|
// Don't allow negative amounts, or negative periods for example.
|
|
ValidateBasic() error
|
|
|
|
// ExpiresAt returns the expiry time of the allowance.
|
|
ExpiresAt() (*time.Time, error)
|
|
}
|