feat: ADR-016: Reactions module

.changeset/config.yaml

@@ -66,6 +66,8 @@ modules:
     description: Subspaces
   - id: x/posts
     description: Posts
+  - id: x/reactions
+    description: Reactions
   - id: x/reports
     description: Reports
   - id: x/fees

.changeset/entries/4bd081c55da7be1780b42ddcfcb31ea39143a2223f69ef97e44c347d2528f1c7.yaml

@@ -0,0 +1,6 @@
+type: feat
+module: x/reactions
+pull_request: 898
+description: Added the new x/reactions module
+backward_compatible: true
+date: 2022-06-10T09:58:20.626124304Z

app/app.go

@@ -8,6 +8,9 @@ import (
 	"path/filepath"
 	"strings"
 
+	"github.com/desmos-labs/desmos/v3/x/reactions"
+	reactionstypes "github.com/desmos-labs/desmos/v3/x/reactions/types"
+
 	postskeeper "github.com/desmos-labs/desmos/v3/x/posts/keeper"
 	poststypes "github.com/desmos-labs/desmos/v3/x/posts/types"
 
@@ -103,11 +106,11 @@ import (
 	"github.com/desmos-labs/desmos/v3/x/profiles"
 	profileskeeper "github.com/desmos-labs/desmos/v3/x/profiles/keeper"
 	profilestypes "github.com/desmos-labs/desmos/v3/x/profiles/types"
+	reactionskeeper "github.com/desmos-labs/desmos/v3/x/reactions/keeper"
 	relationshipskeeper "github.com/desmos-labs/desmos/v3/x/relationships/keeper"
 	"github.com/desmos-labs/desmos/v3/x/reports"
 	reportskeeper "github.com/desmos-labs/desmos/v3/x/reports/keeper"
 	reportstypes "github.com/desmos-labs/desmos/v3/x/reports/types"
-
 	"github.com/desmos-labs/desmos/v3/x/subspaces"
 	subspaceskeeper "github.com/desmos-labs/desmos/v3/x/subspaces/keeper"
 	subspacestypes "github.com/desmos-labs/desmos/v3/x/subspaces/types"
@@ -243,6 +246,7 @@ var (
 		subspaces.AppModuleBasic{},
 		posts.AppModuleBasic{},
 		reports.AppModuleBasic{},
+		reactions.AppModuleBasic{},
 		fees.AppModuleBasic{},
 		supply.AppModuleBasic{},
 	)
@@ -310,6 +314,7 @@ type DesmosApp struct {
 	RelationshipsKeeper relationshipskeeper.Keeper
 	PostsKeeper         postskeeper.Keeper
 	ReportsKeeper       reportskeeper.Keeper
+	ReactionsKeeper     reactionskeeper.Keeper
 	SupplyKeeper        supplykeeper.Keeper
 
 	// Module Manager
@@ -358,7 +363,7 @@ func NewDesmosApp(
 
 		// Custom modules
 		profilestypes.StoreKey, relationshipstypes.StoreKey, subspacestypes.StoreKey,
-		poststypes.StoreKey, reportstypes.StoreKey,
+		poststypes.StoreKey, reportstypes.StoreKey, reactionstypes.StoreKey,
 		feestypes.StoreKey,
 	)
 	tkeys := sdk.NewTransientStoreKeys(paramstypes.TStoreKey)
@@ -511,11 +516,22 @@ func NewDesmosApp(
 		&postsKeeper,
 	)
 
+	// Create reactions keeper
+	app.ReactionsKeeper = reactionskeeper.NewKeeper(
+		app.appCodec,
+		keys[reactionstypes.StoreKey],
+		app.ProfileKeeper,
+		&subspacesKeeper,
+		app.RelationshipsKeeper,
+		&postsKeeper,
+	)
+
 	// Register the posts hooks
 	// NOTE: postsKeeper above is passed by reference, so that it will contain these hooks
 	app.PostsKeeper = *postsKeeper.SetHooks(
 		poststypes.NewMultiPostsHooks(
 			app.ReportsKeeper.Hooks(),
+			app.ReactionsKeeper.Hooks(),
 		),
 	)
 
@@ -526,6 +542,7 @@ func NewDesmosApp(
 			app.RelationshipsKeeper.Hooks(),
 			app.PostsKeeper.Hooks(),
 			app.ReportsKeeper.Hooks(),
+			app.ReactionsKeeper.Hooks(),
 		),
 	)
 
@@ -633,6 +650,7 @@ func NewDesmosApp(
 		relationships.NewAppModule(appCodec, app.RelationshipsKeeper, app.SubspacesKeeper, profilesv4.NewKeeper(keys[profilestypes.StoreKey], appCodec), app.AccountKeeper, app.BankKeeper, app.FeesKeeper),
 		posts.NewAppModule(appCodec, app.PostsKeeper, app.SubspacesKeeper, app.AccountKeeper, app.BankKeeper, app.FeesKeeper),
 		reports.NewAppModule(appCodec, app.ReportsKeeper, app.SubspacesKeeper, app.PostsKeeper, app.AccountKeeper, app.BankKeeper, app.FeesKeeper),
+		reactions.NewAppModule(appCodec, app.ReactionsKeeper, app.SubspacesKeeper, app.PostsKeeper, app.AccountKeeper, app.BankKeeper, app.FeesKeeper),
 		supply.NewAppModule(appCodec, legacyAmino, app.SupplyKeeper),
 	)
 
@@ -668,6 +686,7 @@ func NewDesmosApp(
 		profilestypes.ModuleName,
 		poststypes.ModuleName,
 		reportstypes.ModuleName,
+		reactionstypes.ModuleName,
 		supplytypes.ModuleName,
 	)
 	app.mm.SetOrderEndBlockers(
@@ -697,6 +716,7 @@ func NewDesmosApp(
 		profilestypes.ModuleName,
 		poststypes.ModuleName,
 		reportstypes.ModuleName,
+		reactionstypes.ModuleName,
 		supplytypes.ModuleName,
 	)
 
@@ -733,6 +753,7 @@ func NewDesmosApp(
 		relationshipstypes.ModuleName,
 		poststypes.ModuleName,
 		reportstypes.ModuleName,
+		reactionstypes.ModuleName,
 		supplytypes.ModuleName,
 
 		crisistypes.ModuleName,
@@ -768,6 +789,7 @@ func NewDesmosApp(
 		profilestypes.ModuleName,
 		poststypes.ModuleName,
 		reportstypes.ModuleName,
+		reactionstypes.ModuleName,
 		supplytypes.ModuleName,
 
 		crisistypes.ModuleName,
@@ -812,6 +834,7 @@ func NewDesmosApp(
 		relationships.NewAppModule(appCodec, app.RelationshipsKeeper, app.SubspacesKeeper, profilesv4.NewKeeper(keys[profilestypes.StoreKey], appCodec), app.AccountKeeper, app.BankKeeper, app.FeesKeeper),
 		posts.NewAppModule(appCodec, app.PostsKeeper, app.SubspacesKeeper, app.AccountKeeper, app.BankKeeper, app.FeesKeeper),
 		reports.NewAppModule(appCodec, app.ReportsKeeper, app.SubspacesKeeper, app.PostsKeeper, app.AccountKeeper, app.BankKeeper, app.FeesKeeper),
+		reactions.NewAppModule(appCodec, app.ReactionsKeeper, app.SubspacesKeeper, app.PostsKeeper, app.AccountKeeper, app.BankKeeper, app.FeesKeeper),
 	)
 
 	app.sm.RegisterStoreDecoders()
@@ -1066,6 +1089,7 @@ func initParamsKeeper(appCodec codec.BinaryCodec, legacyAmino *codec.LegacyAmino
 	paramsKeeper.Subspace(profilestypes.ModuleName)
 	paramsKeeper.Subspace(poststypes.ModuleName)
 	paramsKeeper.Subspace(reportstypes.ModuleName)
+	paramsKeeper.Subspace(reactionstypes.ModuleName)
 
 	return paramsKeeper
 }

app/params/weights.go

@@ -44,4 +44,11 @@ const (
 	DefaultWeightMsgSupportStandardReason int = 20
 	DefaultWeightMsgAddReason             int = 10
 	DefaultWeightMsgRemoveReason          int = 10
+
+	DefaultWeightMsgAddReaction              int = 40
+	DefaultWeightMsgRemoveReaction           int = 30
+	DefaultWeightMsgAddRegisteredReaction    int = 25
+	DefaultWeightMsgEditRegisteredReaction   int = 25
+	DefaultWeightMsgRemoveRegisteredReaction int = 15
+	DefaultWeightMsgSetReactionsParams       int = 10
 )

app/sim_test.go

@@ -9,6 +9,8 @@ import (
 	"path/filepath"
 	"testing"
 
+	reactionstypes "github.com/desmos-labs/desmos/v3/x/reactions/types"
+
 	feestypes "github.com/desmos-labs/desmos/v3/x/fees/types"
 	poststypes "github.com/desmos-labs/desmos/v3/x/posts/types"
 	relationshipstypes "github.com/desmos-labs/desmos/v3/x/relationships/types"
@@ -254,6 +256,7 @@ func TestAppImportExport(t *testing.T) {
 		{app.keys[relationshipstypes.StoreKey], newApp.keys[relationshipstypes.StoreKey], [][]byte{}},
 		{app.keys[poststypes.StoreKey], newApp.keys[poststypes.StoreKey], [][]byte{}},
 		{app.keys[reportstypes.StoreKey], newApp.keys[reportstypes.StoreKey], [][]byte{}},
+		{app.keys[reactionstypes.StoreKey], newApp.keys[reactionstypes.StoreKey], [][]byte{}},
 	}
 
 	for _, skp := range storeKeysPrefixes {

docs/architecture/adr-016-reactions-module.md

@@ -6,7 +6,7 @@
 
 ## Status
 
-DRAFT Not Implemented
+ACCEPTED Implemented
 
 ## Abstract
 
@@ -259,17 +259,17 @@ syntax = "proto3";
 // Query defines the gRPC querier service.
 service Query {
   // Reactions allows to query the reactions present inside a subspace
-  rpc Reactions(QueryReactionsRequest) returns QueryReactionsResponse {
+  rpc Reactions(QueryReactionsRequest) returns (QueryReactionsResponse) {
     option (google.api.http).get = "/desmos/reactions/v1/{subspace_id}/reactions";
   }
 
   // RegisteredReactions allows to query the registered reaction of a subspace
-  rpc RegisteredReactions(QueryRegisteredReactionsRequest) returns QueryRegisteredReactionsResponse {
+  rpc RegisteredReactions(QueryRegisteredReactionsRequest) returns (QueryRegisteredReactionsResponse) {
     option (google.api.http).get = "/desmos/reactions/v1/{subspace_id}/registered-reactions";
   }
-  
+
   // ReactionsParams allows to query the reaction params of a subspace
-  rpc ReactionsParams(QueryReactionsParamsRequest) returns QueryReactionsParamsResponse {
+  rpc ReactionsParams(QueryReactionsParamsRequest) returns (QueryReactionsParamsResponse) {
     option (google.api.http).get = "/desmos/reactions/v1/{subspace_id}/params";
   }
 }
@@ -278,7 +278,7 @@ service Query {
 message QueryReactionsRequest {
   // Id of the subspace to query the reactions for
   uint64 subspace_id = 1;
-  
+
   // (optional) Post id to query the reactions for
   uint64 post_id = 2;
 
@@ -292,14 +292,28 @@ message QueryReactionsResponse {
   cosmos.base.query.v1beta1.PageResponse pagination = 2;
 }
 
-// QueryReactionsParamsRequest is the request type for the 
-// Query/ReactionsParams RPC method
+// QueryRegisteredReactionsRequest is the request type for the Query/RegisteredReactions RPC method
+message QueryRegisteredReactionsRequest {
+  // Id of the subspace to query the registered reactions for
+  uint64 subspace_id = 1;
+
+  // pagination defines an optional pagination for the request.
+  optional cosmos.base.query.v1beta1.PageRequest pagination = 3;
+}
+
+// QueryRegisteredReactionsResponse is the response type for the Query/RegisteredReactions RPC method
+message QueryRegisteredReactionsResponse {
+  repeated RegisteredReaction registered_reactions = 1;
+  cosmos.base.query.v1beta1.PageResponse pagination = 2;
+}
+
+// QueryReactionsParamsRequest is the request type for the Query/ReactionsParams RPC method
 message QueryReactionsParamsRequest {
+  // Id of the subspace for which to query the params
   uint64 subspace_id = 1;
 }
 
-// QueryReactionsParamsResponse is the response type for the 
-// Query/ReactionsParam RPC method
+// QueryReactionsParamsResponse is the response type for the Query/ReactionsParam RPC method
 message QueryReactionsParamsResponse {
   // Params related to RegisteredReactionValue reactions
   RegisteredReactionValueParams registered = 1;

proto/desmos/reactions/v1/client/cli.proto

@@ -0,0 +1,22 @@
+syntax = "proto3";
+package desmos.reactions.v1.client;
+
+import "gogoproto/gogo.proto";
+import "google/protobuf/any.proto";
+import "google/protobuf/timestamp.proto";
+import "cosmos_proto/cosmos.proto";
+
+import "desmos/reactions/v1/models.proto";
+
+option go_package = "github.com/desmos-labs/desmos/v3/x/reactions/client/utils";
+
+// SetReactionsParamsJSON contains the data that can be specified when setting a
+// subspace reactions params using the CLI command
+message SetReactionsParamsJSON {
+  // Params related to RegisteredReactionValue reactions
+  RegisteredReactionValueParams registered_reaction_params = 1
+      [ (gogoproto.nullable) = false ];
+
+  // Params related to FreeTextValue reactions
+  FreeTextValueParams free_text_params = 2 [ (gogoproto.nullable) = false ];
+}

proto/desmos/reactions/v1/genesis.proto

@@ -0,0 +1,46 @@
+syntax = "proto3";
+package desmos.reactions.v1;
+
+import "gogoproto/gogo.proto";
+import "google/protobuf/any.proto";
+import "google/protobuf/timestamp.proto";
+import "cosmos_proto/cosmos.proto";
+
+import "desmos/reactions/v1/models.proto";
+
+option go_package = "github.com/desmos-labs/desmos/v3/x/reactions/types";
+
+// GenesisState contains the data of the genesis state for the reactions module
+message GenesisState {
+  option (gogoproto.equal) = true;
+  option (gogoproto.goproto_stringer) = true;
+
+  repeated SubspaceDataEntry subspaces_data = 1
+      [ (gogoproto.nullable) = false ];
+  repeated RegisteredReaction registered_reactions = 2
+      [ (gogoproto.nullable) = false ];
+  repeated PostDataEntry posts_data = 3 [ (gogoproto.nullable) = false ];
+  repeated Reaction reactions = 4 [ (gogoproto.nullable) = false ];
+  repeated SubspaceReactionsParams subspaces_params = 5
+      [ (gogoproto.nullable) = false ];
+}
+
+// SubspaceDataEntry contains the data related to a single subspace
+message SubspaceDataEntry {
+  option (gogoproto.equal) = true;
+  option (gogoproto.goproto_stringer) = true;
+
+  uint64 subspace_id = 1 [ (gogoproto.customname) = "SubspaceID" ];
+  uint32 registered_reaction_id = 2
+      [ (gogoproto.customname) = "RegisteredReactionID" ];
+}
+
+// PostDataEntry contains the data related to a single post
+message PostDataEntry {
+  option (gogoproto.equal) = true;
+  option (gogoproto.goproto_stringer) = true;
+
+  uint64 subspace_id = 1 [ (gogoproto.customname) = "SubspaceID" ];
+  uint64 post_id = 2 [ (gogoproto.customname) = "PostID" ];
+  uint32 reaction_id = 3 [ (gogoproto.customname) = "ReactionID" ];
+}