feat!: implement ADR 21: Subspace specific custom fee tokens

.changeset/entries/e84e9f85faf0a0e85531a932ca56c8c5a45264cb97c0ee4c7127d52607b1d7ee.yaml

@@ -0,0 +1,6 @@
+type: feat
+module: x/subspaces
+pull_request: 1138
+description: implement subspace specific custom fee tokens
+backward_compatible: true
+date: 2023-05-12T08:32:20.5983359Z

app/app.go

@@ -430,7 +430,7 @@ func NewDesmosApp(
 	)
 
 	// Create subspaces keeper and module
-	subspacesKeeper := subspaceskeeper.NewKeeper(app.appCodec, keys[subspacestypes.StoreKey], app.AccountKeeper, app.AuthzKeeper)
+	subspacesKeeper := subspaceskeeper.NewKeeper(app.appCodec, keys[subspacestypes.StoreKey], app.AccountKeeper, app.AuthzKeeper, authtypes.NewModuleAddress(govtypes.ModuleName).String())
 
 	// Create the relationships keeper
 	app.RelationshipsKeeper = relationshipskeeper.NewKeeper(

client/docs/swagger-ui/swagger.yaml

@@ -4696,6 +4696,27 @@ paths:
                       type: string
                       format: date-time
                       title: the creation time of the subspace
+                    additional_fee_tokens:
+                      type: array
+                      items:
+                        type: object
+                        properties:
+                          denom:
+                            type: string
+                          amount:
+                            type: string
+                        description: >-
+                          Coin defines a token with a denomination and an
+                          amount.
+
+
+                          NOTE: The amount field is an Int which implements the
+                          custom method
+
+                          signatures required by gogoproto.
+                      title: >-
+                        List of fee token denoms with default minimum gas prices
+                        allowed inside the subspace
                   title: Subspace contains all the data of a Desmos subspace
               pagination:
                 type: object
@@ -5023,6 +5044,26 @@ paths:
                     type: string
                     format: date-time
                     title: the creation time of the subspace
+                  additional_fee_tokens:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        denom:
+                          type: string
+                        amount:
+                          type: string
+                      description: >-
+                        Coin defines a token with a denomination and an amount.
+
+
+                        NOTE: The amount field is an Int which implements the
+                        custom method
+
+                        signatures required by gogoproto.
+                    title: >-
+                      List of fee token denoms with default minimum gas prices
+                      allowed inside the subspace
                 title: Subspace contains all the data of a Desmos subspace
             title: >-
               QuerySubspaceResponse is the response type for the Query/Subspace
@@ -19533,6 +19574,26 @@ definitions:
             type: string
             format: date-time
             title: the creation time of the subspace
+          additional_fee_tokens:
+            type: array
+            items:
+              type: object
+              properties:
+                denom:
+                  type: string
+                amount:
+                  type: string
+              description: >-
+                Coin defines a token with a denomination and an amount.
+
+
+                NOTE: The amount field is an Int which implements the custom
+                method
+
+                signatures required by gogoproto.
+            title: >-
+              List of fee token denoms with default minimum gas prices allowed
+              inside the subspace
         title: Subspace contains all the data of a Desmos subspace
     title: QuerySubspaceResponse is the response type for the Query/Subspace method
   desmos.subspaces.v3.QuerySubspacesResponse:
@@ -19570,6 +19631,26 @@ definitions:
               type: string
               format: date-time
               title: the creation time of the subspace
+            additional_fee_tokens:
+              type: array
+              items:
+                type: object
+                properties:
+                  denom:
+                    type: string
+                  amount:
+                    type: string
+                description: >-
+                  Coin defines a token with a denomination and an amount.
+
+
+                  NOTE: The amount field is an Int which implements the custom
+                  method
+
+                  signatures required by gogoproto.
+              title: >-
+                List of fee token denoms with default minimum gas prices allowed
+                inside the subspace
           title: Subspace contains all the data of a Desmos subspace
       pagination:
         type: object
@@ -20233,6 +20314,23 @@ definitions:
         type: string
         format: date-time
         title: the creation time of the subspace
+      additional_fee_tokens:
+        type: array
+        items:
+          type: object
+          properties:
+            denom:
+              type: string
+            amount:
+              type: string
+          description: |-
+            Coin defines a token with a denomination and an amount.
+
+            NOTE: The amount field is an Int which implements the custom method
+            signatures required by gogoproto.
+        title: >-
+          List of fee token denoms with default minimum gas prices allowed
+          inside the subspace
     title: Subspace contains all the data of a Desmos subspace
   desmos.subspaces.v3.UserGroup:
     type: object

proto/desmos/subspaces/module/v1/module.proto

@@ -14,4 +14,9 @@ message Module {
   // of module names which provide a subspaces hooks instance. If no order is
   // provided, then hooks will be applied in alphabetical order of module names.
   repeated string hooks_order = 1;
+
+
+  // authority defines the custom module authority. If not set, defaults to the
+  // governance module.
+  string authority = 2;
 }

proto/desmos/subspaces/v3/models.proto

@@ -3,6 +3,7 @@ package desmos.subspaces.v3;
 
 import "gogoproto/gogo.proto";
 import "google/protobuf/timestamp.proto";
+import "cosmos/base/v1beta1/coin.proto";
 
 option go_package = "github.com/desmos-labs/desmos/v5/x/subspaces/types";
 
@@ -37,6 +38,13 @@ message Subspace {
     (gogoproto.stdtime) = true,
     (gogoproto.moretags) = "yaml:\"creation_time\""
   ];
+
+  // List of fee token denoms with default minimum gas prices allowed inside the subspace
+  repeated cosmos.base.v1beta1.Coin additional_fee_tokens = 8 [
+    (gogoproto.nullable) = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
+    (gogoproto.moretags) = "yaml:\"additional_fee_tokens\""
+  ];
 }
 
 // Section contains the data of a single subspace section

proto/desmos/subspaces/v3/msgs.proto

@@ -2,6 +2,9 @@ syntax = "proto3";
 package desmos.subspaces.v3;
 
 import "gogoproto/gogo.proto";
+import "cosmos/base/v1beta1/coin.proto";
+import "cosmos_proto/cosmos.proto";
+import "cosmos/msg/v1/msg.proto";
 
 import "desmos/subspaces/v3/msgs_treasury.proto";
 import "desmos/subspaces/v3/msgs_feegrant.proto";
@@ -78,6 +81,11 @@ service Msg {
   // RevokeAllowance allows a granter to revoke any existing treasury allowance
   // that has been granted to the grantee
   rpc RevokeAllowance(MsgRevokeAllowance) returns (MsgRevokeAllowanceResponse);
+
+  // UpdateSubspaceFeeTokens allows subspace admins to update the list of fee tokens inside the subspace via a governance proposal
+  //
+  // Since: Desmos 6.0.0
+  rpc UpdateSubspaceFeeTokens(MsgUpdateSubspaceFeeTokens) returns (MsgUpdateSubspaceFeeTokensResponse);
 }
 
 // --------------------------------------------------------------------------------------------------------------------
@@ -492,3 +500,34 @@ message MsgSetUserPermissions {
 // MsgSetUserPermissionsResponse defines the Msg/SetPermissionsResponse
 // response type
 message MsgSetUserPermissionsResponse {}
+
+// --------------------------------------------------------------------------------------------------------------------
+
+// MsgUpdateSubspaceFeeTokens represents the message to be used to update the accepted fee tokens
+// inside a given subspace, using an on-chain governance proposal
+//
+// Since: Desmos 6.0.0
+message MsgUpdateSubspaceFeeTokens {
+  option (cosmos.msg.v1.signer) = "authority";
+
+  // Id of the subspace where the list of allowed fee tokens will be updated
+  uint64 subspace_id = 1 [
+    (gogoproto.customname) = "SubspaceID",
+    (gogoproto.moretags) = "yaml:\"subspace_id\""
+  ];
+
+  // List of tokens allowed to be fee tokens inside the given subspace, represented as their gas prices
+  repeated cosmos.base.v1beta1.Coin additional_fee_tokens = 2 [
+    (gogoproto.nullable) = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
+    (gogoproto.moretags) = "yaml:\"additional_fee_tokens\""
+  ];
+
+  // authority is the address that controls the module (defaults to x/gov unless overwritten).
+  string authority = 3  [ (cosmos_proto.scalar) = "cosmos.AddressString" ];
+}
+
+// MsgUpdateSubspaceFeeTokensResponse represents the Msg/UpdateSubspaceFeeTokens response type
+//
+// Since: Desmos 6.0.0
+message MsgUpdateSubspaceFeeTokensResponse {}

x/posts/client/cli/cli_test.go

@@ -59,6 +59,7 @@ func (s *IntegrationTestSuite) SetupSuite() {
 				"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 				"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 				time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+				nil,
 			),
 		},
 		[]subspacestypes.Section{

x/posts/keeper/genesis_test.go

@@ -31,6 +31,7 @@ func (suite *KeeperTestSuite) TestKeeper_ExportGenesis() {
 						"cosmos1m0czrla04f7rp3zg7dsgc4kla54q7pc4xt00l5",
 						"cosmos1qzskhrcjnkdz2ln4yeafzsdwht8ch08j4wed69",
 						time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+						nil,
 					),
 					subspacestypes.NewSubspace(
 						2,
@@ -40,6 +41,7 @@ func (suite *KeeperTestSuite) TestKeeper_ExportGenesis() {
 						"cosmos1m0czrla04f7rp3zg7dsgc4kla54q7pc4xt00l5",
 						"cosmos1qzskhrcjnkdz2ln4yeafzsdwht8ch08j4wed69",
 						time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+						nil,
 					),
 				}
 
@@ -306,6 +308,7 @@ func (suite *KeeperTestSuite) TestKeeper_ImportGenesis() {
 						"cosmos1m0czrla04f7rp3zg7dsgc4kla54q7pc4xt00l5",
 						"cosmos1qzskhrcjnkdz2ln4yeafzsdwht8ch08j4wed69",
 						time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+						nil,
 					),
 				}
 
@@ -339,6 +342,7 @@ func (suite *KeeperTestSuite) TestKeeper_ImportGenesis() {
 						"cosmos1m0czrla04f7rp3zg7dsgc4kla54q7pc4xt00l5",
 						"cosmos1qzskhrcjnkdz2ln4yeafzsdwht8ch08j4wed69",
 						time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+						nil,
 					),
 				}
 
@@ -402,6 +406,7 @@ func (suite *KeeperTestSuite) TestKeeper_ImportGenesis() {
 						"cosmos1m0czrla04f7rp3zg7dsgc4kla54q7pc4xt00l5",
 						"cosmos1qzskhrcjnkdz2ln4yeafzsdwht8ch08j4wed69",
 						time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+						nil,
 					),
 				}
 
@@ -435,6 +440,7 @@ func (suite *KeeperTestSuite) TestKeeper_ImportGenesis() {
 						"cosmos1m0czrla04f7rp3zg7dsgc4kla54q7pc4xt00l5",
 						"cosmos1qzskhrcjnkdz2ln4yeafzsdwht8ch08j4wed69",
 						time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+						nil,
 					),
 				}
 
@@ -492,6 +498,7 @@ func (suite *KeeperTestSuite) TestKeeper_ImportGenesis() {
 						"cosmos1m0czrla04f7rp3zg7dsgc4kla54q7pc4xt00l5",
 						"cosmos1qzskhrcjnkdz2ln4yeafzsdwht8ch08j4wed69",
 						time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+						nil,
 					),
 				}
 

x/posts/keeper/invariants_test.go

@@ -30,6 +30,7 @@ func (suite *KeeperTestSuite) TestValidSubspacesInvariant() {
 						"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 						"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 						time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+						nil,
 					),
 				}
 
@@ -54,6 +55,7 @@ func (suite *KeeperTestSuite) TestValidSubspacesInvariant() {
 						"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 						"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 						time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+						nil,
 					),
 				}
 

x/posts/legacy/v2/store_test.go

@@ -40,7 +40,7 @@ func TestMigrateStore(t *testing.T) {
 
 	paramsSubspace := newMockSubspace(types.Params{})
 
-	sk := subspaceskeeper.NewKeeper(cdc, keys[subspacestypes.StoreKey], nil, nil)
+	sk := subspaceskeeper.NewKeeper(cdc, keys[subspacestypes.StoreKey], nil, nil, "authority")
 
 	testCases := []struct {
 		name      string
@@ -59,6 +59,7 @@ func TestMigrateStore(t *testing.T) {
 					"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 					"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 					time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+					nil,
 				))
 
 				sk.SaveSubspace(ctx, subspacestypes.NewSubspace(
@@ -69,6 +70,7 @@ func TestMigrateStore(t *testing.T) {
 					"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 					"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 					time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+					nil,
 				))
 			},
 			shouldErr: false,

x/profiles/abci_test.go

@@ -47,7 +47,7 @@ func TestBeginBlocker(t *testing.T) {
 
 	ctx := sdk.NewContext(ms, tmproto.Header{ChainID: "test-chain"}, false, log.NewNopLogger())
 	cdc, legacyAmino := app.MakeCodecs()
-	sk := subspaceskeeper.NewKeeper(cdc, keys[subspacestypes.StoreKey], nil, nil)
+	sk := subspaceskeeper.NewKeeper(cdc, keys[subspacestypes.StoreKey], nil, nil, "authority")
 	rk := relationshipskeeper.NewKeeper(cdc, keys[relationshipstypes.StoreKey], sk)
 	ak := authkeeper.NewAccountKeeper(cdc, keys[authtypes.StoreKey], authtypes.ProtoBaseAccount, app.GetMaccPerms(), "cosmos", authtypes.NewModuleAddress("gov").String())
 	k := keeper.NewKeeper(cdc, legacyAmino, keys[types.StoreKey], ak, rk, nil, nil, nil, authtypes.NewModuleAddress("gov").String())

x/reactions/client/cli/cli_test.go

@@ -63,6 +63,7 @@ func (s *IntegrationTestSuite) SetupSuite() {
 				"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 				"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 				time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+				nil,
 			),
 		},
 		nil, nil, nil, nil, nil,

x/reactions/keeper/genesis_test.go

@@ -30,6 +30,7 @@ func (suite *KeeperTestSuite) TestKeeper_ExportGenesis() {
 						"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 						"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 						time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+						nil,
 					),
 				}
 

x/reactions/keeper/invariants_test.go

@@ -30,6 +30,7 @@ func (suite *KeeperTestSuite) TestValidSubspacesInvariant() {
 						"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 						"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 						time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+						nil,
 					),
 				}
 
@@ -55,6 +56,7 @@ func (suite *KeeperTestSuite) TestValidSubspacesInvariant() {
 						"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 						"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 						time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+						nil,
 					),
 				}
 
@@ -80,6 +82,7 @@ func (suite *KeeperTestSuite) TestValidSubspacesInvariant() {
 						"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 						"cosmos1s0he0z3g92zwsxdj83h0ky9w463sx7gq9mqtgn",
 						time.Date(2020, 1, 1, 12, 00, 00, 000, time.UTC),
+						nil,
 					),
 				}