Reaction registration implementation

CHANGELOG.md

@@ -4,6 +4,7 @@
 - Added the support for posting empty-message posts with medias (#110)
 - Implemented the support for hashtags in posts (#96)
 - Updated the post create CLI command in posts (#117)
+- Implemented the support for registering new reactions (#94)
 
 ## Bug fixes
 - Fixed a bug inside the migration procedure of the `magpie` module (#106)

app/params/weights.go

@@ -2,9 +2,10 @@ package params
 
 // Default simulation operation weights for messages
 const (
- DefaultWeightMsgCreatePost int = 100
- DefaultWeightMsgEditPost int = 100
- DefaultWeightMsgAddReaction int = 100
- DefaultWeightMsgRemoveReaction int = 100
- DefaultWeightMsgAnswerPoll int = 100
+ DefaultWeightMsgCreatePost int = 100
+ DefaultWeightMsgEditPost int = 100
+ DefaultWeightMsgAddReaction int = 100
+ DefaultWeightMsgRemoveReaction int = 100
+ DefaultWeightMsgAnswerPoll int = 100
+ DefaultWeightMsgRegisterReaction int = 100
 )

cli_test/cli_posts_test.go

@@ -494,33 +494,48 @@ func TestDesmosCLIPostsReactions(t *testing.T) {
  // Save key addresses for later use
  fooAddr := f.KeyAddress(keyFoo)
 
+ subspace := "4e188d9c17150037d5199bbdb91ae1eb2a78a15aca04cb35530cccb81494b36e"
+ reactions := posts.Reactions{
+ posts.Reaction{":thumbsup:", "U+1F44D", subspace, fooAddr},
+ posts.Reaction{":blush:", "U+1F60A", subspace, fooAddr},
+ posts.Reaction{":thumbsdown:", "U+1F44E", subspace, fooAddr},
+ }
+
  // Create a post
  success, _, sterr := f.TxPostsCreate("4e188d9c17150037d5199bbdb91ae1eb2a78a15aca04cb35530cccb81494b36e",
  "message", fooAddr, "-y")
  require.True(t, success)
  require.Empty(t, sterr)
  tests.WaitForNextNBlocksTM(1, f.Port)
 
+ // Register reactions
+ for _, reaction := range reactions {
+ success, _, sterr = f.TxPostsRegisterReaction(reaction.ShortCode, reaction.Value, reaction.Subspace, reaction.Creator, "-y")
+ require.True(t, success)
+ require.Empty(t, sterr)
+ tests.WaitForNextNBlocksTM(1, f.Port)
+ }
+
  // __________________________________________________________________________________
  // add-reaction
 
  // Add a reaction
- success, _, sterr = f.TxPostsAddReaction(1, "👍", fooAddr, "-y")
+ success, _, sterr = f.TxPostsAddReaction(1, ":thumbsup:", fooAddr, "-y")
  require.True(t, success)
  require.Empty(t, sterr)
  tests.WaitForNextNBlocksTM(1, f.Port)
 
  // Make sure the reaction is added
  storedPost := f.QueryPost(1)
  require.Len(t, storedPost.Reactions, 1)
- require.Equal(t, storedPost.Reactions[0], posts.NewReaction("👍", fooAddr))
+ require.Equal(t, storedPost.Reactions[0], posts.NewPostReaction(":thumbsup:", fooAddr))
 
  // Test --dry-run
- success, _, _ = f.TxPostsAddReaction(1, "😊", fooAddr, "--dry-run")
+ success, _, _ = f.TxPostsAddReaction(1, ":blush:", fooAddr, "--dry-run")
  require.True(t, success)
 
  // Test --generate-only
- success, stdout, stderr := f.TxPostsAddReaction(1, "👎", fooAddr, "--generate-only=true")
+ success, stdout, stderr := f.TxPostsAddReaction(1, ":thumbsdown:", fooAddr, "--generate-only=true")
  require.Empty(t, stderr)
  require.True(t, success)
  msg := unmarshalStdTx(f.T, stdout)
@@ -536,7 +551,7 @@ func TestDesmosCLIPostsReactions(t *testing.T) {
  // remove-reaction
 
  // Remove a reaction
- success, _, sterr = f.TxPostsRemoveReaction(1, "👍", fooAddr, "-y")
+ success, _, sterr = f.TxPostsRemoveReaction(1, ":thumbsup:", fooAddr, "-y")
  require.True(t, success)
  require.Empty(t, sterr)
  tests.WaitForNextNBlocksTM(1, f.Port)
@@ -546,11 +561,11 @@ func TestDesmosCLIPostsReactions(t *testing.T) {
  require.Empty(t, storedPost.Reactions)
 
  // Test --dry-run
- success, _, _ = f.TxPostsRemoveReaction(1, "😊", fooAddr, "--dry-run")
+ success, _, _ = f.TxPostsRemoveReaction(1, ":blush:", fooAddr, "--dry-run")
  require.True(t, success)
 
  // Test --generate-only
- success, stdout, stderr = f.TxPostsRemoveReaction(1, "👎", fooAddr, "--generate-only=true")
+ success, stdout, stderr = f.TxPostsRemoveReaction(1, ":thumbsdown:", fooAddr, "--generate-only=true")
  require.Empty(t, stderr)
  require.True(t, success)
  msg = unmarshalStdTx(f.T, stdout)
@@ -564,3 +579,105 @@ func TestDesmosCLIPostsReactions(t *testing.T) {
 
  f.Cleanup()
 }
+
+func TestDesmosCLIRegisterReaction(t *testing.T) {
+ t.Parallel()
+ f := InitFixtures(t)
+
+ // Start Desmosd server
+ proc := f.GDStart()
+ defer proc.Stop(false)
+
+ // Save key addresses for later use
+ fooAddr := f.KeyAddress(keyFoo)
+
+ // Later usage variables
+ subspace := "4e188d9c17150037d5199bbdb91ae1eb2a78a15aca04cb35530cccb81494b36e"
+ shortCode := ":like:"
+ value := "https://like.jpg"
+ fooAcc := f.QueryAccount(fooAddr)
+ startTokens := sdk.TokensFromConsensusPower(140)
+ require.Equal(t, startTokens, fooAcc.GetCoins().AmountOf(denom))
+
+ // Register a reaction
+ success, _, sterr := f.TxPostsRegisterReaction(shortCode, value, subspace, fooAddr, "-y")
+ require.True(t, success)
+ require.Empty(t, sterr)
+ tests.WaitForNextNBlocksTM(1, f.Port)
+
+ // Make sure the reaction is registered
+ registeredReactions := f.QueryReactions()
+ require.NotEmpty(t, registeredReactions)
+ require.Equal(t, registeredReactions, posts.Reactions{posts.NewReaction(fooAddr, shortCode, value, subspace)})
+
+ // Test --dry-run
+ success, _, _ = f.TxPostsRegisterReaction(shortCode, value, subspace, fooAddr, "--dry-run")
+ require.True(t, success)
+
+ // Test --generate-only
+ success, stdout, stderr := f.TxPostsRegisterReaction(shortCode, value, subspace, fooAddr, "--generate-only")
+ require.Empty(t, stderr)
+ require.True(t, success)
+ msg := unmarshalStdTx(f.T, stdout)
+ require.NotZero(t, msg.Fee.Gas)
+ require.Len(t, msg.Msgs, 1)
+ require.Len(t, msg.GetSignatures(), 0)
+
+ // Check state didn't change
+ registeredReactions = f.QueryReactions()
+ require.Len(t, registeredReactions, 1)
+
+ f.Cleanup()
+
+}
+
+func TestDesmosCLIRegisterReactionEmojiValue(t *testing.T) {
+ t.Parallel()
+ f := InitFixtures(t)
+
+ // Start Desmosd server
+ proc := f.GDStart()
+ defer proc.Stop(false)
+
+ // Save key addresses for later use
+ fooAddr := f.KeyAddress(keyFoo)
+
+ // Later usage variables
+ subspace := "4e188d9c17150037d5199bbdb91ae1eb2a78a15aca04cb35530cccb81494b36e"
+ shortCode := ":like:"
+ value := "🎉"
+ fooAcc := f.QueryAccount(fooAddr)
+ startTokens := sdk.TokensFromConsensusPower(140)
+ require.Equal(t, startTokens, fooAcc.GetCoins().AmountOf(denom))
+
+ // Register a reaction
+ success, _, sterr := f.TxPostsRegisterReaction(shortCode, value, subspace, fooAddr, "-y")
+ require.True(t, success)
+ require.Empty(t, sterr)
+ tests.WaitForNextNBlocksTM(1, f.Port)
+
+ // Make sure the reaction is registered
+ registeredReactions := f.QueryReactions()
+ require.NotEmpty(t, registeredReactions)
+ require.Equal(t, registeredReactions, posts.Reactions{posts.NewReaction(fooAddr, shortCode, value, subspace)})
+
+ // Test --dry-run
+ success, _, _ = f.TxPostsRegisterReaction(shortCode, value, subspace, fooAddr, "--dry-run")
+ require.True(t, success)
+
+ // Test --generate-only
+ success, stdout, stderr := f.TxPostsRegisterReaction(shortCode, value, subspace, fooAddr, "--generate-only")
+ require.Empty(t, stderr)
+ require.True(t, success)
+ msg := unmarshalStdTx(f.T, stdout)
+ require.NotZero(t, msg.Fee.Gas)
+ require.Len(t, msg.Msgs, 1)
+ require.Len(t, msg.GetSignatures(), 0)
+
+ // Check state didn't change
+ registeredReactions = f.QueryReactions()
+ require.Len(t, registeredReactions, 1)
+
+ f.Cleanup()
+
+}

cli_test/test_helpers.go

@@ -447,6 +447,13 @@ func (f *Fixtures) TxPostsRemoveReaction(id int, reaction string, from sdk.AccAd
  return executeWriteRetStdStreams(f.T, addFlags(cmd, flags), clientkeys.DefaultKeyPass)
 }
 
+// TxPostsRegisterReaction is desmoscli tx posts register-reaction
+func (f *Fixtures) TxPostsRegisterReaction(shortCode, value, subspace string, from sdk.AccAddress, flags ...string) (bool, string, string) {
+ cmd := fmt.Sprintf(`%s tx posts register-reaction %s %s %s --keyring-backend=test --from=%s %v`,
+ f.DesmosliBinary, shortCode, value, subspace, from, f.Flags())
+ return executeWriteRetStdStreams(f.T, addFlags(cmd, flags), clientkeys.DefaultKeyPass)
+}
+
 //___________________________________________________________________________________
 // desmoscli query account
 
@@ -746,6 +753,18 @@ func (f *Fixtures) QueryPost(id int, flags ...string) posts.PostQueryResponse {
  return storedPost
 }
 
+// QueryReactions returns registered reactions
+func (f *Fixtures) QueryReactions(flags ...string) posts.Reactions {
+ cmd := fmt.Sprintf("%s query posts registered-reactions --output=json %s", f.DesmosliBinary, f.Flags())
+ res, errStr := tests.ExecuteT(f.T, addFlags(cmd, flags), "")
+ require.Empty(f.T, errStr)
+ cdc := app.MakeCodec()
+ var registeredReactions posts.Reactions
+ err := cdc.UnmarshalJSON([]byte(res), &registeredReactions)
+ require.NoError(f.T, err)
+ return registeredReactions
+}
+
 //___________________________________________________________________________________
 // executors
 

docs/developers/msgs/add-reaction.md → docs/developers/msgs/add-post-reaction.md

@@ -1,5 +1,5 @@
-# `MsgLikePost`
-This message allows you to like a post that is already existing on the chain. 
+# `MsgAddPostReaction`
+This message allows you to add a reaction to a post that is already existing on the chain. 
 
 ## Structure
 ```json
@@ -16,14 +16,14 @@ This message allows you to like a post that is already existing on the chain.
 ### Attributes
 | Attribute | Type | Description |
 | :-------: | :----: | :-------- |
-| `value` String | Value of the reaction | 
+| `value` | String | Value of the reaction | 
 | `user` | String | Desmos address of the user adding the reaction to the post | 
 | `post_id` | String | ID of the post to which add the reaction | 
 
 ## Example
 ```json
 {
- "type": "desmos/MsgLikePost",
+ "type": "desmos/MsgAddPostReaction",
  "value": {
  "value": "like",
  "liker": "desmos1w3fe8zq5jrxd4nz49hllg75sw7m24qyc7tnaax",

docs/developers/msgs/register-reaction.md

@@ -0,0 +1,44 @@
+# `MsgRegisterReaction`
+This message allows you to register a new reaction. 
+If you want to know more about the `Reaction` type, you can do so inside the [`Reaction` type documentation page](../../types/reaction.md)
+
+## Structure
+```json
+{
+ "type": "desmos/MsgRegisterReaction",
+ "value": {
+ "short_code": "<reaction short code>",
+ "value": "<url (identifing gif or image) or unicode (identifing emoji)>",
+ "subspace": "<Reaction subspace>",
+ "creator": "<Desmos address that's registering the reaction>"
+ }
+}
+```
+
+### Attributes
+| Attribute | Type | Description |
+| :-------: | :----: | :-------- |
+| `short_code` | String | Short code that identifies the reaction (e.g. `":smile:"`) |
+| `value` | String | Value can be a URL or a UNICODE identifing gif, images, emoji |
+| `subspace` | String | Required string that identifies the subspace inside which the reaction will be registered |
+| `creator` | String | Desmos address of the user that is registering the reaction |
+
+## Example
+```json
+{
+ "type": "desmos/MsgRegisterReaction",
+ "value": {
+ "shortcode": ":smile:",
+ "value": "U+1F604",
+ "subspace": "4e188d9c17150037d5199bbdb91ae1eb2a78a15aca04cb35530cccb81494b36e",
+ "creator": "desmos13s7p4jx3rj5pxjzlecxdvua68ex0sg7rug0pt3"
+ }
+}
+```
+
+## Message action
+The action associated to this message is the following: 
+
+```
+register_reaction
+```

docs/developers/msgs/remove-reaction.md → docs/developers/msgs/remove-post-reaction.md

@@ -1,5 +1,5 @@
-# `MsgUnlikePost`
-With this message you can remove the like from a previously liked post. 
+# `MsgRemovePostReaction`
+With this message you can remove a reaction from a post you have previously reacted to.
 
 ## Structure
 ```json

docs/developers/perform-transactions.md

@@ -11,6 +11,7 @@ Here is the list of currently available [messages](developer-faq.md#what-is-a-me
 ### Posts
 * [`MsgCreatePost`](msgs/create-post.md): allows you to create a new post or a comment for an existing post. 
 * [`MsgEditPost`](msgs/edit-post.md): allows you to edit a previously created post message.
-* [`MsgAddPostReaction`](msgs/add-reaction.md): allows you to add a reaction to an existing post. 
-* [`MsgRemovePostReaction`](msgs/remove-reaction.md): allows you to remove a reaction from a post.
+* [`MsgAddPostReaction`](msgs/add-post-reaction.md): allows you to add a reaction to an existing post. 
+* [`MsgRemovePostReaction`](msgs/remove-post-reaction.md): allows you to remove a reaction from a post.
 * [`MsgAnswerPoll`](msgs/answer-poll.md): allows you to answer a post's poll.
+* [`MsgRegisterReaction`](msgs/register-reaction.md): allows you to register a reaction.

docs/developers/queries/reactions.md

@@ -0,0 +1,18 @@
+# Query registered reactions
+This query endpoint allows you to retrieve the list of registered reactions. 
+
+**CLI**
+ ```bash
+desmoscli query posts registered-reactions
+
+# Example
+# desmoscli query posts registered-reactions
+``` 
+
+**REST**
+```
+/reactions
+
+# Example
+# curl https://morpheus4000.desmos.network/reactions
+```

docs/developers/query-data.md

@@ -6,6 +6,7 @@ Aside from [performing transactions](perform-transactions.md) you can also query
 - [Query a post](queries/post.md)
 - [Query the stored posts](queries/posts.md)
 - [Query the post's poll answers](queries/poll-answers.md)
+- [Query registered reactions](queries/reactions.md)
 
 ## Sessions
 - [Query a session](queries/session.md)

docs/types/reaction.md

@@ -0,0 +1,36 @@
+# Reaction
+Inside Desmos, the reactions is the fastest way users can react to posts.
+
+Everyday each one of us use reactions inside the most popular social networks.
+Reactions let you immediately express what you think about the post/photo/video you've just watched.
+
+Each new reaction that will be registered inside Desmos will become part of the set of reactions supported by the system. 
+Once you have registered your favorite GIF/image/emoji, you will be allowed to use them to react to every post inside Desmos.
+Remember that a reaction can be registered only once per `subspace`, so if you ever try to register a previously 
+registered reaction, your transaction will not be valid. 
+
+## Contained data
+A reaction is made of different parts. Following you will find out what are those and how they can be used.
+
+### `ShortCode`
+The `ShortCode` identifies the actual reaction short code. 
+Short codes are codes used on various websites to speed up reaction insertion using a keyboard.
+These begin and end with a colon, and contain the literal name of the reaction itself. 
+For example, it can look something like `:emoji-shortcode:`.
+When registering a new reaction, the shot code must be validated by the following regEx: `:[a-z]([a-z\d_])*:`. 
+[Here](https://www.webfx.com/tools/emoji-cheat-sheet/) the list of all available short codes.
+
+### `Value`
+The `Value` of a reaction identifies whether the reaction is a GIF an image or an emoji. 
+Value can be a `URL` with the path of the GIF/image your using as a reaction or it can be a `UNICODE` 
+that identifies a specific emoji. 
+`URL`'s will be validated by the following regEx: `^(?:http(s)?://)[\w.-]+(?:\.[\w.-]+)+[\w\-._~:/?#[\]@!$&'()*+,;=.]+$`.
+`Unicode` must be one of the following [list](https://unicode.org/emoji/charts/full-emoji-list.html).
+
+### `Subspace`
+The `Subspace` field identifies the application inside which the reaction has been registered. 
+Currently the subspace must be a SHA256 hash of the previously plain-text value.
+
+### `Creator`
+The `Creator` field is used to specify the Bech32 address of the creator of the reaction. 
+In order for a creator address to be valid, it must begin with the `desmos` Bech32 human-readable part.

go.mod

@@ -13,4 +13,5 @@ require (
  github.com/tendermint/go-amino v0.15.1
  github.com/tendermint/tendermint v0.33.0
  github.com/tendermint/tm-db v0.4.0
+ github.com/tmdvs/Go-Emoji-Utils v1.1.0
 )