warden-protocol / wardenprotocol

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

feat(spaceward): reduce calls to evm endpoint #1068

Closed alex-nax closed 2 weeks ago

alex-nax commented 2 weeks ago

add json-rpc batch; tweak queryClient settings; add invalidate cache on user transactions;

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago
📝 Walkthrough ## Walkthrough The pull request introduces significant updates across multiple files, primarily focusing on enhancing dependency management, improving state handling, and refining transaction processes. Key changes include the addition of new dependencies in `package.json`, modifications to query client configurations, and updates to components for better integration with the query client and blockchain interactions. The introduction of new types and functions, particularly related to WAGMI and Web3-Onboard, further supports improved wallet management and transaction handling. ## Changes | File Path | Change Summary | |---------------------------------------------|--------------------------------------------------------------------------------------------------------| | `spaceward/package.json` | Added dependencies: `@wagmi/core` (2.10.4), `@web3-onboard/common` (2.4.2), `eventemitter3` (5.0.1), `joi` (17.13.3); removed `@web3-onboard/wagmi` (2.0.1). | | `spaceward/src/App.tsx` | Updated `QueryClient` configuration: replaced `refetchInterval` with `staleTime`; modified `Web3Onboard` initialization to use an object for `transports`. | | `spaceward/src/features/actions/Action.tsx` | Added `queryKey` parameter to `Action` function; integrated `queryClient` to invalidate queries post-vote. | | `spaceward/src/features/actions/Actions.tsx`| Updated `Action` component to accept `queryKey` prop from `useActionsByAddress` hook. | | `spaceward/src/features/actions/ApproveSidebar.tsx` | Added `queryKey` from `useActionsByAddress` and integrated `queryClient` for cache invalidation post-vote. | | `spaceward/src/features/actions/StatusSidebar.tsx` | Enhanced transaction handling and error reporting; added asynchronous `checkAction` function for action status querying. | | `spaceward/src/features/actions/hooks.ts` | Introduced `getActionByIdQueryOptions` function and updated `QueuedAction` interface to include new properties. | | `spaceward/src/features/actions/util.ts` | Added `getStatusDefault` function; refined `getActionHandler` to include `queryKeys`. | | `spaceward/src/features/intents/hooks.ts` | Updated `useRules` hook to include `queryClient` for query invalidation after rule updates. | | `spaceward/src/features/modals/SendAssets.tsx` | Streamlined address validation; updated error handling in `submit` function. | | `spaceward/src/features/modals/util.ts` | Refined `buildTransaction` function with improved error handling and gas limit calculations. | | `spaceward/src/features/spaces/NoSpaces.tsx` | Added `queryKey` prop to `NoSpaces` component; included `useEffect` for balance query invalidation. | | `spaceward/src/features/spaces/SpaceSelector.tsx` | Updated `sendMsgNewSpace` to await contract write and invalidate queries post-operation. | | `spaceward/src/hooks/query/warden.ts` | Enhanced `useReadContract` with `useWatchContractEvent`; updated `useSpaces` functions for clarity. | | `spaceward/src/pages/Root.tsx` | Updated `useSpacesByOwner` to return `queryKey`, enhancing interaction with `NoSpaces` component. | | `spaceward/src/utils/contract.ts` | Updated `handleContractWrite` to use `waitForTransactionReceipt` directly, improving transaction handling. | | `spaceward/src/utils/web3-onboard/wagmi/index.ts` | Introduced module for WAGMI integration with Web3-Onboard, including various wallet management functions. | | `spaceward/src/utils/web3-onboard/wagmi/types.ts` | Defined TypeScript types for WAGMI integration. | | `spaceward/src/utils/web3-onboard/wagmi/utils.ts` | Added utility functions for wallet and chain management. | | `spaceward/src/utils/web3-onboard/wagmi/validation.ts` | Created validation schema for WAGMI initialization options using Joi. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant App participant QueryClient participant Web3Onboard User->>App: Initiate Action App->>QueryClient: Update State App->>Web3Onboard: Connect Wallet Web3Onboard-->>App: Connection Established App->>QueryClient: Invalidate Queries QueryClient-->>App: State Updated App-->>User: Action Complete ``` ## Possibly related PRs - **#385**: Updates to the `package.json` file related to dependency management. - **#463**: Modifications to the `useAssetQueries` hook, potentially connected to asset management updates. - **#688**: Addition of `@cosmjs/amino` dependency, enhancing blockchain interactions. - **#921**: Updates to the `wardenjs` package, related to dependency management and blockchain functionality. - **#1039**: Introduction of a layer for blockchain interactions, indicating broader integration efforts. ## Suggested labels `spaceward`, `protocol`, `wardenjs` ## Suggested reviewers - jjheywood

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.
github-actions[bot] commented 2 weeks ago

Hey @alex-nax and thank you for opening this pull request! 👋🏼

It looks like you forgot to add a changelog entry for your changes. Make sure to add a changelog entry in the 'CHANGELOG.md' file.