A `useSignIn()` hook for accessing the Sign In With Solana feature #2928

steveluscher · 2024-07-10T22:38:57Z

Summary

This hook returns essentially the raw sign in function from the solana:signIn feature. It upcasts the returned WalletAccount to a UiWalletAccount usable with the rest of the @solana/react API.

Callers are responsible for verifying the signed message and its signature.

Test plan

pnpm turbo test:unit:node test:unit:browser test:typecheck

changeset-bot · 2024-07-10T22:39:01Z

🦋 Changeset detected

Latest commit: 686539f

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

This PR includes changesets to release 37 packages

Name	Type
@solana/react	Minor
@solana/accounts	Minor
@solana/addresses	Minor
@solana/assertions	Minor
@solana/codecs-core	Minor
@solana/codecs-data-structures	Minor
@solana/codecs-numbers	Minor
@solana/codecs-strings	Minor
@solana/codecs	Minor
@solana/compat	Minor
@solana/errors	Minor
@solana/fast-stable-stringify	Minor
@solana/functional	Minor
@solana/instructions	Minor
@solana/keys	Minor
@solana/web3.js-experimental	Minor
@solana/options	Minor
@solana/programs	Minor
@solana/rpc-api	Minor
@solana/rpc-graphql	Minor
@solana/rpc-parsed-types	Minor
@solana/rpc-spec-types	Minor
@solana/rpc-spec	Minor
@solana/rpc-subscriptions-api	Minor
@solana/rpc-subscriptions-spec	Minor
@solana/rpc-subscriptions-transport-websocket	Minor
@solana/rpc-subscriptions	Minor
@solana/rpc-transformers	Minor
@solana/rpc-transport-http	Minor
@solana/rpc-types	Minor
@solana/rpc	Minor
@solana/signers	Minor
@solana/sysvars	Minor
@solana/transaction-confirmation	Minor
@solana/transaction-messages	Minor
@solana/transactions	Minor
@solana/webcrypto-ed25519-polyfill	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

steveluscher · 2024-07-10T22:39:13Z

Added Sign In With Solana to the example app #2929
A useSignIn() hook for accessing the Sign In With Solana feature #2928 👈
Reset errors when changing account/chain #2923
master

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

Join @steveluscher and the rest of your teammates on Graphite

steveluscher · 2024-07-11T16:58:25Z

packages/react/src/useSignIn.ts

+    return useCallback(
+        async (...inputs) => {
+            const inputsWithAddressAndChainId = inputs.map(input => ({
+                ...input,


Should we default the domain to window.location.host if not supplied?

I think it makes sense yeah. I'm trying to think about security reasons not to do this but can't see any.

We can, but the wallet must set this anyway if it's not provided.

I'm going to leave it unsupplied.

jordaaash · 2024-07-11T18:05:12Z

packages/react/src/useSignIn.ts

+    );
+}
+
+function useSignIns(


I think we can do away with this plural API, seems very unlikely to be used and certainly doesn't work today.

Oh I see, this isn't exported anyway, this is just internally how it's implemented because the Wallet Standard is this way. Carry on!

jordaaash · 2024-07-11T18:07:35Z

packages/react/src/useSignIn.ts

+            const resultsWithoutSignatureType = results.map(
+                ({
+                    account,
+                    signatureType: _, // Solana signatures are always of type `ed25519` so drop this property.


Yeah, this was a misguided design. The idea was that we could support secp256r1 signatures potentially later, but that's better handled through a new feature/version.

jordaaash · 2024-07-11T18:18:48Z

.changeset/fuzzy-lizards-end.md

+                try {
+                    const { account, signedMessage, signature } = await signIn({
+                        domain: window.location.host,
+                        nonce: csrfToken,


Aside: It's extremely dumb that SIWE has request-id and nonce which are duplicative in almost all cases, and JWT-esque issued-at and expires-at timestamps when these are not intended to be and should not be used as JWTs directly. Apps should generate a random session ID from the server and use it as request-id, then verify and issue a proper JWT if needed from the server the correct way.

Ideally we can reflect the best way to do this in docs and examples and users should not touch most of the API.

nit: I do prefer requestId to nonce because it makes it more clear that it should come from a server, it's not using a cryptography term improperly, and it's not confused by Brits for... other meanings of the term.

jordaaash · 2024-07-11T18:21:36Z

.changeset/fuzzy-lizards-end.md

+            onClick={async () => {
+                try {
+                    const { account, signedMessage, signature } = await signIn({
+                        domain: window.location.host,


domain probably not needed in the example since apps shouldn't provide it.

You're right about that! I noticed some wallets fail awkwardly when you don't supply it, but that's a bug with their implementation.

For posterity, one such error when you don't supply domain.

jordaaash · 2024-07-11T18:23:47Z

packages/react/src/useSignIn.ts

+export function useSignIn(uiWallet: UiWallet): (input?: Input) => Promise<Output>;
+export function useSignIn(uiWalletHandle: UiWalletHandle): (input?: Input) => Promise<Output> {


jordaaash

LGTM, had some non-critical comments that apply mainly to examples/defaults

steveluscher · 2024-07-12T17:50:12Z

Merge activity

Jul 12, 10:50 AM PDT: @steveluscher started a stack merge that includes this pull request via Graphite.
Jul 12, 10:51 AM PDT: Graphite rebased this pull request as part of a merge.
Jul 12, 10:52 AM PDT: Graphite rebased this pull request as part of a merge.
Jul 12, 10:54 AM PDT: Graphite rebased this pull request as part of a merge.
Jul 12, 10:55 AM PDT: @steveluscher merged this pull request with Graphite.

github-actions · 2024-07-17T22:05:59Z

🎉 This PR is included in version 1.95.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions · 2024-08-01T08:04:27Z

Because there has been no activity on this PR for 14 days since it was merged, it has been automatically locked. Please open a new issue if it requires a follow up.

steveluscher mentioned this pull request Jul 10, 2024

Reset errors when changing account/chain #2923

Merged

steveluscher assigned jordaaash Jul 10, 2024

steveluscher force-pushed the 07-10-a_usesignin_hook_for_accessing_the_sign_in_with_solana_feature branch 3 times, most recently from 46ad8e6 to 7aaf056 Compare July 10, 2024 22:55

steveluscher mentioned this pull request Jul 10, 2024

Added Sign In With Solana to the example app #2929

Merged

lorisleiva approved these changes Jul 11, 2024

View reviewed changes

steveluscher commented Jul 11, 2024

View reviewed changes

Base automatically changed from 07-09-reset_errors_when_changing_account_chain to master July 11, 2024 16:59

jordaaash reviewed Jul 11, 2024

View reviewed changes

jordaaash approved these changes Jul 11, 2024

View reviewed changes

steveluscher force-pushed the 07-10-a_usesignin_hook_for_accessing_the_sign_in_with_solana_feature branch from 7aaf056 to d7db531 Compare July 12, 2024 17:49

steveluscher force-pushed the 07-10-a_usesignin_hook_for_accessing_the_sign_in_with_solana_feature branch 2 times, most recently from 908235e to bcf481a Compare July 12, 2024 17:51

A useSignIn() hook for accessing the Sign In With Solana feature

686539f

steveluscher force-pushed the 07-10-a_usesignin_hook_for_accessing_the_sign_in_with_solana_feature branch from bcf481a to 686539f Compare July 12, 2024 17:53

steveluscher merged commit bac3747 into master Jul 12, 2024
6 checks passed

steveluscher deleted the 07-10-a_usesignin_hook_for_accessing_the_sign_in_with_solana_feature branch July 12, 2024 17:55

github-actions bot mentioned this pull request Jul 12, 2024

Version Packages (rc) #2906

Merged

github-actions bot added the released label Jul 17, 2024

github-actions bot locked as resolved and limited conversation to collaborators Aug 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

A `useSignIn()` hook for accessing the Sign In With Solana feature #2928

A `useSignIn()` hook for accessing the Sign In With Solana feature #2928

steveluscher commented Jul 10, 2024 •

edited

Loading

changeset-bot bot commented Jul 10, 2024 •

edited

Loading

steveluscher commented Jul 10, 2024 •

edited

Loading

steveluscher Jul 11, 2024

lorisleiva Jul 11, 2024

jordaaash Jul 11, 2024

steveluscher Jul 12, 2024

jordaaash Jul 11, 2024 •

edited

Loading

jordaaash Jul 11, 2024

jordaaash Jul 11, 2024

jordaaash Jul 11, 2024

jordaaash Jul 11, 2024

jordaaash Jul 11, 2024

steveluscher Jul 12, 2024

steveluscher Jul 12, 2024

jordaaash Jul 11, 2024

jordaaash left a comment

steveluscher commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 17, 2024

github-actions bot commented Aug 1, 2024

		export function useSignIn(uiWallet: UiWallet): (input?: Input) => Promise<Output>;
		export function useSignIn(uiWalletHandle: UiWalletHandle): (input?: Input) => Promise<Output> {

A useSignIn() hook for accessing the Sign In With Solana feature #2928

A useSignIn() hook for accessing the Sign In With Solana feature #2928

Conversation

steveluscher commented Jul 10, 2024 • edited Loading

Summary

Test plan

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

🦋 Changeset detected

steveluscher commented Jul 10, 2024 • edited Loading

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

jordaaash Jul 11, 2024 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jordaaash left a comment

Choose a reason for hiding this comment

steveluscher commented Jul 12, 2024 • edited Loading

Merge activity

github-actions bot commented Jul 17, 2024

github-actions bot commented Aug 1, 2024

A `useSignIn()` hook for accessing the Sign In With Solana feature #2928

A `useSignIn()` hook for accessing the Sign In With Solana feature #2928

steveluscher commented Jul 10, 2024 •

edited

Loading

changeset-bot bot commented Jul 10, 2024 •

edited

Loading

steveluscher commented Jul 10, 2024 •

edited

Loading

jordaaash Jul 11, 2024 •

edited

Loading

steveluscher commented Jul 12, 2024 •

edited

Loading