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

Contributor docs #562

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Contributor docs #562

wants to merge 8 commits into from

Conversation

theref
Copy link
Contributor

@theref theref commented Aug 1, 2024

This is the same PR as #551. The previous PR was closed due to the destination branch being deleted.

Type of PR:

  • Documentation

Required reviews:

  • 2

Fixes https://github.com/nucypher/sprints/issues/27

@theref theref requested a review from derekpierre August 1, 2024 07:49
Copy link

netlify bot commented Aug 1, 2024

Deploy Preview for taco-nft-demo ready!

Name Link
🔨 Latest commit b6379ff
🔍 Latest deploy log https://app.netlify.com/sites/taco-nft-demo/deploys/66ab6d4f74f5c40008976b05
😎 Deploy Preview https://deploy-preview-562--taco-nft-demo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Aug 1, 2024

Deploy Preview for taco-demo ready!

Name Link
🔨 Latest commit b6379ff
🔍 Latest deploy log https://app.netlify.com/sites/taco-demo/deploys/66ab6d4f2669c100082b9378
😎 Deploy Preview https://deploy-preview-562--taco-demo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.


3. User Context Management:

They help manage user context, specifically the `:userAddress` parameter. This includes handling authentication tokens and ensuring that users are authenticated only once for multiple actions.
Copy link
Member

@derekpierre derekpierre Aug 1, 2024

Choose a reason for hiding this comment

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

There is also the :userAddressExternalEIP4361 context variable.

It also uses an auth provider for generating the AuthSignature - https://github.com/nucypher/taco-web/blob/main/packages/taco-auth/src/providers/external-eip4361.ts#L6.

Side note: my goal is to update the API via #560 in the next sprint.

[The below test](https://github.com/nucypher/taco-web/blob/b689493a37bec0b168f80f43347818095c3dd5ce/packages/taco/test/conditions/context.test.ts#L382C1-L429C6) demonstrates how a SIWE message can be reused for TACo authentication.
This ensures that users don't have to sign multiple messages when logging into apps and decrypting TACo messages.

```typescript
Copy link
Member

Choose a reason for hiding this comment

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

Is this test in a test file somewhere already? Can we link to to test files/line numbers instead? That would ensure that the test always remains fresh. Some for other spots above.

EIP-712 has previously been supported but is now deprecated.

[The below test](https://github.com/nucypher/taco-web/blob/b689493a37bec0b168f80f43347818095c3dd5ce/packages/taco/test/conditions/context.test.ts#L382C1-L429C6) demonstrates how a SIWE message can be reused for TACo authentication.
This ensures that users don't have to sign multiple messages when logging into apps and decrypting TACo messages.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
This ensures that users don't have to sign multiple messages when logging into apps and decrypting TACo messages.
This ensures that users don't have to sign multiple messages when already logged into apps via SIWE and need to decrypt messages via TACo.

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