445dc8afe0
## Description Closes: #XXXX --- ### 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/main/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/main/docs/docs/building-modules) * [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/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)
64 lines
2.0 KiB
Go
64 lines
2.0 KiB
Go
package feegrant
|
|
|
|
import (
|
|
"context"
|
|
time "time"
|
|
|
|
errorsmod "cosmossdk.io/errors"
|
|
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
|
|
)
|
|
|
|
var _ FeeAllowanceI = (*BasicAllowance)(nil)
|
|
|
|
// 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)
|
|
func (a *BasicAllowance) Accept(ctx context.Context, fee sdk.Coins, _ []sdk.Msg) (bool, error) {
|
|
if a.Expiration != nil && a.Expiration.Before(sdk.UnwrapSDKContext(ctx).BlockTime()) {
|
|
return true, errorsmod.Wrap(ErrFeeLimitExpired, "basic allowance")
|
|
}
|
|
|
|
if a.SpendLimit != nil {
|
|
left, invalid := a.SpendLimit.SafeSub(fee...)
|
|
if invalid {
|
|
return false, errorsmod.Wrap(ErrFeeLimitExceeded, "basic allowance")
|
|
}
|
|
|
|
a.SpendLimit = left
|
|
return left.IsZero(), nil
|
|
}
|
|
|
|
return false, nil
|
|
}
|
|
|
|
// ValidateBasic implements FeeAllowance and enforces basic sanity checks
|
|
func (a BasicAllowance) ValidateBasic() error {
|
|
if a.SpendLimit != nil {
|
|
if !a.SpendLimit.IsValid() {
|
|
return errorsmod.Wrapf(sdkerrors.ErrInvalidCoins, "send amount is invalid: %s", a.SpendLimit)
|
|
}
|
|
if !a.SpendLimit.IsAllPositive() {
|
|
return errorsmod.Wrap(sdkerrors.ErrInvalidCoins, "spend limit must be positive")
|
|
}
|
|
}
|
|
|
|
if a.Expiration != nil && a.Expiration.Unix() < 0 {
|
|
return errorsmod.Wrap(ErrInvalidDuration, "expiration time cannot be negative")
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (a BasicAllowance) ExpiresAt() (*time.Time, error) {
|
|
return a.Expiration, nil
|
|
}
|