Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[OTE-163] Fix query: add amino.oneof option to clob oneof metadata #1077

Merged
merged 2 commits into from Feb 16, 2024

Conversation

teddyding
Copy link
Contributor

@teddyding teddyding commented Feb 15, 2024

Changelist

The v4.x binary is getting a cannot marshal response proposal when used to query a governance proposal that includes the Clob object.
For instance, I submitted a proposal with a single message MsgUpdateClobPair to the local testnet, and:

$ dydxprotocold query gov proposal 1 --node tcp://localhost:36657

Error: cannot marshal response proposal:{id:1  messages:{type_url:"/dydxprotocol.clob.MsgCreateClobPair"  value:"\n+dydx10d07y265gmmuvt4z0w9aw880jnsr700jnmapky\x12\x12\x08#\x12\x02\x08# \xc0\x84=(\xc0\x84=0\x118\x05"}  status:PROPOSAL_STATUS_REJECTED  final_tally_result:{yes_count:"0"  abstain_count:"0"  no_count:"0"  no_with_veto_count:"0"}  submit_time:{seconds:1708031604  nanos:779135000}  deposit_end_time:{seconds:1708031904  nanos:779135000}  total_deposit:{denom:"adv4tnt"  amount:"10000000000000000000000"}  voting_start_time:{seconds:1708031604  nanos:779135000}  voting_end_time:{seconds:1708031904  nanos:779135000}  title:"Add AAVE perpetual market"  summary:"Add the `x/prices`, `x/perpetuals` and `x/clob` parameters needed for a BTC-UTC perpetual market. Create the market in `INITIALIZING` status and transition it to `ACTIVE` status after 3600 blocks."  proposer:"dydx199tqg4wdlnu4qjlxchpd7seg454937hjrknju4"  failed_reason:"proposal did not get enough votes to pass"}: unexpected end of JSON input

However, querying with v3.x against the same testnet works fine.

By adding a bunch of logs, I discovered that a silent err seen but not logged out here:

field perpetual_clob_metadata within a oneof must have the amino.oneof_type_name option set
cosmossdk.io/x/tx/signing/aminojson.getOneOfNames
	cosmossdk.io/x/tx@v0.13.0/signing/aminojson/options.go:81
cosmossdk.io/x/tx/signing/aminojson.Encoder.marshalMessage
······

It seems like autocli introduced in Cosmos v0.50 uses the aminojson package to marshal messages, which results in a regression.

Hence in this PR we fix by adding required options on the ClobPair proto. This is backwards compatible and the easiest fix

Test Plan

Successfully queried for proposal including ClobPair on a local testnet running on v4.x.

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Copy link

linear bot commented Feb 15, 2024

Copy link

coderabbitai bot commented Feb 15, 2024

Walkthrough

The update primarily focuses on enhancing the clob_pair.proto file within the dYdX protocol. It introduces an import for amino.proto to leverage its functionalities, and it revises the metadata field in the ClobPair message. This revision includes adding amino.oneof_name annotations for two types of metadata: PerpetualClobMetadata and SpotClobMetadata, indicating a more versatile handling of metadata depending on the CLOB pair type.

Changes

File Change Summary
.../clob/clob_pair.proto Added import for amino.proto; Modified metadata field in ClobPair message to include amino.oneof_name annotations for PerpetualClobMetadata and SpotClobMetadata.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@teddyding teddyding changed the title [OTE-163] add amino.oneof option to clob oneof metadata [OTE-163] Fix query: add amino.oneof option to clob oneof metadata Feb 15, 2024
@teddyding teddyding marked this pull request as ready for review February 15, 2024 23:48
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 71ce2c6 and c360543.
Files ignored due to path filters (1)
  • protocol/x/clob/types/clob_pair.pb.go is excluded by: !**/*.pb.go
Files selected for processing (1)
  • proto/dydxprotocol/clob/clob_pair.proto (2 hunks)
Additional comments: 2
proto/dydxprotocol/clob/clob_pair.proto (2)
  • 4-4: Ensure the amino/amino.proto file exists and is accessible from this path. If it's a third-party dependency, verify that it's included in the project dependencies.
  • 34-35: The addition of amino.oneof_name annotations for PerpetualClobMetadata and SpotClobMetadata within the metadata field is correct and aligns with the PR objectives to fix the marshaling issue. Ensure that all downstream systems that consume this protobuf definition are compatible with these changes.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 71ce2c6 and 2545733.
Files ignored due to path filters (1)
  • protocol/x/clob/types/clob_pair.pb.go is excluded by: !**/*.pb.go
Files selected for processing (1)
  • proto/dydxprotocol/clob/clob_pair.proto (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • proto/dydxprotocol/clob/clob_pair.proto

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 2545733 and e97359b.
Files selected for processing (1)
  • proto/dydxprotocol/clob/clob_pair.proto (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • proto/dydxprotocol/clob/clob_pair.proto

@teddyding teddyding merged commit 934a98e into main Feb 16, 2024
24 checks passed
@teddyding teddyding deleted the td/fix-clob-query branch February 16, 2024 19:45
mergify bot pushed a commit that referenced this pull request Feb 16, 2024
…1077)

* Add amino field for ClobPair oneof fields

* proto format

(cherry picked from commit 934a98e)
teddyding added a commit that referenced this pull request Feb 17, 2024
…1077) (#1079)

* Add amino field for ClobPair oneof fields

* proto format

(cherry picked from commit 934a98e)

Co-authored-by: Teddy Ding <teddy@dydx.exchange>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants