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

Store the Funding Trading Bridge smart contract as part of the umber upgrade. #2102

Merged
merged 6 commits into from
Jul 19, 2024

Conversation

SpicyLemon
Copy link
Contributor

@SpicyLemon SpicyLemon commented Jul 19, 2024

Description

This PR updates the umber upgrade to also store a smart contract provided by Figure.


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.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

Summary by CodeRabbit

  • New Features

    • Added support for storing WebAssembly (WASM) smart contracts.
    • Introduced functionalities to read, log, and execute storage operations for specific WASM contracts.
  • Bug Fixes

    • Enhanced error handling within smart contract storage processes to capture potential failures effectively.
  • Documentation

    • Updated the changelog to include detailed information about the umber upgrade and storage functionalities.

@SpicyLemon SpicyLemon requested a review from a team as a code owner July 19, 2024 22:30
Copy link
Contributor

coderabbitai bot commented Jul 19, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The recent changes enhance the application by introducing support for storing WebAssembly (WASM) smart contracts. Key functionalities include new methods for storing and executing these contracts, improved error handling, and comprehensive testing scenarios. The changelog has also been updated to document these enhancements, ensuring users are well-informed about the latest capabilities related to the umber upgrade.

Changes

File Change Summary
CHANGELOG.md Added entry for storing Figure Funding Trading Bridge Smart Contract; removed old warnings about config.
app/upgrades.go Introduced storeWasmCode and executeStoreCodeMsg functions for WASM contract storage; enhanced logging.
app/upgrades_test.go Added wrappedWasmMsgSrvr for robust testing; new test methods to validate smart contract storage behavior.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant WASM_MsgSrvr
    User->>App: Request to store WASM contract
    App->>WASM_MsgSrvr: StoreCode(msg)
    WASM_MsgSrvr-->>App: Return success/error response
    App-->>User: Return confirmation/result
Loading

🐰✨
In the meadow, we'll store our code,
WASM contracts, our new abode.
With each log, our progress sings,
Celebrating the joy that change brings!
Hop along, the future's bright,
Together we’ll code through day and night! 🌟


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 Configuration 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.

iramiller
iramiller previously approved these changes Jul 19, 2024
Copy link
Member

@iramiller iramiller left a comment

Choose a reason for hiding this comment

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

surprisingly small/tidy update to make this happen

@SpicyLemon
Copy link
Contributor Author

surprisingly small/tidy update to make this happen

Yeah. It ended up being a lot easier than I expected.

Taztingo
Taztingo previously approved these changes Jul 19, 2024
@SpicyLemon
Copy link
Contributor Author

I forced the umber upgraded on a mainnet quicksync and it has these lines in the log:

4:55PM INF Storing the Funding Trading Bridge smart contract.
4:55PM INF Smart contract stored with codeID: 39 and checksum: "ffaa4f5827f722ce12af244bf8c795217c532fbc4e3b6ff80f305cbd8f7364a3".
4:55PM INF Done storing the Funding Trading Bridge smart contract.

That's using the non-release version of the smart contract, though, so the actual checksum will end up being different. But it looks like it works just fine.

Copy link
Member

@iramiller iramiller left a comment

Choose a reason for hiding this comment

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

Nice solution all around.

@SpicyLemon SpicyLemon enabled auto-merge (squash) July 19, 2024 23:11
@SpicyLemon SpicyLemon merged commit 387ffe5 into main Jul 19, 2024
31 checks passed
@SpicyLemon SpicyLemon deleted the dwedul/store-wasm-in-umber branch July 19, 2024 23:16
SpicyLemon added a commit that referenced this pull request Jul 19, 2024
…upgrade. (#2102)

* Add the rc of the contract to load.

* Store the wasm code as part of the umber upgrade.

* Add changelog entry.

* Add some missing TODO comments and lower-case smart contract in the log messages.

* Get v1.0.3 of the smart contract, which should be the one to use.
SpicyLemon added a commit that referenced this pull request Jul 19, 2024
…upgrade. (#2102) (#2104)

* Add the rc of the contract to load.

* Store the wasm code as part of the umber upgrade.

* Add changelog entry.

* Add some missing TODO comments and lower-case smart contract in the log messages.

* Get v1.0.3 of the smart contract, which should be the one to use.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants