@eth-optimism/actions-sdk 0.0.0-main-20251009211102

package/src/wallet/react/wallets/hosted/turnkey/__tests__/TurnkeyWallet.spec.ts

@@ -0,0 +1,99 @@
+import type { TurnkeySDKClientBase } from '@turnkey/react-wallet-kit'
+import { createAccount } from '@turnkey/viem'
+import type { LocalAccount, WalletClient } from 'viem'
+import { createWalletClient } from 'viem'
+import { unichain } from 'viem/chains'
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+
+import type { ChainManager } from '@/services/ChainManager.js'
+import { MockChainManager } from '@/test/MockChainManager.js'
+import { getRandomAddress } from '@/test/utils.js'
+import { TurnkeyWallet } from '@/wallet/react/wallets/hosted/turnkey/TurnkeyWallet.js'
+
+vi.mock('viem', async () => ({
+  // @ts-ignore - importActual returns unknown
+  ...(await vi.importActual('viem')),
+  createWalletClient: vi.fn(),
+}))
+
+vi.mock('@turnkey/viem', async () => ({
+  createAccount: vi.fn(),
+}))
+
+const mockAddress = getRandomAddress()
+const mockChainManager = new MockChainManager({
+  supportedChains: [unichain.id],
+}) as unknown as ChainManager
+
+function createMockTurnkeyClient(): TurnkeySDKClientBase {
+  return {
+    // minimal shape for typing; createAccount uses this via @turnkey/viem
+  } as unknown as TurnkeySDKClientBase
+}
+
+describe('TurnkeyWallet', () => {
+  beforeEach(() => {
+    vi.clearAllMocks()
+  })
+
+  it('should initialize signer and address from Turnkey account', async () => {
+    const mockLocalAccount = { address: mockAddress } as unknown as LocalAccount
+    vi.mocked(createAccount).mockResolvedValue(mockLocalAccount)
+
+    const wallet = await TurnkeyWallet.create({
+      client: createMockTurnkeyClient(),
+      organizationId: 'org_123',
+      signWith: 'key_abc',
+      chainManager: mockChainManager,
+    })
+
+    expect(wallet.address).toBe(mockAddress)
+    expect(wallet.signer).toBe(mockLocalAccount)
+    expect(createAccount).toHaveBeenCalledOnce()
+    const args = vi.mocked(createAccount).mock.calls[0][0]
+    expect(args.client).toEqual(createMockTurnkeyClient())
+    expect(args.organizationId).toBe('org_123')
+    expect(args.signWith).toBe('key_abc')
+    expect(args.ethereumAddress).toBeUndefined()
+  })
+
+  it('takes ethereumAddress', async () => {
+    const mockLocalAccount = { address: mockAddress } as unknown as LocalAccount
+    vi.mocked(createAccount).mockResolvedValue(mockLocalAccount)
+
+    await TurnkeyWallet.create({
+      client: createMockTurnkeyClient(),
+      organizationId: 'org_123',
+      signWith: 'key_abc',
+      ethereumAddress: '0x123',
+      chainManager: mockChainManager,
+    })
+
+    const args = vi.mocked(createAccount).mock.calls[0][0]
+    expect(args.ethereumAddress).toBe('0x123')
+  })
+
+  it('should create a wallet client with correct configuration', async () => {
+    const mockLocalAccount = { address: mockAddress } as unknown as LocalAccount
+    vi.mocked(createAccount).mockResolvedValue(mockLocalAccount)
+    const wallet = await TurnkeyWallet.create({
+      client: createMockTurnkeyClient(),
+      organizationId: 'org_123',
+      signWith: 'key_abc',
+      chainManager: mockChainManager,
+    })
+    const mockWalletClient = {
+      account: mockLocalAccount,
+      address: mockAddress,
+    } as unknown as WalletClient
+    vi.mocked(createWalletClient).mockResolvedValue(mockWalletClient)
+
+    const walletClient = await wallet.walletClient(unichain.id)
+
+    expect(createWalletClient).toHaveBeenCalledOnce()
+    const args = vi.mocked(createWalletClient).mock.calls[0][0]
+    expect(args.account).toBe(mockLocalAccount)
+    expect(args.chain).toBe(mockChainManager.getChain(unichain.id))
+    expect(walletClient).toBe(mockWalletClient)
+  })
+})

package/src/wallet/react/wallets/hosted/turnkey/utils/__tests__/createSigner.spec.ts

@@ -0,0 +1,72 @@
+import type { TurnkeySDKClientBase } from '@turnkey/react-wallet-kit'
+import { createAccount } from '@turnkey/viem'
+import type { LocalAccount } from 'viem'
+import { describe, expect, it, vi } from 'vitest'
+
+import { getRandomAddress } from '@/test/utils.js'
+import { createSigner } from '@/wallet/react/wallets/hosted/turnkey/utils/createSigner.js'
+
+vi.mock('@turnkey/viem', async () => ({
+  createAccount: vi.fn(),
+}))
+
+function createMockTurnkeyClient(): TurnkeySDKClientBase {
+  return {
+    // minimal shape for typing; createAccount uses this via @turnkey/viem
+  } as unknown as TurnkeySDKClientBase
+}
+
+describe('createSigner (React Turnkey)', () => {
+  const mockAddress = getRandomAddress()
+
+  it('should create a LocalAccount with correct configuration', async () => {
+    const mockLocalAccount = {
+      address: mockAddress,
+      signMessage: vi.fn(),
+      sign: vi.fn(),
+      signTransaction: vi.fn(),
+      signTypedData: vi.fn(),
+    } as unknown as LocalAccount
+    vi.mocked(createAccount).mockResolvedValue(mockLocalAccount)
+
+    const client = createMockTurnkeyClient()
+    const signer = await createSigner({
+      client,
+      organizationId: 'org_123',
+      signWith: 'key_abc',
+    })
+
+    expect(createAccount).toHaveBeenCalledWith({
+      client,
+      organizationId: 'org_123',
+      signWith: 'key_abc',
+      ethereumAddress: undefined,
+    })
+    expect(signer).toBe(mockLocalAccount)
+  })
+
+  it('should pass ethereumAddress when provided', async () => {
+    const mockLocalAccount = {
+      address: mockAddress,
+      type: 'local',
+    } as unknown as LocalAccount
+    vi.mocked(createAccount).mockResolvedValue(mockLocalAccount)
+
+    const client = createMockTurnkeyClient()
+    const ethereumAddress = getRandomAddress()
+    const signer = await createSigner({
+      client,
+      organizationId: 'org_123',
+      signWith: 'key_abc',
+      ethereumAddress,
+    })
+
+    expect(createAccount).toHaveBeenCalledWith({
+      client,
+      organizationId: 'org_123',
+      signWith: 'key_abc',
+      ethereumAddress,
+    })
+    expect(signer).toBe(mockLocalAccount)
+  })
+})

package/src/wallet/react/wallets/hosted/turnkey/utils/createSigner.ts

@@ -0,0 +1,29 @@
+import { createAccount } from '@turnkey/viem'
+import type { LocalAccount } from 'viem'
+
+import type { TurnkeyHostedWalletToActionsWalletOptions } from '@/wallet/react/providers/hosted/types/index.js'
+
+/**
+ * Create a viem LocalAccount instance backed by Turnkey
+ * @description Wraps the Turnkey SDK's `createAccount` to produce a signing
+ * account compatible with viem. Under the hood, this uses the provided
+ * `client`, `organizationId`, and `signWith` to authenticate signing requests
+ * with Turnkey. If `ethereumAddress` is supplied, it's used directly;
+ * otherwise the SDK fetches it from the Turnkey API.
+ * @param params.client - Turnkey client instance
+ * @param params.organizationId - Turnkey organization ID that owns the signing key
+ * @param params.signWith - Wallet account address, private key address, or private key ID
+ * @param params.ethereumAddress - Ethereum address to use for this account, in the case that a private key ID is used to sign.
+ * @returns Promise resolving to a viem `LocalAccount` with Turnkey as the signer backend
+ */
+export async function createSigner(
+  params: TurnkeyHostedWalletToActionsWalletOptions,
+): Promise<LocalAccount> {
+  const { client, organizationId, signWith, ethereumAddress } = params
+  return createAccount({
+    client,
+    organizationId,
+    signWith,
+    ethereumAddress,
+  })
+}