New guide: Use Hyperlane TIA as gas token

assafmo commented 5 months ago

Mainly add "Use Hyperlane TIA as gas token" as an alternative to IBC guide, but also:

Add IBC warning to guides/use-tia-for-gas.md
Reformat tutorials/cosmwasm.md (and add --depth 1 to all the git clones)

Summary by CodeRabbit

Release Notes

New Features
- Integrated a Token Factory module to enhance token management capabilities.
- Introduced a multi-service architecture for deploying the Hyperlane application via Docker.
- Added comprehensive configuration files for managing assets, validators, and governance in a blockchain environment.
- Developed detailed guides for utilizing Hyperlane as a gas token in CosmWasm rollups.
Bug Fixes
- Updated gas prices to reflect current transaction costs.
Documentation
- Created and updated guides and markdown files to assist developers in implementing and using the new features effectively.

coderabbitai[bot] commented 5 months ago

[!NOTE]

Reviews paused

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.

@coderabbitai review to trigger a single review.

Walkthrough

The changes introduce a Token Factory module into the application, enhancing its functionality for managing tokens. Additionally, a comprehensive configuration for deploying a Hyperlane application is established, detailing services, network settings, and validator configurations. The integration of TIA as a gas token is emphasized, with updates to documentation and configuration files to support its use in transactions across multiple blockchain networks.

Changes

File Path	Change Summary
`guides/assets/hyperlane-use-tia-for-gas/*.diff`	Integration of Token Factory module, including updates to `WasmApp`, permissions, and module registration.
`guides/assets/hyperlane-use-tia-for-gas/docker-compose.yml`	Defines a multi-service architecture for a Hyperlane application with specific configurations for each service.
`guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`	New YAML configuration for a multi-signature governance model, detailing network settings and hooks.
`guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`	Configuration for blockchain networks, including deployment settings for an Interchain Security Model.
`guides/assets/hyperlane-use-tia-for-gas/relayer.json`	Configuration for a relayer service, defining relay chains and whitelist for cross-domain interactions.
`guides/assets/hyperlane-use-tia-for-gas/stride-internal-1.json`	JSON object defining artifacts related to the Hyperlane protocol, including unique identifiers.
`guides/assets/hyperlane-use-tia-for-gas/utia-localwasm.json`	Configuration for a bridged native asset, specifying ownership and denomination.
`guides/assets/hyperlane-use-tia-for-gas/utia-stride.json`	Configuration for a collateral native asset, detailing ownership and IBC token references.
`guides/assets/hyperlane-use-tia-for-gas/validator.localwasm.json`	Validator configuration for the localwasm chain, including database and checkpoint syncer settings.
`guides/assets/hyperlane-use-tia-for-gas/validator.strideinternal1.json`	Validator configuration for the strideinternal1 chain, outlining database and synchronization methods.
`guides/assets/hyperlane-use-tia-for-gas/wasmd.Dockerfile`	Dockerfile for building the `wasmd` application with necessary tools and configurations.
`guides/hyperlane-use-tia-for-gas.md`	Guide on integrating Hyperlane as a gas token mechanism, detailing setup and deployment procedures.
`guides/use-tia-for-gas.md`	Updated document with trust assumptions and gas price changes related to TIA usage.
`tutorials/cosmwasm.md`	Grammatical corrections and formatting adjustments to improve readability.

Possibly related PRs

#386: The tutorial on using TIA as a gas token is directly related to the main PR, which integrates the Token Factory module that will likely utilize TIA for gas transactions.
#387: This PR moves documentation about using TIA for gas to the guides section, which aligns with the main PR's focus on integrating TIA into the application.
#388: The update to the guide title regarding TIA as a gas token connects to the main PR's changes, as both involve the use of TIA in the context of rollups.
#426: This PR enhances the documentation for using the Rollkit CLI in relation to TIA, which is relevant to the main PR's integration of the Token Factory that may interact with TIA.
#427: Similar to #426, this PR updates commands in the guide to use Rollkit instead of gmd, which is pertinent to the main PR's focus on TIA as a gas token in the rollup context.

Poem

🐇 In the meadow where tokens play,
A factory blooms, brightening the day.
With TIA as gas, we hop and cheer,
Cross-chain journeys, adventures near!
Docker and YAML, all set to go,
In Hyperlane's dance, we joyfully flow! 🌼

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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

yarikbratashchuk commented 5 months ago

@assafmo what's missing? when ready for review?

assafmo commented 5 months ago

Still on it. Will tag you when it's ready.

yarikbratashchuk commented 2 months ago

@assafmo, when do you plan to finish it?

assafmo commented 1 month ago

Hey guys, this is ready for a review

jcstein commented 1 month ago

please review and resolve Coderabbit suggestions as you see fit @assafmo ! some are junk and can definitely be thrown out, but some may be useful.

MSevey commented 1 month ago

@coderabbitai ignore

coderabbitai[bot] commented 1 month ago

@coderabbitai ignore

:white_check_mark: Actions performed

Reviews paused.

assafmo commented 1 month ago

The tutorial should inline the assets. Otherwise the tutortial is at risk of breaking without warning due to the wgets targeting code not on the docs website.

Yeah, there are a lot of new configs that we introduce here, and initially we had it inline but decided to do it using wget because the entire guide was becoming echo "$HUGE_CONFIG" > config.json.

Lmk if you want me to restore the old way, keep the wget way, or do anything else. We'll fix all the code review comments in the next few days.

MSevey commented 1 month ago

The tutorial should inline the assets. Otherwise the tutortial is at risk of breaking without warning due to the wgets targeting code not on the docs website.

Yeah, there are a lot of new configs that we introduce here, and initially we had it inline but decided to do it using wget because the entire guide was becoming echo "$HUGE_CONFIG" > config.json.

Lmk if you want me to restore the old way, keep the wget way, or do anything else. We'll fix all the code review comments in the next few days.

I think all the assets should live on the branch of the fork I recommended. i.e. Stride-Labs/wasmd. Then the first step of cloning that repo and checking out the rollkit branch handles all assets and code files. Additionally this could keep everything in one place for updates and testing in the future.

rollkit / docs