feat(ica)!: support json tx encoding for interchain accounts

[srdtrk]

Description

This PR;

• Adds support for json tx encoding for interchain accounts
• Modifies all existing tests to also test with json encoding if possible.
• Implements new unit and integration tests for json encoding.

closes: #3246

Changes

The code for encoding and decoding json messages are adden in to /27-interchain-accounts/types/codec.go. The new tests for json encoding reside in codec_test.go and relay_test.go.

In general, there are 4 packages we might want to use for json encoding, and these are:

• encoding/json
• protojson
• jsonpb (depreciated)
• cosmos-sdk/codec (uses jsonpb)

JSON Format

In this implementation, our main goal is to support json messages coming from cosmwasm. Communicating go modules should use protobuf encoding. In this implementation, we've opted to use the sdk's JSONCodec found in cosmos-sdk/codec. This causes the ica module to expect a very specific json format for Any. I'll explain this format with an example. Consider a legacy text governance proposal, the expected json object for this proposal would be:

{
  "messages": [
    {
      "@type": "/cosmos.gov.v1beta1.MsgSubmitProposal",
      "content": {
        "@type": "/cosmos.gov.v1beta1.TextProposal",
        "title": "IBC Gov Proposal",
        "description": "tokens for all!"
      },
      "initial_deposit": [{ "denom": "stake", "amount": "5000" }],
      "proposer": "cosmos1k4epd6js8aa7fk4e5l7u6dwttxfarwu6yald9hlyckngv59syuyqnlqvk8"
    }
  ]
}

Cosmwasm Serialization

After this PR, cosmwasm developers would have to serialize their transactions using the following format:

IMPORTANT NOTE: Notice that deserialize is not derived. This is because if you use deserialize with serde tags, your contract code cannot be stored on chain. See this cosmwasm issue (#1443)

use cosmwasm_std::Coin;
use serde::{Deserialize, Serialize};

#[derive(Serialize, Clone, Debug)]
#[serde(tag = "@type")]
pub enum CosmosMessages {
    #[serde(rename = "/cosmos.bank.v1beta1.MsgSend")]
    MsgSend {
        /// Sender's address.
        from_address: String,
        /// Recipient's address.
        to_address: String,
        /// Amount to send
        amount: Vec<Coin>,
    },
    #[serde(rename = "/cosmos.staking.v1beta1.MsgDelegate")]
    MsgDelegate {
        /// Delegator's address.
        delegator_address: String,
        /// Validator's address.
        validator_address: String,
        amount: Coin,
    },
    #[serde(rename = "/cosmos.gov.v1beta1.MsgVote")]
    MsgVote {
        /// Voter's address.
        voter: String,
        /// Proposal's ID.
        proposal_id: u64,
        /// Vote option.
        option: u32,
    },
    #[serde(rename = "/cosmos.gov.v1beta1.MsgSubmitProposal")]
    MsgSubmitProposalLegacy {
        content: Box<CosmosMessages>,
        initial_deposit: Vec<Coin>,
        proposer: String,
    },
    #[serde(rename = "/cosmos.gov.v1beta1.TextProposal")]
    TextProposal { title: String, description: String },
    #[serde(rename = "/cosmos.gov.v1beta1.MsgDeposit")]
    MsgDeposit {
        proposal_id: u64,
        depositor: String,
        amount: Vec<Coin>,
    },
}

#[derive(Serialize, Debug)]
pub struct CosmosTx {
    pub messages: Vec<CosmosMessages>,
}

#[derive(Serialize)]
pub struct InterchainAccountPacketData {
    #[serde(rename = "type")]
    pub type_: u32,
    pub data: Vec<u8>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub memo: Option<String>,
}

Commit Message / Changelog Entry

feat(ica)!: support json tx encoding for interchain accounts

see the guidelines for commit messages. (view raw markdown for examples)

---

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

• Targeted PR against correct branch (see CONTRIBUTING.md).
• Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
• Code follows the module structure standards and Go style guide.
• Wrote unit and integration tests.
• Updated relevant documentation (docs/) or specification (x/<module>/spec/).
• Added relevant godoc comments.
• Provide a commit message to be used for the changelog entry in the PR description for review.
• Re-reviewed Files changed in the Github PR explorer.
• Review Codecov Report in the comment section below once CI passes.

[crodriguezvega]

Fantastic work, @srdtrk! 🔥 🚀

[crodriguezvega]

+1 for the enum type!

[chatton]

LGTM! Great work on this, happy to have those remaining nits in follow ups 👍

[colin-axner]

LGTM!! Nice work @srdtrk 💪

[colin-axner]

not strictly necessary since the controller doesn't do JSON marshaling, what prompted this change?

[srdtrk]

It was your comment that prompted the change: #3796 (comment)

Lmk if you want me to revert the change before I merge today

[colin-axner]

Agree it should be discussed in a separate pr. As a side note, enums are encoded differently between standard json and proto3 json. Currently ICA uses proto3 json for encoding the metadata, if it used standard json this change wouldn't be backwards compatible

The enum string value for proto3 must be the same as the existing string otherwise we will break cross compatibility for opening channels

I would also not backport this change

[damiannolan]

Nice work @srdtrk! LGTM 🚀

out of date review