search

warden-protocol / wardenprotocol

Monorepo for the Warden Protocol.
https://wardenprotocol.org
Apache License 2.0
1.1k stars 112 forks source link

Docs chiado changes #1030

Closed ijonele closed 3 weeks ago

ijonele commented 3 weeks ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago
📝 Walkthrough ## Walkthrough The pull request includes updates to several documentation files related to deploying cross-chain applications using Axelar GMP, specifically focusing on deploying EVM and WASM contracts. It introduces a new `BurnableToken` contract and details its functionalities, along with enhancements to the Chiado testnet documentation, including a new overview file. The changes aim to improve clarity and usability for developers, detailing prerequisites, deployment steps, and configuration instructions. ## Changes | File Path | Change Summary | |---------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| | `docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md` | Updated to include a comprehensive guide for deploying EVM and WASM contracts, with detailed steps and prerequisites. | | `/burnable-token/contracts/BurnableToken.sol` | Added `BurnableToken` contract with methods: constructor, `_execute`, and `burnTokens`. | | `/my-wasm-project/src/msg.rs` | Added structs: `GmpMessage`, `Fee` and enum: `ExecuteMsg`. | | `/my-wasm-project/src/lib.rs` | Added functions: `instantiate` and `execute`. | | `docs/developer-docs/docs/operate-a-node/chiado-testnet/chiado-overview.md` | Minor modification in the "Denomination" section, removing outdated information. | | `docs/developer-docs/docs/operate-a-node/chiado-testnet/join-chiado.md` | Streamlined instructions for joining Chiado testnet, maintaining clarity in prerequisites and configurations. | | `docs/developer-docs/docs/operate-a-node/chiado-testnet/whats-new.md` | New file introducing Chiado testnet, outlining key features and changes during migration. | | `docs/developer-docs/docs/tokens/ward-token/distribution.md` | Clarified WARD token distribution details, especially regarding validators and operators. | ## Possibly related PRs - **#447**: The changes in the main PR regarding the deployment of cross-chain applications using Axelar GMP relate to the integration of the Ethereum Virtual Machine (EVM) module, which is crucial for deploying EVM contracts. - **#902**: The updates in the main PR about deploying a WASM contract on Warden are connected to the changes made in this PR, which also focuses on the deployment of WASM contracts and includes modifications to the contract's functionality. - **#965**: The main PR's enhancements for deploying contracts on Chiado align with the updates in this PR, which also focuses on deployment instructions and the transition to the Chiado testnet. - **#971**: The changes in the main PR regarding the deployment of cross-chain applications are related to the updates in this PR, which introduces overview guides for both Chiado and Buenavista, enhancing the context for deployment. - **#998**: The updates in the main PR about the deployment process on Chiado are relevant to this PR, which reflects changes in versioning and terminology related to the Chiado testnet. ## Suggested labels `keychain` ## Suggested reviewers - jlehtimaki

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. ### 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.
vercel[bot] commented 3 weeks ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **warden-help-center** | ⬜️ Ignored ([Inspect](https://vercel.com/qrdo-foundation/warden-help-center/ACZx4keiUNbo4YXiKtzBuv8faDDr)) | [Visit Preview](https://warden-help-center-git-docs-chiado-changes-qrdo-foundation.vercel.app) | | Nov 5, 2024 0:27am |