Rosetta: more user guide and troubleshooting

[robert-zaremba]

Summary

In v0.43 release has a first production ready Rosetta client integrated. However we are missing proper documentation about the setup and best practice.

Problem Definition

When we were trying to run and integrate Rosetta, we encounter some problems. Let's have a proper guide for Rosetta API

Proposal

We should provide:

• setup instructions
• user guide (how to use rosetta)
• troubleshotting

---

For Admin Use

• Not duplicate issue
• Appropriate labels applied
• Appropriate contributors tagged
• Contributor assigned/self-assigned

[albertchon]

We've been facing this issue #9488 with Rosetta breaking when processing a block containing a transaction that creates a new denom.

This would need to be fixed in order for Rosetta to be compatible with the Gravity bridge, as new denoms are created and minted when new ERC-20 tokens are transferred from Ethereum to the Gravity module for the first time.

[fdymylja]

We've been facing this issue #9488 with Rosetta breaking when processing a block containing a transaction that creates a new denom.

This would need to be fixed in order for Rosetta to be compatible with the Gravity bridge, as new denoms are created and minted when new ERC-20 tokens are transferred from Ethereum to the Gravity module for the first time.

We have discussed about current Rosetta implementation issues here: regen-network/regen-ledger#352 (comment)

Regarding newly minted denoms, it's a known issue but unfortunately Coinbase is not being responsive on how to address this use case. (NOTE: this fails at rosetta-cli level only, if you query anything using the rosetta client you won't encounter any issue.)

[robert-zaremba]

We have discussed about current Rosetta implementation issues here: regen-network/regen-ledger#352

I know, @fdymylja - I think that it's better that the person who is in charge of Rosetta will handle it or re-delegate. For most of us it will be re-engineering to go through the process.

[noandrea]

Summing up the rosetta history, the original PR that includes the Rosetta support within the cosmos-sdk supports the stargate release series.

The functionality and how to use it has been documented in the relevant ADR and in the article published by @fdymylja.
Tests are also implemented as well following the rosetta-cli specs.

The issue emerged with the regent-testnet is that the testnet was set-up with a v0.42.x version and later upgraded to a 0.43-dev version (that included the rosetta integration), but there has been a incompatible change here that caused an issue related to interpreting protobuf messages encoded before that version. (this has been pointed out by @fdymylja in the comment above)

The current status as I see is that the protofile breanking change has been rolled back yesterday (see upgrade.proto history)
and I assume now it should be possible to correctly interpret messages from versions < v0.43

Also the non-zero default fees pr had some impact with rosetta but AFAICS the issue was resolved.

Giving the fact that the upgrade.proto breaking change has been reverted, I assume that if we dump/reload the testnet node, rosetta should work without as expected.

I'll follow up on this first thing next week.

[noandrea]

@anilcse what is the current status of the regen-devnet-6-4 ?

As mentioned before the proto files have being going through some changes and I believe at this point would be better to dump/restore the chain data from the latest v0.43 release or to restart the testnet.
What do you think @anilcse ?

@robert-zaremba do you know if any more changes are undergoing on the protobuf level?
it is somewhat difficult to test on a moving target

[clevinson]

@anilcse @robert-zaremba any update here? Would be great to make sure @noandrea has what he needs to make sure testing is successful.

[anilcse]

@anilcse @robert-zaremba any update here? Would be great to make sure @noandrea has what he needs to make sure testing is successful.

There's an issue with migration (pruning setting is causing some issues). I am still looking for a fix.

[robert-zaremba]

@noandrea We are planning small x/bank changes. We will try to to add sdk.Dec support (but not sure if this will happen). The only thing we merged is #9618 -- addition of URI and URIHash to bank.Metadata.

[robert-zaremba]

For the troubleshooting section, @anilcse - could you list here (simple bullet-points) of the things we had a problem with? So future users won't have the same problems.

[anilcse]

For the troubleshooting section, @anilcse - could you list here (simple bullet-points) of the things we had a problem with? So future users won't have the same problems.

It found out to be an issue with our upgrade handler integration and not the issue from pruning settings. Thanks to @AmauryM . We were checking for a wrong upgrade-name for new store migrations and it caused the issue.

[robert-zaremba]

@anilcse - ok, so is there anything else to mention in the troubleshooting for the future users? If not then we can have that section empty (or not have it at all).

[anilcse]

We can leave it empty for now and add when we find out specific issues. For now we can mention about cross checking directory structure and simlink i.e., current binary version?