joemonem commented 1 month ago

Motivation

Part of [Q4 | RC1] IBC / Release 1 This OS contract, ibc-registry, stores a mapping of String to DenomInfo with the ability to query the mapping.

Implementation

service_address is set by the user during Instantiation; It's the only address (alongside the contract owner) that can call StoreDenomInfo. The structs are as follows:

pub struct DenomInfo {
    pub path: String,
    pub base_denom: String,
}
pub struct IBCDenomInfo {
    pub denom: String,
    pub denom_info: DenomInfo,
}

There's only one Map in state:

pub const REGISTRY: Map<String, DenomInfo> = Map::new("registry");

The two queries are:

    #[returns(DenomInfoResponse)]
    DenomInfo { denom: String },
    #[returns(AllDenomInfoResponse)]
    AllDenomInfo {
        limit: Option<u64>, // Defaults to 100,
        start_after: Option<u64>,
    },

Testing

Unit test that tests validate_denom. Integration test that goes through instantiation, execution, and querying the results. Also tests authorization.

Version Changes

Should this be set as 2.0.0 or 1.0.0?

Notes

Should we remove owner's ability to call StoreDenomInfo?

Future work

Needs a README file

Summary by CodeRabbit

Release Notes

New Features
- Introduced the IBC (Inter-Blockchain Communication) registry for managing denomination information.
- Enhanced interoperability with the addition of the IBC Registry ADO.
- Implemented new error handling capabilities for better clarity in denomination validation.
Bug Fixes
- Enhanced error messages for invalid denominations to include more detailed information.
Testing Enhancements
- Added integration tests for the IBC registry, ensuring proper functionality for storing and querying denominations.
- Introduced a mock implementation for easier testing of the IBC Registry contract.
- Expanded the testing framework to include new modules and functionalities related to the IBC registry.
Documentation
- Updated configuration files to streamline build and testing processes.

coderabbitai[bot] commented 1 month ago

Walkthrough

This pull request introduces multiple enhancements to the Andromeda project, primarily focusing on the implementation of the IBC Registry ADO. Key changes include the addition of a new contract for managing IBC denomination information, updates to error handling structures, and the introduction of integration tests to ensure the functionality of the new features. The modifications also encompass configuration improvements for easier project management and testing capabilities.

Changes

File Path	Change Summary
`contracts/os/andromeda-ibc-registry/.cargo/config`	Added command aliases for building, testing, and schema generation.
`contracts/os/andromeda-ibc-registry/Cargo.toml`	Defined package metadata, dependencies, and features for the `andromeda-ibc-registry` package.
`contracts/os/andromeda-ibc-registry/src/contract.rs`	Implemented core functionalities for the IBC registry, including instantiation, execution, and querying.
`contracts/os/andromeda-ibc-registry/src/lib.rs`	Added public modules for `contract`, `state`, and `testing`, enhancing modularity.
`contracts/os/andromeda-ibc-registry/src/mock.rs`	Developed a mock implementation for testing the IBC Registry contract.
`contracts/os/andromeda-ibc-registry/src/state.rs`	Introduced a persistent storage map for managing denomination information.
`contracts/os/andromeda-ibc-registry/src/testing/mod.rs`	Added a new module for unit and integration tests related to the IBC registry.
`contracts/os/andromeda-ibc-registry/src/testing/tests.rs`	Implemented a unit test for the `instantiate` function of the IBC Registry.
`packages/andromeda-data-storage/src/primitive.rs`	Modified error handling for empty denomination validation to include a message field.
`packages/std/src/error.rs`	Introduced new error variants and modified existing ones for better error reporting.
`packages/std/src/os/ibc_registry.rs`	Added structures and functions for managing IBC denominations and processing AMP packets.
`packages/std/src/os/mod.rs`	Introduced a new public module for the IBC registry.
`tests-integration/Cargo.toml`	Added dependency for `andromeda-ibc-registry` with testing feature for integration tests.
`tests-integration/tests/ibc_registry.rs`	Implemented integration tests for storing and querying denomination information in the IBC registry.
`tests-integration/tests/mod.rs`	Added a new test module for the IBC registry.

Possibly related PRs

#441: The main PR introduces the IBC Registry ADO, which expands the functionality of the project by adding a new component related to interoperability.
#507: The Set Amount Splitter ADO focuses on distributing funds to specified recipients, which is conceptually similar to the IBC Registry ADO's goal of managing interoperability.
#513: The Boolean Storage ADO introduces a new data management capability, complementing the IBC Registry ADO's functionality.
#519: The DateTime ADO provides current time and day information, which could be relevant for timestamping transactions in the IBC Registry ADO.
#553: This PR addresses permissioning issues, crucial for the security and integrity of the IBC Registry ADO.

Suggested labels

ci: skip-changelog

🐰 In the garden, changes bloom,
New errors handled, dispelling gloom.
IBC registry, a wondrous feat,
With tests to ensure, our code's complete!
Hops of joy, we celebrate,
In Andromeda's world, we innovate! 🌼

Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 6092b7165ae63108f2f61e8ca3a39ae389ed78c0 and 893541f06be95f70fbaa64aec981e67b55f5b479.

Files selected for processing (4)

* contracts/os/andromeda-ibc-registry/src/contract.rs (1 hunks) * packages/std/src/os/economics.rs (0 hunks) * packages/std/src/os/ibc_registry.rs (1 hunks) * tests-integration/tests/ibc_registry.rs (1 hunks)

Files not reviewed due to no reviewable changes (1)

* packages/std/src/os/economics.rs

Files skipped from review as they are similar to previous changes (3)

* contracts/os/andromeda-ibc-registry/src/contract.rs * packages/std/src/os/ibc_registry.rs * tests-integration/tests/ibc_registry.rs

--- 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 , please review it.` -- `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` -- `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### 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.

crnbarr93 commented 1 month ago