coderabbitai[bot]
commented
3 months ago Walkthrough
## Walkthrough The recent updates to the `@zetachain/toolkit` include comprehensive documentation enhancements for the `ZetaChainClient` class and its associated methods. This enhancement provides detailed guidelines for functionalities such as cross-chain token transactions, balance retrieval, and fee calculation. Additionally, the documentation structure has been improved, making it easier for developers to understand and efficiently utilize the toolkit's features. ## Changes | Files | Change Summary | |-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `docs/Class.ZetaChainClient.md` | Introduced documentation for the `ZetaChainClient` class, detailing its constructor and key methods including deposit, withdraw, getBalances, and more. | | `docs/Function.*.md` | Newly created documentation files for various functions (e.g., `deposit`, `getBalances`, `getChainId`) explaining their parameters, return types, and usage context. | | `docs/Interface.*.md` | Added documentation for interfaces like `TokenBalance` and `ZetaChainClientParamsBase`, outlining the properties and their types for better integration. | | `package.json` | Updated dependencies for improved documentation generation and compatibility, including a new command structure for building documentation. | | `typedoc.json` | New configuration for TypeDoc, enhancing the documentation generation process with settings for file flattening and Markdown support. | | `docs/index.md` | Comprehensive overview and navigation for the ZetaChain Toolkit, linking to all relevant classes, interfaces, and functions documented. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant Client as ZetaChainClient participant Network as ZetaChain Network User->>Client: deposit({amount, chain, ...}) Client->>Network: process deposit transaction Network-->>Client: return transaction details Client-->>User: provide transaction confirmation ``` ```mermaid sequenceDiagram participant User participant Client as ZetaChainClient participant Network as ZetaChain Network User->>Client: withdraw({amount, recipient, zrc20}) Client->>Network: process withdrawal transaction Network-->>Client: return transaction details Client-->>User: provide transaction confirmation ```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?
fadeev
Summary by CodeRabbit
New Features
ZetaChainClient, including methods for deposits, withdrawals, balance retrieval, and cross-chain transfers.getQuote,getFees, andsendZetato facilitate various transaction operations within the ZetaChain ecosystem.Bug Fixes
Documentation
Chores