feat(thirdweb): adds useChainMetadata hook to retrieve metadata for a chain #3857

gregfromstl · 2024-07-29T16:33:59Z

TL;DR

This PR adds a new hook, useChainMetadata, to the thirdweb library. The hook allows developers to retrieve metadata for a specific blockchain, such as name, icon, available faucets, and block explorers.

What changed?

Added useChainMetadata hook in thirdweb/react.
Deprecated useChainQuery hook.
Updated documentation to reflect the new hook.

How to test?

Import the useChainMetadata from thirdweb/react.
Call the hook with a chain defined using defineChain.
Check the returned metadata for correctness.

Why make this change?

This change provides a more intuitive and documented way to retrieve chain metadata, replacing the deprecated useChainQuery hook. It enhances developer experience by offering a straightforward API to access chain-related information.

PR-Codex overview

This PR adds a new useChainMetadata hook to retrieve chain metadata in the thirdweb package and updates related components to use this hook.

Detailed summary

Added useChainMetadata hook to retrieve chain metadata
Updated components to use useChainMetadata instead of useChainQuery
Updated documentation for the new hook

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

vercel · 2024-07-29T16:34:01Z

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

Name	Status	Preview	Comments	Updated (UTC)
thirdweb_playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 29, 2024 9:19pm
thirdweb-www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 29, 2024 9:19pm
wallet-ui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 29, 2024 9:19pm

changeset-bot · 2024-07-29T16:34:03Z

🦋 Changeset detected

Latest commit: d5e5467

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
thirdweb	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

graphite-app · 2024-07-29T16:35:11Z

Graphite Automations

"If PR for SDK -> Tag Joaquim, Jonas and Greg" took an action on this PR • (07/29/24)

1 reviewer was added to this PR based on Kien Ngo's automation.

gregfromstl · 2024-07-29T16:35:25Z

feat(thirdweb): adds useChainMetadata hook to retrieve metadata for a chain #3857 👈
main

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @gregfromstl and the rest of your teammates on Graphite

graphite-app · 2024-07-29T16:37:19Z

Your org requires the Graphite merge queue for merging into main

Add the label “merge-queue” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge. Or use the label “hotfix” to add to the merge queue as a hot fix.

You must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link.

codspeed-hq · 2024-07-29T16:38:12Z

CodSpeed Performance Report

Merging #3857 will not alter performance

_{Comparing feat/add-use-chain-metadata-hook (d5e5467) with main (e26d070)}

Summary

✅ 9 untouched benchmarks

github-actions · 2024-07-29T16:39:32Z

size-limit report 📦

Path	Size	Loading time (3g)	Running time (snapdragon)	Total time
thirdweb (esm)	43.16 KB (0%)	864 ms (0%)	4.1 s (+85.48% 🔺)	5 s
thirdweb (cjs)	91.37 KB (0%)	1.9 s (0%)	5.6 s (+15.3% 🔺)	7.5 s
thirdweb (minimal + tree-shaking)	4.79 KB (0%)	96 ms (0%)	271 ms (+52.05% 🔺)	366 ms
thirdweb/chains (tree-shaking)	492 B (0%)	10 ms (0%)	67 ms (+19.09% 🔺)	77 ms
thirdweb/react (minimal + tree-shaking)	13.62 KB (0%)	273 ms (0%)	668 ms (+151.23% 🔺)	940 ms

codecov · 2024-07-29T16:41:23Z

Codecov Report

Attention: Patch coverage is 93.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 61.52%. Comparing base (e26d070) to head (d5e5467).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3857      +/-   ##
==========================================
+ Coverage   61.51%   61.52%   +0.01%     
==========================================
  Files         962      962              
  Lines       76559    76578      +19     
  Branches     3792     3787       -5     
==========================================
+ Hits        47092    47112      +20     
+ Misses      28782    28781       -1     
  Partials      685      685

Flag	Coverage Δ		*Carryforward flag
legacy_packages	`65.68% <ø> (ø)`		Carriedforward from e26d070
packages	`60.83% <93.33%> (+0.01%)`	⬆️

*This pull request uses carry forward flags. Click here to find out more.

Files	Coverage Δ
...rdweb/src/react/core/hooks/others/useChainQuery.ts	`51.02% <100.00%> (+5.56%)`	⬆️
packages/thirdweb/src/storage/download.ts	`93.10% <100.00%> (-0.08%)`	⬇️
...nectWallet/screens/Buy/DirectPaymentModeScreen.tsx	`12.03% <50.00%> (ø)`
...onnectWallet/screens/Buy/TransactionModeScreen.tsx	`11.06% <50.00%> (ø)`

... and 1 file with indirect coverage changes

MananTank · 2024-07-29T18:45:28Z

packages/thirdweb/src/react/core/hooks/others/useChainQuery.ts

+ *
+ * @chain
+ */
+export const useChainMetadata = useChainQuery;


We are already exporting the getChainMetadata - I don't think we also need to export a hook version of it to keep the number of wrapper hooks at minimum

Deferring the final call to @jnsdls

personally don't think it hurts but yeah unsure if we need it

Needed this for the wallet UI

jnsdls · 2024-07-29T19:30:42Z

packages/thirdweb/src/react/core/hooks/others/useChainQuery.ts

+ *
+ * @chain
+ */
+export const useChainMetadata = useChainQuery;


personally don't think it hurts but yeah unsure if we need it

joaquim-verges · 2024-07-29T19:33:45Z

packages/thirdweb/src/storage/download.ts

@@ -8,9 +8,9 @@ export type DownloadOptions = Prettify<
  }
 >;

+/** @import { createThirdwebClient } from "../client/client.js" */


what does this do?

Let's us link the type without needing to import it in the actual code

https://devblogs.microsoft.com/typescript/announcing-typescript-5-5-beta/

Isn't this just for type imports though? + when you want to use that imported type in JSDoc

oh interesting - wonder how its gonna render on docs.

one simple thing we can do is just link to https://portal.thirdwerb.com/references/typescript/v5/<theFunction> with markdown, that i know renders well on portal

Yeah let's do that for now. I was afraid of broken links that way but should be fine

graphite-app · 2024-07-29T20:46:02Z

Merge activity

Jul 29, 4:46 PM EDT: gregfromstl added this pull request to the Graphite merge queue.
Jul 29, 5:20 PM EDT: gregfromstl merged this pull request with the Graphite merge queue.

… chain (#3857) ### TL;DR This PR adds a new hook, `useChainMetadata`, to the thirdweb library. The hook allows developers to retrieve metadata for a specific blockchain, such as name, icon, available faucets, and block explorers. ### What changed? - Added `useChainMetadata` hook in `thirdweb/react`. - Deprecated `useChainQuery` hook. - Updated documentation to reflect the new hook. ### How to test? 1. Import the `useChainMetadata` from `thirdweb/react`. 2. Call the hook with a chain defined using `defineChain`. 3. Check the returned metadata for correctness. ### Why make this change? This change provides a more intuitive and documented way to retrieve chain metadata, replacing the deprecated `useChainQuery` hook. It enhances developer experience by offering a straightforward API to access chain-related information. ---  --- ## PR-Codex overview This PR adds a new hook `useChainMetadata` to retrieve chain metadata in Thirdweb React. It also updates the `useChainQuery` hook to `useChainMetadata`. ### Detailed summary - Added `useChainMetadata` hook to retrieve chain metadata - Updated `useChainQuery` to `useChainMetadata` - Improved documentation for `useChainMetadata` > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`

gregfromstl requested review from joaquim-verges and MananTank as code owners July 29, 2024 16:34

github-actions bot added the TS SDK Involves changes to the v5 TypeScript SDK. label Jul 29, 2024

graphite-app bot requested a review from jnsdls July 29, 2024 16:34

gregfromstl force-pushed the feat/add-use-chain-metadata-hook branch from 9c20b49 to 6bcb9d0 Compare July 29, 2024 16:35

vercel bot deployed to Preview – thirdweb_playground July 29, 2024 16:46 View deployment

vercel bot deployed to Preview – wallet-ui July 29, 2024 16:47 View deployment

vercel bot deployed to Preview – thirdweb-www July 29, 2024 16:57 View deployment

MananTank reviewed Jul 29, 2024

View reviewed changes

jnsdls approved these changes Jul 29, 2024

View reviewed changes

joaquim-verges reviewed Jul 29, 2024

View reviewed changes

gregfromstl force-pushed the feat/add-use-chain-metadata-hook branch from 6bcb9d0 to f7fa48a Compare July 29, 2024 19:52

MananTank approved these changes Jul 29, 2024

View reviewed changes

vercel bot deployed to Preview – wallet-ui July 29, 2024 19:56 View deployment

vercel bot deployed to Preview – thirdweb_playground July 29, 2024 19:57 View deployment

vercel bot deployed to Preview – thirdweb-www July 29, 2024 20:06 View deployment

gregfromstl force-pushed the feat/add-use-chain-metadata-hook branch from f7fa48a to b879ae7 Compare July 29, 2024 20:20

vercel bot deployed to Preview – wallet-ui July 29, 2024 20:23 View deployment

vercel bot deployed to Preview – thirdweb_playground July 29, 2024 20:24 View deployment

vercel bot deployed to Preview – thirdweb-www July 29, 2024 20:36 View deployment

joaquim-verges approved these changes Jul 29, 2024

View reviewed changes

gregfromstl force-pushed the feat/add-use-chain-metadata-hook branch from b879ae7 to d5e5467 Compare July 29, 2024 21:02

vercel bot deployed to Preview – thirdweb_playground July 29, 2024 21:06 View deployment

vercel bot deployed to Preview – wallet-ui July 29, 2024 21:07 View deployment

vercel bot deployed to Preview – thirdweb-www July 29, 2024 21:19 View deployment

graphite-app bot merged commit d5e5467 into main Jul 29, 2024
32 checks passed

graphite-app bot deleted the feat/add-use-chain-metadata-hook branch July 29, 2024 21:20

vercel bot deployed to Production – thirdweb_playground July 29, 2024 21:22 View deployment

vercel bot deployed to Production – wallet-ui July 29, 2024 21:22 View deployment

jnsdls mentioned this pull request Jul 29, 2024

Version Packages #3852

Merged

vercel bot deployed to Production – thirdweb-www July 29, 2024 21:32 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(thirdweb): adds useChainMetadata hook to retrieve metadata for a chain #3857

feat(thirdweb): adds useChainMetadata hook to retrieve metadata for a chain #3857

gregfromstl commented Jul 29, 2024 •

edited by pr-codex bot

Loading

vercel bot commented Jul 29, 2024 •

edited

Loading

changeset-bot bot commented Jul 29, 2024 •

edited

Loading

graphite-app bot commented Jul 29, 2024

gregfromstl commented Jul 29, 2024 •

edited

Loading

graphite-app bot commented Jul 29, 2024

codspeed-hq bot commented Jul 29, 2024 •

edited

Loading

github-actions bot commented Jul 29, 2024 •

edited

Loading

codecov bot commented Jul 29, 2024 •

edited

Loading

MananTank Jul 29, 2024

MananTank Jul 29, 2024

jnsdls Jul 29, 2024

gregfromstl Jul 29, 2024

jnsdls Jul 29, 2024

joaquim-verges Jul 29, 2024

gregfromstl Jul 29, 2024

MananTank Jul 29, 2024 •

edited

Loading

joaquim-verges Jul 29, 2024

gregfromstl Jul 29, 2024

graphite-app bot commented Jul 29, 2024 •

edited

Loading

feat(thirdweb): adds useChainMetadata hook to retrieve metadata for a chain #3857

feat(thirdweb): adds useChainMetadata hook to retrieve metadata for a chain #3857

Conversation

gregfromstl commented Jul 29, 2024 • edited by pr-codex bot Loading

TL;DR

What changed?

How to test?

Why make this change?

PR-Codex overview

Detailed summary

vercel bot commented Jul 29, 2024 • edited Loading

changeset-bot bot commented Jul 29, 2024 • edited Loading

🦋 Changeset detected

graphite-app bot commented Jul 29, 2024

Graphite Automations

gregfromstl commented Jul 29, 2024 • edited Loading

graphite-app bot commented Jul 29, 2024

Your org requires the Graphite merge queue for merging into main

codspeed-hq bot commented Jul 29, 2024 • edited Loading

Merging #3857 will not alter performance

Summary

github-actions bot commented Jul 29, 2024 • edited Loading

size-limit report 📦

codecov bot commented Jul 29, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MananTank Jul 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

graphite-app bot commented Jul 29, 2024 • edited Loading

Merge activity

gregfromstl commented Jul 29, 2024 •

edited by pr-codex bot

Loading

vercel bot commented Jul 29, 2024 •

edited

Loading

changeset-bot bot commented Jul 29, 2024 •

edited

Loading

gregfromstl commented Jul 29, 2024 •

edited

Loading

codspeed-hq bot commented Jul 29, 2024 •

edited

Loading

github-actions bot commented Jul 29, 2024 •

edited

Loading

codecov bot commented Jul 29, 2024 •

edited

Loading

MananTank Jul 29, 2024 •

edited

Loading

graphite-app bot commented Jul 29, 2024 •

edited

Loading