33 lines
1.5 KiB
Go
33 lines
1.5 KiB
Go
package types
|
|
|
|
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/height 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 RevokeFeeAllowance in Keeper.UseGrantedFees)
|
|
Accept(ctx sdk.Context, fee sdk.Coins, msgs []sdk.Msg) (remove bool, err error)
|
|
|
|
// If we export fee allowances the timing info will be quite off (eg. go from height 100000 to 0)
|
|
// This callback allows the fee-allowance to change it's state and return a copy that is adjusted
|
|
// given the time and height of the actual dump (may safely return self if no changes needed)
|
|
PrepareForExport(dumpTime time.Time, dumpHeight int64) FeeAllowanceI
|
|
|
|
// ValidateBasic should evaluate this FeeAllowance for internal consistency.
|
|
// Don't allow negative amounts, or negative periods for example.
|
|
ValidateBasic() error
|
|
}
|