andromedaprotocol / andromeda-core

Operating System and ADO Smart Contracts
https://andromedaprotocol.io/
38 stars 27 forks source link

feat: Block Info Utils #518

Closed mdjakovic0920 closed 2 months ago

mdjakovic0920 commented 3 months ago

Motivation

This ADO returns current block height as a query result.

Testing

Unit test cases were added.

Version Changes

Version is set at 1.0.0

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The updates to the Andromeda blockchain module enhance the framework for block information utilities, significantly improving the development experience. Key changes include the introduction of a .cargo/config file for command aliases, structured message handling for instantiation and querying, and robust testing utilities. This modular approach improves organization, streamlines workflows, and facilitates easier integration within the Andromeda ecosystem.

Changes

Files Change Summary
contracts/modules/andromeda-block-info-utils/.cargo/config New Cargo aliases for building, testing, and schema generation to enhance development workflow.
contracts/modules/andromeda-block-info-utils/Cargo.toml Defines package metadata, features, and conditional dependencies for modularity and ease of use.
contracts/modules/andromeda-block-info-utils/examples/schema.rs Introduces a main function to generate API schema for smart contracts using the cosmwasm_schema crate.
contracts/modules/andromeda-block-info-utils/src/contract.rs Implements a smart contract with key functionalities: instantiation, execution, querying, and migration.
contracts/modules/andromeda-block-info-utils/src/lib.rs Establishes a modular structure with contract, testing, and mock modules for better organization.
contracts/modules/andromeda-block-info-utils/src/mock.rs Provides a mock implementation of the contract for testing, including instantiation and querying methods.
contracts/modules/andromeda-block-info-utils/src/testing/mock.rs Introduces testing utilities, including mock dependencies and functions for proper initialization and querying.
contracts/modules/andromeda-block-info-utils/src/testing/mod.rs Organizes the testing structure with submodules for mocks and tests.
contracts/modules/andromeda-block-info-utils/src/testing/tests.rs Contains unit tests to validate initialization and querying functionality of the module.
packages/andromeda-modules/src/block_info_utils.rs Defines message structures for blockchain interactions, including InstantiateMsg, ExecuteMsg, and QueryMsg.
packages/andromeda-modules/src/lib.rs Adds a new public module block_info_utils for block information utilities, enhancing modularity.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant C as Cargo
    participant SC as Smart Contract
    participant M as Mock
    participant T as Testing Framework

    Dev->>C: Run command (e.g., "cargo unit-test")
    C->>SC: Execute tests
    SC->>M: Use mock for testing
    M->>SC: Return mocked responses
    SC->>C: Return test results
    C-->>Dev: Show test results

🐰 In code's embrace, a rabbit hops high,
Block info utilities, reaching the sky.
With aliases sweet, and mocks in a row,
We build and we test, letting joy overflow.
In Andromeda's realm, where ideas take flight,
We dance with our code, from morning till 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
joemonem commented 3 months ago

I think this contract could only make sense in the context of IBC, since all contracts of the same chain have access to that value without the need to query it from another contract.

crnbarr93 commented 2 months ago

Closing as this is retrievable via the entry point Env variable.