[frontend dapp-kit] add useSuiClientQueries hook #14913
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
3 Ignored Deployments
|
williamrobertson13
requested review from
williamrobertson13 and
hayes-mysten
| method: T, | ||
| params: SuiRpcMethods[T]['params'], | ||
| options?: UseSuiClientQueryOptions<T, TData>, | ||
| ][] |
There was a problem hiding this comment.
should we make these objects?
This looks like it will require all methods to be the same, I think this would be more useful if we could allow each method to be different
There was a problem hiding this comment.
Thank you for the contribution, this seems like a great feature to add.
I think we will need to make some improvements around the typing so that this correctly handles mapping results for multiple different RPC methods in the same call, and we'll want to add a few tests for the new hook.
I am happy to advise any questions you have about making those changes yourself, or if you prefer we can also help make these fixes ourselves
I understand. I will make it compatible with different RPC methods. Please give me some time. @hayes-mysten |
|
The typing here can be a little tricky, something like this is probably what you want: |
|
@jovicheng to clarify, the issue here is the typescript types, not the actual functionality. We want to ensure that the returned data is strictly typed results should be strictly typed, so that the results have correct types for each queried method Each query should be type checked independently, so that errors are relevant to the query being executed |
I completely understand what you mean, let me delve deeper into studying these types. 🙌 |
|
@williamrobertson13 the types I shared here don't cover typing for Yeah, I think for Also a test suite similar to our existing test suite for |
Update the repo to be based on the latest main branch to fix CI error
## Description
In certain scenarios, dApp needs to utilize useQueries for data
retrieval.
Here is an example:
```typescript
const { data: coinBalanceList = [] } = useSuiClientQuery("getAllBalances", {
owner: walletAddress,
});
// After obtaining the balance for each coin,
// it is necessary to further retrieve the metadata for each individual coin.
const [coinMetadataQuery, allBalanceQuery, ownedObjectsQuery] =
useSuiClientQueries(
{ method: "getCoinMetadata", params: { coinType: "exampleCoinType" } },
{
method: "getAllBalances",
params: { owner: "exampleOwnerAddress" },
options: {
queryKey: ["123"],
},
},
// error 'params' is declared here.
{ method: "getOwnedObjects" }
);
const CoinMetadata = coinMetadataQuery.data;
const allBalance = allBalanceQuery.data;
const ownedObjects = ownedObjectsQuery.data;
```
With the `useSuiClientQueries` hook, retrieving the aforementioned data
will be much more easy.
If there are any changes needed or if you have any suggestions, please
feel free to contact me at any time!
Thanks!
## Test Plan
- Existing tests
- CI
How did you test the new or updated feature?
---
If your changes are not user-facing and not a breaking change, you can
skip the following section. Otherwise, please indicate what changed, and
then add to the Release Notes section as highlighted during the release
process.
### Type of Change (Check all that apply)
- [ ] protocol change
- [ ] user-visible impact
- [ ] breaking change for a client SDKs
- [ ] breaking change for FNs (FN binary must upgrade)
- [ ] breaking change for validators or node operators (must upgrade
binaries)
- [ ] breaking change for on-chain data layout
- [ ] necessitate either a data wipe or data migration
### Release notes
---------
Co-authored-by: hayes-mysten <135670682+hayes-mysten@users.noreply.github.com>
Co-authored-by: William Robertson <williamrobertson@mystenlabs.com>
Description
In certain scenarios, dApp needs to utilize useQueries for data retrieval.
Here is an example:
With the
useSuiClientQuerieshook, retrieving the aforementioned data will be much more easy.If there are any changes needed or if you have any suggestions, please feel free to contact me at any time!
Thanks!
Test Plan
How did you test the new or updated feature?
If your changes are not user-facing and not a breaking change, you can skip the following section. Otherwise, please indicate what changed, and then add to the Release Notes section as highlighted during the release process.
Type of Change (Check all that apply)
Release notes