add roleBytes utility for contract role usage #5685

dirtycajunrice · 2024-12-10T22:25:44Z

Problem solved

CNCT-2631
Short description of the bug fixed or feature added

PR-Codex overview

This PR introduces a new utility function roleBytes that generates a 256-bit hash for role strings using the keccak256 algorithm. Additionally, it adds a test suite for this function to ensure its correctness.

Detailed summary

Added roleBytes function in role-bytes.ts to hash role strings.
The roleBytes function returns a 256-bit hash formatted as 0x${string}.
Created a test suite in role-bytes.test.ts to validate the roleBytes function.
Added a test case for the LISTER_ROLE.

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

changeset-bot · 2024-12-10T22:25:48Z

⚠️ No Changeset found

Latest commit: 1a19ea8

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

graphite-app · 2024-12-10T22:25:49Z

Your org has enabled 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.

vercel · 2024-12-10T22:25:51Z

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	Dec 10, 2024 11:04pm
thirdweb_playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 10, 2024 11:04pm
thirdweb-www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 10, 2024 11:04pm
wallet-ui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 10, 2024 11:04pm

dirtycajunrice · 2024-12-10T22:26:03Z

add roleBytes utility for contract role usage #5685 👈 (View in Graphite)
fix ignore of mimeTime set in mediaRenderer #5683
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.

github-actions · 2024-12-10T22:31:50Z

size-limit report 📦

Path	Size	Loading time (3g)	Running time (snapdragon)	Total time
thirdweb (esm)	44.93 KB (0%)	899 ms (0%)	4 s (+39.85% 🔺)	4.9 s
thirdweb (cjs)	110.71 KB (0%)	2.3 s (0%)	7 s (+3.03% 🔺)	9.2 s
thirdweb (minimal + tree-shaking)	5.58 KB (0%)	112 ms (0%)	544 ms (+172.9% 🔺)	656 ms
thirdweb/chains (tree-shaking)	506 B (0%)	10 ms (0%)	81 ms (+10.42% 🔺)	91 ms
thirdweb/react (minimal + tree-shaking)	19.01 KB (0%)	381 ms (0%)	883 ms (+11.64% 🔺)	1.3 s

packages/thirdweb/src/utils/encoding/helpers/role-bytes.test.ts

codecov · 2024-12-10T22:58:50Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 51.24%. Comparing base (9760615) to head (1a19ea8).

Additional details and impacted files

@@                 Coverage Diff                 @@
##           graphite-base/5685    #5685   +/-   ##
===================================================
  Coverage               51.23%   51.24%           
===================================================
  Files                    1092     1093    +1     
  Lines                   57346    57350    +4     
  Branches                 4677     4676    -1     
===================================================
+ Hits                    29383    29387    +4     
  Misses                  27247    27247           
  Partials                  716      716

Flag	Coverage Δ		*Carryforward flag
legacy_packages	`65.68% <ø> (ø)`		Carriedforward from 0eaab37
packages	`47.85% <100.00%> (+<0.01%)`	⬆️

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

Files with missing lines	Coverage Δ
.../thirdweb/src/utils/encoding/helpers/role-bytes.ts	`100.00% <100.00%> (ø)`

joaquim-verges

can you add a changeset for this one?

pnpm changeset from the root of the repo - make it a patch

joaquim-verges · 2024-12-11T00:43:13Z

packages/thirdweb/src/utils/encoding/helpers/role-bytes.ts

+ * @example
+ *   const AdminRole = roleBytes("ADMIN_ROLE");
+ */
+export const roleBytes = (role: string): `0x${string}` => {


need to export it publicly, you can do that by exporting it from /exports

likely under /exports/extensions/common.ts where the other role stuff is

joaquim-verges · 2024-12-11T00:45:18Z

packages/thirdweb/src/utils/encoding/helpers/role-bytes.ts

+/**
+ * Generates a 256-bit hash of a given role string in bytes form using the keccak256 algorithm.
+ *
+ * @param {string} role - The role string to be converted into bytes and hashed.


how about a union type for this of 'known' role strings + | ({} & string) to allow for others:

type KnownRoles = "ADMIN_ROLE" | "MINTER_ROLE" ... type Role = KnownRoles | ({} & string)

joaquim-verges

ugh, just realized we already have a getRoleHash function that's already exported and does the same thing

dirtycajunrice · 2024-12-20T23:27:38Z

ugh, just realized we already have a getRoleHash function that's already exported and does the same thing

Thats great. Ill close this then.

add roleBytes utility for contract role usage

ffeacf5

dirtycajunrice marked this pull request as ready for review December 10, 2024 22:25

dirtycajunrice requested review from joaquim-verges, gregfromstl and jnsdls as code owners December 10, 2024 22:25

github-actions bot added packages SDK Involves changes to the thirdweb SDK labels Dec 10, 2024

github-actions bot assigned dirtycajunrice Dec 10, 2024

dirtycajunrice mentioned this pull request Dec 10, 2024

fix ignore of mimeTime set in mediaRenderer #5683

Merged

dirtycajunrice added 2 commits December 10, 2024 16:27

add file

1b99887

remove redundant spacing

c5e0374

vercel bot deployed to Preview – wallet-ui December 10, 2024 22:32 View deployment

vercel bot deployed to Preview – thirdweb_playground December 10, 2024 22:35 View deployment

vercel bot deployed to Preview – docs-v2 December 10, 2024 22:36 View deployment

vercel bot deployed to Preview – thirdweb-www December 10, 2024 22:42 View deployment

add return type and add test

0eaab37

graphite-app bot reviewed Dec 10, 2024

View reviewed changes

packages/thirdweb/src/utils/encoding/helpers/role-bytes.test.ts Outdated Show resolved Hide resolved

vercel bot deployed to Preview – wallet-ui December 10, 2024 22:51 View deployment

vercel bot deployed to Preview – thirdweb_playground December 10, 2024 22:52 View deployment

biome format

1a19ea8

vercel bot deployed to Preview – wallet-ui December 10, 2024 22:57 View deployment

vercel bot deployed to Preview – thirdweb_playground December 10, 2024 22:57 View deployment

vercel bot deployed to Preview – thirdweb-www December 10, 2024 23:04 View deployment

vercel bot deployed to Preview – docs-v2 December 10, 2024 23:04 View deployment

joaquim-verges changed the base branch from 12-10-fix_ignore_of_mimetime_set_in_mediarenderer to graphite-base/5685 December 11, 2024 00:42

joaquim-verges reviewed Dec 11, 2024

View reviewed changes

joaquim-verges requested changes Dec 12, 2024

View reviewed changes

gregfromstl added the DO NOT MERGE This pull request is still in progress and is not ready to be merged. label Dec 16, 2024

dirtycajunrice closed this Dec 20, 2024

dirtycajunrice deleted the 12-10-add_rolebytes_utility_for_contract_role_usage branch December 20, 2024 23:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add roleBytes utility for contract role usage #5685

add roleBytes utility for contract role usage #5685

dirtycajunrice commented Dec 10, 2024 •

edited by pr-codex bot

Loading

changeset-bot bot commented Dec 10, 2024 •

edited

Loading

graphite-app bot commented Dec 10, 2024

vercel bot commented Dec 10, 2024 •

edited

Loading

dirtycajunrice commented Dec 10, 2024 •

edited

Loading

github-actions bot commented Dec 10, 2024 •

edited

Loading

codecov bot commented Dec 10, 2024 •

edited

Loading

joaquim-verges left a comment

joaquim-verges Dec 11, 2024

joaquim-verges Dec 11, 2024

joaquim-verges left a comment

dirtycajunrice commented Dec 20, 2024 •

edited

Loading

add roleBytes utility for contract role usage #5685

add roleBytes utility for contract role usage #5685

Conversation

dirtycajunrice commented Dec 10, 2024 • edited by pr-codex bot Loading

Problem solved

PR-Codex overview

Detailed summary

changeset-bot bot commented Dec 10, 2024 • edited Loading

⚠️ No Changeset found

graphite-app bot commented Dec 10, 2024

Your org has enabled the Graphite merge queue for merging into main

vercel bot commented Dec 10, 2024 • edited Loading

dirtycajunrice commented Dec 10, 2024 • edited Loading

How to use the Graphite Merge Queue

github-actions bot commented Dec 10, 2024 • edited Loading

size-limit report 📦

codecov bot commented Dec 10, 2024 • edited Loading

Codecov Report

joaquim-verges left a comment

Choose a reason for hiding this comment

joaquim-verges Dec 11, 2024

Choose a reason for hiding this comment

joaquim-verges Dec 11, 2024

Choose a reason for hiding this comment

joaquim-verges left a comment

Choose a reason for hiding this comment

dirtycajunrice commented Dec 20, 2024 • edited Loading

dirtycajunrice commented Dec 10, 2024 •

edited by pr-codex bot

Loading

changeset-bot bot commented Dec 10, 2024 •

edited

Loading

vercel bot commented Dec 10, 2024 •

edited

Loading

dirtycajunrice commented Dec 10, 2024 •

edited

Loading

github-actions bot commented Dec 10, 2024 •

edited

Loading

codecov bot commented Dec 10, 2024 •

edited

Loading

dirtycajunrice commented Dec 20, 2024 •

edited

Loading