CORE-458 | Improve the function comment of the Explorer

[kien-ngo]

CORE-458

---

PR-Codex overview

This PR focuses on enhancing the functionality of the ContractFunctionComment component by integrating a new method to retrieve function comments from contract metadata. It replaces the previous method of fetching comments with a more robust approach using metadata queries.

Detailed summary

• Updated the metadata type to include output with abi, devdoc, and userdoc.
• Replaced useContractSources with useContractFunctionComment in ContractFunctionComment.
• Simplified comment retrieval logic using contract metadata.
• Removed the old extractFunctionComment logic and integrated it into the new hook.
• Adjusted the rendering of comments to use wikitext instead of solidity.

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

[changeset-bot]

⚠️ No Changeset found

Latest commit: 4778966

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[vercel]

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	Jan 5, 2025 11:19pm
thirdweb_playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 5, 2025 11:19pm
thirdweb-www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 5, 2025 11:19pm
wallet-ui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 5, 2025 11:19pm

[kien-ngo]

• CORE-458 | Improve the function comment of the Explorer #5861 👈 (View in Graphite)
• main

---

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

• merge-queue - adds this PR to the back of the merge queue
• hotfix - for urgent hot fixes, skip the queue and merge this PR next

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

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

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

[linear]

CORE-458 Update the function description section to use devdoc and userdoc

[github-actions]

size-limit report 📦

Path	Size	Loading time (3g)	Running time (snapdragon)	Total time
thirdweb (esm)	45 KB (0%)	900 ms (0%)	2.7 s (-7.44% 🔽)	3.6 s
thirdweb (cjs)	110.81 KB (0%)	2.3 s (0%)	7.1 s (+24.26% 🔺)	9.3 s
thirdweb (minimal + tree-shaking)	5.58 KB (0%)	112 ms (0%)	264 ms (+76.89% 🔺)	375 ms
thirdweb/chains (tree-shaking)	506 B (0%)	10 ms (0%)	90 ms (+14.65% 🔺)	100 ms
thirdweb/react (minimal + tree-shaking)	19.13 KB (0%)	383 ms (0%)	1.1 s (+30.65% 🔺)	1.5 s

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.27%. Comparing base (810f319) to head (4778966).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5861   +/-   ##
=======================================
  Coverage   55.27%   55.27%           
=======================================
  Files        1123     1123           
  Lines       59636    59636           
  Branches     5041     5040    -1     
=======================================
  Hits        32961    32961           
  Misses      25953    25953           
  Partials      722      722           

Flag	Coverage Δ		*Carryforward flag
legacy_packages	65.68% <ø> (ø)		Carriedforward from 810f319
packages	52.94% <ø> (ø)

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

Files with missing lines	Coverage Δ
...thirdweb/src/contract/actions/compiler-metadata.ts	87.09% <ø> (ø)

[gregfromstl]

Merge activity

• Jan 5, 6:01 PM EST: The merge label 'merge-queue' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
• Jan 5, 6:01 PM EST: A user added this pull request to the Graphite merge queue.
• Jan 5, 6:19 PM EST: A user merged this pull request with the Graphite merge queue.