Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: World ID Section updates #243

Merged
merged 9 commits into from
Dec 7, 2023
Merged

Conversation

0xPenryn
Copy link
Collaborator

@0xPenryn 0xPenryn commented Dec 4, 2023

includes documentation of World ID Reset, its impacts, and associated suggestions for integrations

Copy link

vercel bot commented Dec 4, 2023

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

Name Status Preview Comments Updated (UTC)
world-id-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 7, 2023 11:02pm

@0xPenryn 0xPenryn requested review from pdtfh and m1guelpf December 6, 2023 22:48
@0xPenryn 0xPenryn marked this pull request as ready for review December 6, 2023 22:48

## Impact on Sign-In with World ID

When a user signs in with World ID, their Nullifier Hash is returned as the `sub` claim in the ID Token. Recall that the Nullifier Hash is the unique identifier of a user in the context of a specific action -- a different identity will return a different Nullifier Hash.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's use as nullifier_hash everywhere?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sub claim is required per OIDC specs, we can't rename it to something else

@@ -41,25 +40,45 @@ const { address } = useAddress() // get the user's wallet address

The World ID Router contract is what you should use to verify proofs. It is deployed on multiple chains, and you can find the addresses for each chain in our contracts [Address Book](/reference/address-book).

## `hashToField` helper function
## `hashToField` Helper Function
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@m1guelpf are we still exposing this from IDKit?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hashToField is exported in @worldcoin/idkit-core/hashing

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for on-chain stuff, though, it should always be calculated in the smart contract itself rather than pre-computed off-chain and submitted in the TX

@0xPenryn 0xPenryn merged commit 2f850a1 into idkit-v1-updates Dec 7, 2023
3 checks passed
@0xPenryn 0xPenryn deleted the id-section-updates branch December 7, 2023 23:03
0xPenryn added a commit that referenced this pull request Dec 13, 2023
* fix: small formatting

* feat: device credential documentation (#240)

* feat: reference section updates (#241)

* chore: add world id bridge documentation (#230)

Co-authored-by: pdtfh <[email protected]>

* feat: explore apps (#246)

* feat: World ID Section updates (#243)

* feat: small on-chain docs improvements

* feat: small fixes

* feat: simplify dynamic actions

* nit: phone -> device

* nit: anchor link spacing

* feat: World ID Reset documentation

* Update src/pages/further-reading/world-id-reset.mdx

Co-authored-by: pdtfh <[email protected]>

* fix: time-bound sybil resistance

---------

Co-authored-by: pdtfh <[email protected]>

* feat: IDKit v1 migration guide (#244)

Co-authored-by: pdtfh <[email protected]>

* feat: naming updates (#248)

Co-authored-by: pdtfh <[email protected]>

* feat: remove /register endpoint (#249)

* fix: update hero image on homepage

* fix: migration PR feedback (#250)

* fix: migration PR feedback

* Update src/pages/id/world-id-lite.mdx

Co-authored-by: pdtfh <[email protected]>

* Update src/pages/id/world-id-lite.mdx

Co-authored-by: pdtfh <[email protected]>

* Update src/pages/id/world-id-lite.mdx

Co-authored-by: pdtfh <[email protected]>

* fix: address feedback

---------

Co-authored-by: pdtfh <[email protected]>

* nit: tiny prop name error

* fix: remove readme sync (#251)

* fix: broken links

* feat: errors reference page (#247)

* feat: errors reference page

* fix: nav name

* fix: remove wallet bridge section

* fix: split table by service/package

* feat: final v1 updates (#252)

* fix: verification_level, World ID Device, OIDC claim

* feat: idkit v1.1, update incognito actions section of try it page

* feat: verification levels page

merged "World ID Device" and "Proof of Personhood" pages to create this

* fix: remove theme param and add to migration guide

* feat: user-agent header requirement

* fix: try page theme

* fix: closing tag

* feat: verify with world id page

* feat: errors reorg

* fix: feedback

* bump: IDKit v1.1.1

* fix: apps link

---------

Co-authored-by: pdtfh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants