2022-01-08 01:59:34 +00:00
|
|
|
// Since: cosmos-sdk 0.43
|
|
|
|
|
syntax = "proto3";
|
|
|
|
|
package cosmos.feegrant.v1beta1;
|
|
|
|
|
|
|
|
|
|
import "gogoproto/gogo.proto";
|
|
|
|
|
import "google/protobuf/any.proto";
|
|
|
|
|
import "cosmos_proto/cosmos.proto";
|
|
|
|
|
import "cosmos/base/v1beta1/coin.proto";
|
|
|
|
|
import "google/protobuf/timestamp.proto";
|
|
|
|
|
import "google/protobuf/duration.proto";
|
|
|
|
|
|
|
|
|
|
option go_package = "github.com/cosmos/cosmos-sdk/x/feegrant";
|
|
|
|
|
|
2023-04-04 00:08:45 +00:00
|
|
|
// BasicAllowance implements Allowance with a one-time grant of coins
|
2022-01-08 01:59:34 +00:00
|
|
|
// that optionally expires. The grantee can use up to SpendLimit to cover fees.
|
|
|
|
|
message BasicAllowance {
|
|
|
|
|
option (cosmos_proto.implements_interface) = "FeeAllowanceI";
|
|
|
|
|
|
2023-04-04 00:08:45 +00:00
|
|
|
// spend_limit specifies the maximum amount of coins that can be spent
|
|
|
|
|
// by this allowance and will be updated as coins are spent. If it is
|
2022-01-08 01:59:34 +00:00
|
|
|
// empty, there is no spend limit and any amount of coins can be spent.
|
|
|
|
|
repeated cosmos.base.v1beta1.Coin spend_limit = 1
|
|
|
|
|
[(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"];
|
|
|
|
|
|
|
|
|
|
// expiration specifies an optional time when this allowance expires
|
|
|
|
|
google.protobuf.Timestamp expiration = 2 [(gogoproto.stdtime) = true];
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// PeriodicAllowance extends Allowance to allow for both a maximum cap,
|
|
|
|
|
// as well as a limit per time period.
|
|
|
|
|
message PeriodicAllowance {
|
|
|
|
|
option (cosmos_proto.implements_interface) = "FeeAllowanceI";
|
|
|
|
|
|
|
|
|
|
// basic specifies a struct of `BasicAllowance`
|
|
|
|
|
BasicAllowance basic = 1 [(gogoproto.nullable) = false];
|
|
|
|
|
|
|
|
|
|
// period specifies the time duration in which period_spend_limit coins can
|
|
|
|
|
// be spent before that allowance is reset
|
|
|
|
|
google.protobuf.Duration period = 2 [(gogoproto.stdduration) = true, (gogoproto.nullable) = false];
|
|
|
|
|
|
|
|
|
|
// period_spend_limit specifies the maximum number of coins that can be spent
|
|
|
|
|
// in the period
|
|
|
|
|
repeated cosmos.base.v1beta1.Coin period_spend_limit = 3
|
|
|
|
|
[(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"];
|
|
|
|
|
|
|
|
|
|
// period_can_spend is the number of coins left to be spent before the period_reset time
|
|
|
|
|
repeated cosmos.base.v1beta1.Coin period_can_spend = 4
|
|
|
|
|
[(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"];
|
|
|
|
|
|
|
|
|
|
// period_reset is the time at which this period resets and a new one begins,
|
|
|
|
|
// it is calculated from the start time of the first transaction after the
|
|
|
|
|
// last period ended
|
|
|
|
|
google.protobuf.Timestamp period_reset = 5 [(gogoproto.stdtime) = true, (gogoproto.nullable) = false];
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// AllowedMsgAllowance creates allowance only for specified message types.
|
|
|
|
|
message AllowedMsgAllowance {
|
|
|
|
|
option (gogoproto.goproto_getters) = false;
|
|
|
|
|
option (cosmos_proto.implements_interface) = "FeeAllowanceI";
|
|
|
|
|
|
2023-04-04 00:08:45 +00:00
|
|
|
// allowance can be any of basic and periodic fee allowance.
|
2022-01-08 01:59:34 +00:00
|
|
|
google.protobuf.Any allowance = 1 [(cosmos_proto.accepts_interface) = "FeeAllowanceI"];
|
|
|
|
|
|
|
|
|
|
// allowed_messages are the messages for which the grantee has the access.
|
|
|
|
|
repeated string allowed_messages = 2;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Grant is stored in the KVStore to record a grant with full context
|
|
|
|
|
message Grant {
|
|
|
|
|
// granter is the address of the user granting an allowance of their funds.
|
2023-04-04 00:08:45 +00:00
|
|
|
string granter = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
2022-01-08 01:59:34 +00:00
|
|
|
|
|
|
|
|
// grantee is the address of the user being granted an allowance of another user's funds.
|
2023-04-04 00:08:45 +00:00
|
|
|
string grantee = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
2022-01-08 01:59:34 +00:00
|
|
|
|
2023-04-04 00:08:45 +00:00
|
|
|
// allowance can be any of basic, periodic, allowed fee allowance.
|
2022-01-08 01:59:34 +00:00
|
|
|
google.protobuf.Any allowance = 3 [(cosmos_proto.accepts_interface) = "FeeAllowanceI"];
|
|
|
|
|
}
|
