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-407][OTE-409][OTE-426]Update wasm bindings to use custom encoder #1809

Merged
merged 3 commits into from
Jul 2, 2024

Conversation

affanv14
Copy link
Contributor

@affanv14 affanv14 commented Jun 28, 2024

Changelist

  • Updates wasm keeper to use custom encoder
  • Updates message schemas for rust and golang
  • Adds rust tests for schemas
  • GetSigners is called by the default message handler, we dont need to add this ourselves

Test Plan

Added rust unit tests

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
Contributor

coderabbitai bot commented Jun 28, 2024

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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 testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 testing code 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 and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@affanv14 affanv14 force-pushed the affan/update-cosmwasm branch from c9706da to 1588285 Compare June 28, 2024 15:51
@affanv14 affanv14 changed the title Update wasm bindings to use custom encoder [OTE-407][OTE-409][OTE-426]Update wasm bindings to use custom encoder Jun 28, 2024
return m.cancelOrder(ctx, contractAddr, contractMsg.CancelOrder)
}
return nil, nil, wasmvmtypes.InvalidRequest{Err: "Unknown custom message"}
func CustomEncoder(sender sdk.AccAddress, msg json.RawMessage) ([]sdk.Msg, error) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: rename to EncodeDydxCustomWasmMessage for parallelism with native encoders

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, can we document that sender here is enforced by wasmd to be the contractAddr, and point to relevant code here

Copy link
Contributor

Choose a reason for hiding this comment

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

Did we address the 2nd comment above?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

case customMessage.CancelOrder != nil:
return EncodeCancelOrder(sender, customMessage.CancelOrder)
default:
return nil, wasmvmtypes.InvalidRequest{Err: "Unknown Dydx Wasm Message"}
}
Copy link
Contributor

@teddyding teddyding Jul 1, 2024

Choose a reason for hiding this comment

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

Can we add a TODO item in Linear to add E2E test for

  • Successful contract dispatch of PlaceOrder mesage
  • Contract cannot send DepositToSubaccount message on behalf of another address?
    Up to you on what's the best way to test this

Copy link

@webmaster128 webmaster128 left a comment

Choose a reason for hiding this comment

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

Some initial thoughts

protocol/dydx-cosmwasm/src/msg.rs Outdated Show resolved Hide resolved
assert_eq!(
String::from_utf8_lossy(&json),
r#"{"place_order":{"subaccount_number":0,"client_id":0,"order_flags":0,"clob_pair_id":0,"side":1,"quantums":10000000000,"subticks":10000000000,"good_til_block_time":0,"time_in_force":1,"reduce_only":false,"client_metadata":0,"condition_type":1,"conditional_order_trigger_subticks":10000000000}}"#
);

Choose a reason for hiding this comment

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

Are you sure you want to keep the enums (OrderSide::Buy, OrderTimeInForce::Ioc, OrderConditionType::StopLoss) as integers?

You can turn them into strings in JSON like this. But that's a matter of taste.

  1. make order (de)serialize CosmWasm/cosmwasm#2174
  2. tests and docs for Order serialization CosmWasm/cosmwasm#2177

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That is what is expected from the protocol side - so wanted to keep things consistent

r#"{"cancel_order":{"subaccount_number":0,"client_id":0,"order_flags":0,"clob_pair_id":0,"good_til_block_time":0}}"#
);
}
}

Choose a reason for hiding this comment

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

Seems like you are not running cargo fmt. Would be good to do that in editor and do CI checks

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good callout! added a task for myself to do this

protocol/wasmbinding/bindings/msg.go Show resolved Hide resolved
protocol/wasmbinding/bindings/msg.go Outdated Show resolved Hide resolved
@pinosu
Copy link

pinosu commented Jul 2, 2024

LGTM

@affanv14 affanv14 force-pushed the affan/update-cosmwasm branch from 77301c0 to 2c4634f Compare July 2, 2024 17:59
@affanv14 affanv14 merged commit 3a9abc3 into feature/cosmwasm Jul 2, 2024
7 of 16 checks passed
@affanv14 affanv14 deleted the affan/update-cosmwasm branch July 2, 2024 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

4 participants