Taylor/wallet stamper client #409

taylorjdawson · 2024-10-24T17:37:40Z

Summary & Motivation

Changes

`@turnkey/wallet-stamper`

`WalletStamper`

Renamed recoverPublicKey to getPublicKey
Reason: Improves clarity and consistency across wallet interfaces
Unified getPublicKey method signature to take no parameters
Reason: The change in method signature for getPublicKey (removing parameters) was necessary to allow the TurnkeyWalletClient to access the public key without needing to provide any additional information. This simplifies the process of retrieving the public key for sub-organization creation as demonstrated in the example.
Moved getPublicKey to BaseWalletInterface
Reason: Ensures all wallet types implement this essential method
Updated SolanaWalletInterface and EthereumWalletInterface
Reason: Streamlines interfaces by removing redundant method declarations
Modified EthereumWallet implementation
Reason: Aligns with new interface structure and utilizes signMessage for public key recovery

`@turnkey/sdk-browser`

`TurnkeyWalletClient`

Added new TurnkeyWalletClient to the @turnkey/sdk-browser
Reason: Allows using the WalletStamper with the browser sdk
Added getPublicKey method to TurnkeyWalletClient
Reason: Enables easy access to wallet public key for sub-organization creation and future authentication flows
Updated TurnkeyWalletClient to use new WalletInterface
Reason: Ensures compatibility with the updated Wallet Stamper interfaces

`AuthClient` (new enum)

Introduced a new enum to track which client is authenticated (Passkey, Wallet, Iframe)
Reason: To be stored in the new user session local storage object, to determine which client to return in the @turnkey/sdk-react

`TurnkeyBrowserClient`, `TurnkeyIframeClient`, `TurnkeyPasskeyClient`, `TurnkeyWalletClient`

Added a static authClient property to base TurnkeyBrowserClient to be used by the child classes.
Reason: To track which client was used for the initial authentication, enabling proper client retrieval later
Set specific authClient values in each subclass
Reason: To ensure each client type is correctly identified for authentication and retrieval purposes

`UserSession` interface

Added a new UserSession interface which is to be stored in local storage to track the authentication state of the user.
Reason: To eliminate the need to store the write and read sessions separately. Improving clarity and maintainability.
Added authenticatedClient in the session object
Reason: To store the authentication method used in the user's session data. Will be used in the @turnkey/sdk-react to determine which client to return.

This is the new UserSession object which gets stored in local storage:

export interface User {
  userId: string;
  username: string;
  organization: {
    organizationId: string;
    organizationName: string;
  };
  session:
    | {
        read?: ReadOnlySession;
        write?: ReadWriteSession;
        authenticatedClient: AuthClient;
      }
    | undefined;
}

`StorageKeys` enum

Added new versioned UserSession key: "@turnkey/session/v1" Added a new storage key to remove reliance on the legacy user session object with the goal of not breaking any existing implementations with past versions of the sdk.
Reason: To facilitate future updates without breaking existing implementations and improve backward compatibility.

`login` and `loginWithReadWriteSession` methods

Updated to use the new authenticatedClient property when creating user sessions
Reason: To properly track and store the authentication method used during login

How I Tested These Changes

Did you add a changeset?

If updating one of our packages, you'll likely need to add a changeset to your PR. To do so, run pnpm changeset. pnpm changeset will generate a file where you should write a human friendly message about the changes. Note how this (example) includes the package name (should be auto added by the command) along with the type of semver change (major.minor.patch) (which you should set).

These changes will be used at release time to determine what packages to publish and how to bump their version. For more context see this comment.

codesandbox-ci · 2024-10-24T17:39:01Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

socket-security · 2024-10-25T00:12:29Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@changesets/[email protected]	Transitive: environment, eval, filesystem, shell, unsafe	`+102`	16 MB	changesets-release-bot
npm/[email protected]	None	`+1`	265 kB	junscuzzy
npm/[email protected]	Transitive: environment, filesystem, network	`+25`	23.8 MB	awkweb, jmoxey

🚮 Removed packages: npm/@changesets/[email protected], npm/[email protected], npm/[email protected]

View full report↗︎

examples/with-wallet-stamper/src/components/turnkey-provider.tsx

andrewkmin

loooove the progress!

Updated SolanaWalletInterface and EvmWalletInterface
Reason: Streamlines interfaces by removing redundant method declarations

Modified EthereumWallet implementation
Reason: Aligns with new interface structure and utilizes signMessage for public key recovery

should we consolidate on EVM or Ethereum, not both?

also, would you be able to add a changeset for all the package changes? feel free to make them major updates. It would be great to get some iterations on getting the changes articulated in the changelog :)

andrewkmin · 2024-10-28T21:10:40Z

packages/sdk-browser/README.md

+const passkeyClient = turnkey.passkeyClient();
+
+// User will be prompted to login with their passkey
+await passkeyClient.login();


do we want to describe what exactly login is doing? or perhaps this can wait for Omkar's work on documenting all these methods

cc @omkarshanbhag as some of these methods will be getting tweaked

packages/sdk-browser/README.md

packages/sdk-browser/src/sdk-client.ts

packages/sdk-browser/src/storage.ts

packages/wallet-stamper/README.md

packages/wallet-stamper/src/__tests__/wallet-interfaces.ts

taylorjdawson · 2024-11-07T00:42:19Z

packages/sdk-browser/src/sdk-client.ts

@@ -375,7 +434,7 @@ export class TurnkeyPasskeyClient extends TurnkeyBrowserClient {
    expirationSeconds: string = DEFAULT_SESSION_EXPIRATION,
    organizationId?: string
  ): Promise<ReadWriteSession> => {
-    const localStorageUser = await getStorageValue(StorageKeys.CurrentUser);
+    const localStorageUser = await getStorageValue(StorageKeys.UserSession);
    userId = userId ?? localStorageUser?.userId;


@andrewkmin should we make userId optional given that it could comes from the local storage similar to organizationId?

examples/with-wallet-stamper/src/components/turnkey-provider.tsx

packages/crypto/src/crypto.ts

packages/sdk-browser/README.md

packages/sdk-browser/package.json

andrewkmin · 2024-11-07T20:03:34Z

packages/sdk-browser/src/sdk-client.ts

@@ -140,13 +151,13 @@ export class TurnkeyBrowserSDK {
   */
  currentUserSession = async (): Promise<TurnkeyBrowserClient | undefined> => {


now that I'm reading this back... I wonder if we should combine currentUserSession and getReadWriteSession. I'd imagine if a user somehow has both a read-only and read-write session active, when they call currentUserSession, they'd probably want the read-write session to be returned?

@andrewkmin if we did this is your idea that we would return the TurnkeyIframeClient instead of the TurnkeyBrowserClient for read-write sessions?

mm yeah that's tricky, i suppose it would have to be in that case

I think we could abstract this in the react sdk

const { client } = useTurnkey()

we could make this client more intelligent by defaulting to creating a read/write session regardless of which client authenticates initially
and the user would have the option of downgrading or setting a default auth level for the client in the config

packages/sdk-browser/src/sdk-client.ts

…eact-sdk

andrewkmin

wow a herculean effort 👏 just some relatively minor comments

package.json

andrewkmin · 2024-11-20T03:33:21Z

examples/with-wallet-stamper/src/components/turnkey-provider.tsx

-    const publicKey = (wallet as SolanaWalletInterface)?.recoverPublicKey();
+    const publicKey = await wallet?.getPublicKey();
+    if (!publicKey) {
+      return null;


sort of a meta question but do you prefer using nulls or undefineds?

Generally I'll use null to distinguish between uninitialized variables and values that have been intentionally set to an empty value

packages/sdk-react/package.json

andrewkmin · 2024-11-20T03:36:49Z

packages/sdk-react/src/contexts/TurnkeyContext.tsx

  getActiveClient: () => Promise<TurnkeyBrowserClient | undefined>;
 }

 export const TurnkeyContext = createContext<TurnkeyClientType>({
+  client: undefined,


if this is the active client, should we name it activeClient for consistency with getActiveClient?

yeah that makes sense! I was thinking of simplifying the name to abstract away some of the complexity of the multiple clients

andrewkmin · 2024-11-20T03:38:47Z

packages/wallet-stamper/README.md

@@ -193,12 +167,16 @@ const whoami = await client.getWhoami({
  organizationId: process.env.NEXT_PUBLIC_ORGANIZATION_ID,
 });

-// Now that we have the sub organization id, we can make requests using that sub org id
+if (!whoami?.userId) {
+  // User does not yet have a sub organization, so we need to create one


should we add suborg creation code here?

andrewkmin · 2024-11-20T03:39:27Z

packages/wallet-stamper/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@turnkey/wallet-stamper",
-  "version": "0.0.5",
+  "version": "1.0.0",


should we make this initial launch as beta? i.e. 0.1.0? or are we comfortable full sending as 1.0.0? I'm fine with either; if we're feeling good about the integration with demo wallet, let's do 1.0.0 :)

Yeah I was on the fence between beta/major version, I decided the API feels solidified -- I have some ideas for future improvements but they change the core API

andrewkmin · 2024-11-20T03:40:50Z

packages/wallet-stamper/src/ethereum.ts

lots of great goodies here within the inline code comments themselves. we could link to this specifically within the changelog

andrewkmin · 2024-11-20T03:41:55Z

packages/wallet-stamper/src/stamper.ts

-          : await this.wallet.recoverPublicKey(payload, signature);
+      // For Ethereum, we need to recover the public key from the signature over the payload.
+      // This is because recovering the SECP256K1 public key requires a signed message.
+      // This avoids the an additional call to the wallet to get the public key.


tiny nit: let's choose one of the / an

can you explain how we avoid the additional call? wouldn't we need an extra one regardless in order to get that public key?

With solana I can call getPublicKey without triggering a signature request but with ethereum we need to derive it from the signature, so instead of calling getPublicKey we derive it from the signature over the payload

OH! right right, that's beautiful!

taylorjdawson marked this pull request as draft October 24, 2024 18:06

taylorjdawson requested review from andrewkmin, moe-dev and r-n-o October 24, 2024 22:50

taylorjdawson force-pushed the taylor/wallet-stamper-client branch from 4f9febe to 3447581 Compare October 25, 2024 00:13

taylorjdawson marked this pull request as ready for review October 25, 2024 18:20

andrewkmin reviewed Oct 28, 2024

View reviewed changes

examples/with-wallet-stamper/src/components/turnkey-provider.tsx Show resolved Hide resolved

andrewkmin reviewed Oct 28, 2024

View reviewed changes

taylorjdawson force-pushed the taylor/wallet-stamper-client branch from 8daddec to 77d0e7f Compare November 6, 2024 21:02

taylorjdawson commented Nov 7, 2024

View reviewed changes

taylorjdawson requested a review from andrewkmin November 7, 2024 01:24

andrewkmin reviewed Nov 11, 2024

View reviewed changes

packages/sdk-browser/src/sdk-client.ts Show resolved Hide resolved

packages/sdk-browser/src/sdk-client.ts Show resolved Hide resolved

taylorjdawson and others added 13 commits November 16, 2024 11:42

Adds wallet stamper client

5824ad8

Add wallet stamper client and update session storage

03e4519

Adds new session management and way to get authenticated client via r…

8ced57c

…eact-sdk

Use local storage not session storage

a77f63f

WIP: Adds wallet stamper to sdk-browser & sdk-react

af9e5d3

Adds a new helper class for stamping with Ethereum wallets

3b16ba0

Update readme + make walletClient non-async

a212461

Update naming from Evm -> Ethereum

8ee5190

Cleanup + addresses PR comments

4179040

remove unused hook

4f2a3ed

Address PR comments

bfcf57f

Add changeset

8bea78f

update pnpm lock

30789f0

andrewkmin force-pushed the taylor/wallet-stamper-client branch from 8fc4845 to 30789f0 Compare November 16, 2024 04:44

fix tests for update prod vars

dc93ce9

taylorjdawson added 3 commits November 18, 2024 21:11

Upgrade cross-spwan

a0ac1bc

Fix type errors

b98fb78

Remove extraneous test

830c3bc

taylorjdawson requested a review from andrewkmin November 19, 2024 17:21

andrewkmin reviewed Nov 20, 2024

View reviewed changes

taylorjdawson added 2 commits November 19, 2024 21:22

Copy/docs updates + nits

dd04ed1

Update lock file

f664137

taylorjdawson requested a review from andrewkmin November 20, 2024 05:29

andrewkmin approved these changes Nov 20, 2024

View reviewed changes

taylorjdawson merged commit 031d861 into main Nov 20, 2024
5 checks passed

taylorjdawson deleted the taylor/wallet-stamper-client branch November 20, 2024 06:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Taylor/wallet stamper client #409

Taylor/wallet stamper client #409

taylorjdawson commented Oct 24, 2024 •

edited

Loading

codesandbox-ci bot commented Oct 24, 2024 •

edited

Loading

socket-security bot commented Oct 25, 2024 •

edited

Loading

andrewkmin left a comment

andrewkmin Oct 28, 2024

taylorjdawson Nov 7, 2024

andrewkmin Nov 7, 2024

taylorjdawson Nov 13, 2024

andrewkmin Nov 16, 2024

taylorjdawson Nov 18, 2024

andrewkmin left a comment

andrewkmin Nov 20, 2024

taylorjdawson Nov 20, 2024

andrewkmin Nov 20, 2024

taylorjdawson Nov 20, 2024

andrewkmin Nov 20, 2024

andrewkmin Nov 20, 2024

taylorjdawson Nov 20, 2024

andrewkmin Nov 20, 2024

taylorjdawson Nov 20, 2024

andrewkmin Nov 20, 2024

andrewkmin Nov 20, 2024

taylorjdawson Nov 20, 2024

andrewkmin Nov 20, 2024

		@@ -140,13 +151,13 @@ export class TurnkeyBrowserSDK {
		*/
		currentUserSession = async (): Promise<TurnkeyBrowserClient \| undefined> => {

Taylor/wallet stamper client #409

Taylor/wallet stamper client #409

Conversation

taylorjdawson commented Oct 24, 2024 • edited Loading

Summary & Motivation

Changes

@turnkey/wallet-stamper

WalletStamper

@turnkey/sdk-browser

TurnkeyWalletClient

AuthClient (new enum)

TurnkeyBrowserClient, TurnkeyIframeClient, TurnkeyPasskeyClient, TurnkeyWalletClient

UserSession interface

StorageKeys enum

login and loginWithReadWriteSession methods

How I Tested These Changes

Did you add a changeset?

codesandbox-ci bot commented Oct 24, 2024 • edited Loading

socket-security bot commented Oct 25, 2024 • edited Loading

andrewkmin left a 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

andrewkmin left a 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

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

taylorjdawson commented Oct 24, 2024 •

edited

Loading

`@turnkey/wallet-stamper`

`WalletStamper`

`@turnkey/sdk-browser`

`TurnkeyWalletClient`

`AuthClient` (new enum)

`TurnkeyBrowserClient`, `TurnkeyIframeClient`, `TurnkeyPasskeyClient`, `TurnkeyWalletClient`

`UserSession` interface

`StorageKeys` enum

`login` and `loginWithReadWriteSession` methods

codesandbox-ci bot commented Oct 24, 2024 •

edited

Loading

socket-security bot commented Oct 25, 2024 •

edited

Loading