search

zeta-chain / docs

Documentation for ZetaChain
https://www.zetachain.com/docs/
MIT License
74 stars 60 forks source link

docs: update module and OpenAPI specs from the node repo #425

Closed github-actions[bot] closed 3 months ago

github-actions[bot] commented 3 months ago

This PR contains updates to the Cosmos SDK module and OpenAPI specifications from the zeta-chain/node repository.

Summary by CodeRabbit

vercel[bot] commented 3 months ago

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

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 8, 2024 1:56pm
coderabbitai[bot] commented 3 months ago
Walkthrough ## Walkthrough This update introduces multiple new modules and protocol buffer messages across several components of the blockchain architecture. Key features include enhanced governance for emissions management, cross-chain transaction tracking, observer management, and fungible token operations. These changes aim to streamline transaction processes, improve authorization mechanisms, and facilitate better control over blockchain parameters, ultimately enhancing the efficiency and functionality of the system. ## Changes | File Path | Change Summary | |----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `src/pages/architecture/modules/authority/messages.md`, `src/pages/architecture/modules/crosschain/messages.md`, `src/pages/architecture/modules/emissions/messages.md`, `src/pages/architecture/modules/fungible/messages.md`, `src/pages/architecture/modules/lightclient/messages.md`, `src/pages/architecture/modules/observer/messages.md` | Multiple new protocol buffer messages added to define functionalities related to policy management, cross-chain tracking, emissions, fungible tokens, header verification, and observer management. | | `src/pages/architecture/modules/crosschain/overview.md`, `src/pages/architecture/modules/emissions/overview.md`, `src/pages/architecture/modules/fungible/overview.md`, `src/pages/architecture/modules/observer/overview.md` | New overview documents describe the purpose and functionality of the respective modules, detailing their roles in transaction management and governance within the system. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant Admin participant Observer participant CrosschainModule participant EmissionsModule participant FungibleModule User->>CrosschainModule: Initiate cross-chain transaction Admin->>CrosschainModule: Approve outbound transaction Observer->>CrosschainModule: Vote on transaction CrosschainModule->>User: Confirm transaction completion Admin->>EmissionsModule: Update emission parameters User->>EmissionsModule: Withdraw emissions EmissionsModule->>User: Confirm withdrawal User->>FungibleModule: Deploy ZRC20 token Admin->>FungibleModule: Update token parameters ``` This diagram illustrates the basic interactions within the cross-chain module, emissions module, and fungible module, showcasing user and admin roles in managing transactions and token operations.

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.