docs: update toolkit docs

[github-actions[bot]]

This PR contains updates to toolkit from the zeta-chain/toolkit repository.

[vercel[bot]]

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	Sep 12, 2024 0:22am

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

## Walkthrough The recent updates to the OpenAPI specification and protocol message definitions enhance the management of cross-chain transactions. Key modifications include new message types and properties, improved command syntax, and the introduction of various functions and interfaces to facilitate interactions within the ZetaChain ecosystem. ## Changes | File | Change Summary | |------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `public/data/openapi.swagger.yaml` | New definitions for `crosschainProtocolContractVersion` and `crosschainRevertOptions`; added properties `cctx_index` and `created_timestamp` to response types; updated `Cmd` description and added `NoAssetCall` enumeration. | | `src/pages/architecture/modules/crosschain/messages.md` | Expanded `MsgVoteInbound` with new fields for protocol version and revert options; added new messages `MsgMigrateERC20CustodyFunds` and `MsgUpdateERC20CustodyPauseStatus` for fund migration and contract pause management. | | `public/packages/toolkit/Class.ZetaChainClient.md` | Introduced `ZetaChainClient` class with methods for token transfers, deposits, and balance inquiries across chains; includes functionalities for tracking transactions and obtaining gas token addresses. | | `public/packages/toolkit/Function.*` | Added various functions (`deposit`, `getBalances`, `getChainId`, etc.) for managing token operations, retrieving balances, and handling fees; each function includes detailed parameters and return types for enhanced usability. | | `public/packages/toolkit/Interface.*` | Introduced interfaces (`TokenBalance`, `ZetaChainClientParamsBase`) for structured data representation, enhancing type safety and usability within the toolkit. | | `public/packages/toolkit/TypeAlias.*` | Defined type alias `ZetaChainClientParams` for flexible client parameter structures, improving integration capabilities. | | `public/packages/toolkit/index.md` | Comprehensive documentation for the ZetaChain Toolkit, including setup instructions, usage examples, and a categorized list of exported entities. |

---

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 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.