Taylor/wallet stamper client

taylorjdawson commented 4 weeks ago

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[bot] commented 4 weeks ago

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[bot] commented 4 weeks ago

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

Package	New capabilities	Transitives	Size	Publisher
npm/@changesets/cli@2.27.9	Transitive: environment, eval, filesystem, shell, unsafe	`+102`	16 MB	changesets-release-bot
npm/usehooks-ts@3.1.0	None	`+1`	265 kB	junscuzzy
npm/viem@2.21.35	Transitive: environment, filesystem, network	`+25`	23.8 MB	awkweb, jmoxey

🚮 Removed packages: npm/@changesets/cli@2.27.5, npm/viem@2.18.8, npm/viem@2.21.29

View full report↗︎

tkhq / sdk