@eth-optimism/actions-sdk 0.0.3 → 0.0.4

package/src/wallet/node/providers/hosted/registry/__tests__/NodeHostedWalletProviderRegistry.spec.ts

@@ -1,11 +1,14 @@
-import type { PrivyClient } from '@privy-io/server-auth'
+import type { PrivyClient } from '@privy-io/node'
 import type { TurnkeyClient } from '@turnkey/http'
 import { unichain } from 'viem/chains'
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
 
 import type { ChainManager } from '@/services/ChainManager.js'
 import { MockChainManager } from '@/test/MockChainManager.js'
-import { createMockPrivyClient } from '@/test/MockPrivyClient.js'
+import {
+  createMockPrivyClient,
+  getMockAuthorizationContext,
+} from '@/test/MockPrivyClient.js'
 import { PrivyHostedWalletProvider } from '@/wallet/node/providers/hosted/privy/PrivyHostedWalletProvider.js'
 import { NodeHostedWalletProviderRegistry } from '@/wallet/node/providers/hosted/registry/NodeHostedWalletProviderRegistry.js'
 import { TurnkeyHostedWalletProvider } from '@/wallet/node/providers/hosted/turnkey/TurnkeyHostedWalletProvider.js'
@@ -31,6 +34,12 @@ describe('NodeHostedWalletProviderRegistry', () => {
     const factory = registry.getFactory('privy')
 
     expect(factory.type).toBe('privy')
+    expect(
+      factory.validateOptions?.({
+        privyClient: mockPrivyClient,
+        authorizationContext: getMockAuthorizationContext(),
+      } as NodeOptionsMap['privy']),
+    ).toBe(true)
     expect(
       factory.validateOptions?.({
         privyClient: mockPrivyClient,
@@ -38,6 +47,11 @@ describe('NodeHostedWalletProviderRegistry', () => {
     ).toBe(true)
     // Invalid shape should not pass validation
     expect(factory.validateOptions?.({})).toBe(false)
+    expect(
+      factory.validateOptions?.({
+        authorizationContext: getMockAuthorizationContext(),
+      } as NodeOptionsMap['privy']),
+    ).toBe(false)
   })
 
   it('creates a PrivyHostedWalletProvider instance', () => {
@@ -46,6 +60,7 @@ describe('NodeHostedWalletProviderRegistry', () => {
 
     const provider = factory.create({ chainManager: mockChainManager }, {
       privyClient: mockPrivyClient,
+      authorizationContext: getMockAuthorizationContext(),
     } as NodeOptionsMap['privy'])
 
     expect(provider).toBeInstanceOf(PrivyHostedWalletProvider)

package/src/wallet/node/providers/hosted/types/index.ts

@@ -1,4 +1,4 @@
-import type { PrivyClient } from '@privy-io/server-auth'
+import type { AuthorizationContext, PrivyClient } from '@privy-io/node'
 import type { TurnkeySDKClientBase } from '@turnkey/core'
 import type { TurnkeyClient as TurnkeyHttpClient } from '@turnkey/http'
 import type { TurnkeyServerClient } from '@turnkey/sdk-server'
@@ -29,8 +29,15 @@ export interface NodeOptionsMap {
   /**
    * Privy provider configuration
    * @property privyClient Server-side Privy client instance used to query/create wallets
+   * @property authorizationContext Optional authorization context for the Privy client.
+   * Used when Privy needs to sign requests.
+   * See https://docs.privy.io/controls/authorization-keys/using-owners/sign/automatic#using-the-authorization-context
+   * for more information on building and using the authorization context.
    */
-  privy: { privyClient: PrivyClient }
+  privy: {
+    privyClient: PrivyClient
+    authorizationContext?: AuthorizationContext
+  }
   /**
    * Turnkey provider configuration
    * @property client Turnkey SDK/HTTP client used to sign and manage keys

package/src/wallet/node/wallets/hosted/privy/PrivyWallet.ts

@@ -1,4 +1,4 @@
-import type { PrivyClient } from '@privy-io/server-auth'
+import type { AuthorizationContext, PrivyClient } from '@privy-io/node'
 import { type Address, type LocalAccount } from 'viem'
 
 import type { ChainManager } from '@/services/ChainManager.js'
@@ -15,12 +15,15 @@ export class PrivyWallet extends EOAWallet {
   public signer!: LocalAccount
   public readonly address: Address
   private privyClient: PrivyClient
-
+  private authorizationContext?: AuthorizationContext
   /**
-   * Create a new Privy wallet provider
-   * @param appId - Privy application ID
-   * @param appSecret - Privy application secret
-   * @param actions - Actions instance for accessing configured providers
+   * Create a new Privy wallet instance
+   * @param privyClient - Privy client instance for wallet operations
+   * @param authorizationContext - Authorization context for signing requests
+   * @param walletId - Privy wallet identifier
+   * @param address - Ethereum address of the wallet
+   * @param chainManager - Chain manager for multi-chain operations
+   * @param lendProvider - Optional lend provider for DeFi operations
    */
   private constructor(
     privyClient: PrivyClient,
@@ -28,15 +31,18 @@ export class PrivyWallet extends EOAWallet {
     address: Address,
     chainManager: ChainManager,
     lendProvider?: LendProvider<LendConfig>,
+    authorizationContext?: AuthorizationContext,
   ) {
     super(chainManager, lendProvider)
     this.privyClient = privyClient
+    this.authorizationContext = authorizationContext
     this.walletId = walletId
     this.address = address
   }
 
   static async create(params: {
     privyClient: PrivyClient
+    authorizationContext?: AuthorizationContext
     walletId: string
     address: Address
     chainManager: ChainManager
@@ -48,6 +54,7 @@ export class PrivyWallet extends EOAWallet {
       params.address,
       params.chainManager,
       params.lendProvider,
+      params.authorizationContext,
     )
     await wallet.initialize()
     return wallet
@@ -73,6 +80,7 @@ export class PrivyWallet extends EOAWallet {
       walletId: this.walletId,
       address: this.address,
       privyClient: this.privyClient,
+      authorizationContext: this.authorizationContext,
     })
   }
 }

package/src/wallet/node/wallets/hosted/privy/__tests__/PrivyWallet.spec.ts

@@ -1,5 +1,5 @@
-import type { PrivyClient } from '@privy-io/server-auth'
-import { createViemAccount } from '@privy-io/server-auth/viem'
+import type { AuthorizationContext } from '@privy-io/node'
+import { createViemAccount } from '@privy-io/node/viem'
 import {
   type Address,
   createWalletClient,
@@ -8,11 +8,15 @@ import {
   type WalletClient,
 } from 'viem'
 import { unichain } from 'viem/chains'
-import { describe, expect, it, vi } from 'vitest'
+import { beforeEach, describe, expect, it, vi } from 'vitest'
 
 import type { ChainManager } from '@/services/ChainManager.js'
 import { MockChainManager } from '@/test/MockChainManager.js'
-import { createMockPrivyClient } from '@/test/MockPrivyClient.js'
+import {
+  createMockPrivyClient,
+  createMockPrivyWallet,
+  getMockAuthorizationContext,
+} from '@/test/MockPrivyClient.js'
 import { getRandomAddress } from '@/test/utils.js'
 import { PrivyWallet } from '@/wallet/node/wallets/hosted/privy/PrivyWallet.js'
 
@@ -28,9 +32,9 @@ vi.mock('viem/accounts', async () => ({
   toAccount: vi.fn(),
 }))
 
-vi.mock('@privy-io/server-auth/viem', async () => ({
+vi.mock('@privy-io/node/viem', async () => ({
   // @ts-ignore - importActual returns unknown
-  ...(await vi.importActual('@privy-io/server-auth/viem')),
+  ...(await vi.importActual('@privy-io/node/viem')),
   createViemAccount: vi.fn(),
 }))
 
@@ -48,10 +52,12 @@ const mockLocalAccount = {
 } as unknown as LocalAccount
 
 describe('PrivyWallet', () => {
+  beforeEach(() => {
+    vi.clearAllMocks()
+  })
+
   it('should return the correct wallet ID', async () => {
-    const createdWallet = await mockPrivyClient.walletApi.createWallet({
-      chainType: 'ethereum',
-    })
+    const createdWallet = createMockPrivyWallet()
 
     const wallet = await createAndInitPrivyWallet({
       address: getAddress(createdWallet.address),
@@ -62,9 +68,7 @@ describe('PrivyWallet', () => {
   })
 
   it('should return the correct address', async () => {
-    const createdWallet = await mockPrivyClient.walletApi.createWallet({
-      chainType: 'ethereum',
-    })
+    const createdWallet = createMockPrivyWallet()
 
     const wallet = await createAndInitPrivyWallet({
       address: getAddress(createdWallet.address),
@@ -76,28 +80,29 @@ describe('PrivyWallet', () => {
 
   it('should create an account with correct configuration', async () => {
     // Create a wallet using the mock client first
-    const createdWallet = await mockPrivyClient.walletApi.createWallet({
-      chainType: 'ethereum',
-    })
+    const createdWallet = createMockPrivyWallet()
     vi.mocked(createViemAccount).mockResolvedValue(mockLocalAccount)
+    const authorizationContext = getMockAuthorizationContext()
     const wallet = await createAndInitPrivyWallet({
       address: getAddress(createdWallet.address),
       walletId: createdWallet.id,
+      authorizationContext,
     })
 
-    expect(createViemAccount).toHaveBeenCalledWith({
+    expect(createViemAccount).toHaveBeenCalledWith(mockPrivyClient, {
       walletId: createdWallet.id,
       address: createdWallet.address,
-      privy: mockPrivyClient,
+      authorizationContext,
     })
     expect(wallet.signer).toBe(mockLocalAccount)
   })
 
   it('should create a wallet client with correct configuration', async () => {
-    const createdWallet = await mockPrivyClient.walletApi.createWallet({
-      chainType: 'ethereum',
+    const createdWallet = createMockPrivyWallet()
+    const wallet = await createAndInitPrivyWallet({
+      walletId: createdWallet.id,
+      address: createdWallet.address,
     })
-    const wallet = await createAndInitPrivyWallet()
 
     const mockWalletClient = {
       account: mockLocalAccount,
@@ -116,27 +121,17 @@ describe('PrivyWallet', () => {
   })
 })
 
-async function createAndInitPrivyWallet(
-  params: {
-    privyClient?: PrivyClient
-    walletId?: string
-    address?: Address
-    chainManager?: ChainManager
-  } = {},
-) {
-  const {
-    privyClient = mockPrivyClient,
+async function createAndInitPrivyWallet(params: {
+  walletId: string
+  address: Address
+  authorizationContext?: AuthorizationContext
+}) {
+  const { walletId, address, authorizationContext } = params
+  return PrivyWallet.create({
+    privyClient: mockPrivyClient,
+    authorizationContext: authorizationContext ?? getMockAuthorizationContext(),
     walletId,
     address,
-    chainManager = mockChainManager,
-  } = params
-  const createdWallet = await privyClient.walletApi.createWallet({
-    chainType: 'ethereum',
-  })
-  return PrivyWallet.create({
-    privyClient,
-    walletId: walletId ?? createdWallet.id,
-    address: address ?? getAddress(createdWallet.address),
-    chainManager,
+    chainManager: mockChainManager,
   })
 }

package/src/wallet/node/wallets/hosted/privy/utils/__tests__/createSigner.spec.ts

@@ -1,14 +1,18 @@
-import { createViemAccount } from '@privy-io/server-auth/viem'
-import type { Address, LocalAccount } from 'viem'
+import { createViemAccount } from '@privy-io/node/viem'
+import type { LocalAccount } from 'viem'
 import { describe, expect, it, vi } from 'vitest'
 
-import { createMockPrivyClient } from '@/test/MockPrivyClient.js'
+import {
+  createMockPrivyClient,
+  createMockPrivyWallet,
+  getMockAuthorizationContext,
+} from '@/test/MockPrivyClient.js'
 import { getRandomAddress } from '@/test/utils.js'
 import { createSigner } from '@/wallet/node/wallets/hosted/privy/utils/createSigner.js'
 
-vi.mock('@privy-io/server-auth/viem', async () => ({
+vi.mock('@privy-io/node/viem', async () => ({
   // @ts-ignore - importActual returns unknown
-  ...(await vi.importActual('@privy-io/server-auth/viem')),
+  ...(await vi.importActual('@privy-io/node/viem')),
   createViemAccount: vi.fn(),
 }))
 
@@ -26,22 +30,22 @@ describe('createSigner (Node Privy)', () => {
     signTypedData: vi.fn(),
   } as unknown as LocalAccount
 
-  it('should create a LocalAccount with correct configuration', async () => {
-    const createdWallet = await mockPrivyClient.walletApi.createWallet({
-      chainType: 'ethereum',
-    })
-    vi.mocked(createViemAccount).mockResolvedValue(mockLocalAccount)
+  it('should create a LocalAccount with correct configuration', () => {
+    const createdWallet = createMockPrivyWallet()
+    vi.mocked(createViemAccount).mockReturnValue(mockLocalAccount)
+    const authorizationContext = getMockAuthorizationContext()
 
-    const signer = await createSigner({
+    const signer = createSigner({
       privyClient: mockPrivyClient,
+      authorizationContext: authorizationContext,
       walletId: createdWallet.id,
-      address: createdWallet.address as Address,
+      address: createdWallet.address,
     })
 
-    expect(createViemAccount).toHaveBeenCalledWith({
+    expect(createViemAccount).toHaveBeenCalledWith(mockPrivyClient, {
       walletId: createdWallet.id,
       address: createdWallet.address,
-      privy: mockPrivyClient,
+      authorizationContext,
     })
     expect(signer).toBe(mockLocalAccount)
   })

package/src/wallet/node/wallets/hosted/privy/utils/createSigner.ts

@@ -1,5 +1,4 @@
-import type { GetViemAccountInputType } from '@privy-io/server-auth/viem'
-import { createViemAccount } from '@privy-io/server-auth/viem'
+import { createViemAccount } from '@privy-io/node/viem'
 import type { LocalAccount } from 'viem'
 
 import type {
@@ -15,18 +14,21 @@ import type {
  * @param params.walletId - Privy wallet identifier
  * @param params.address - Ethereum address of the wallet
  * @param params.privyClient - Privy client instance
- * @returns Promise resolving to a LocalAccount configured for signing operations
+ * @param params.authorizationContext - Optional authorization context for the Privy client.
+ * Used when Privy needs to sign requests.
+ * See https://docs.privy.io/controls/authorization-keys/using-owners/sign/automatic#using-the-authorization-context
+ * for more information on building and using the authorization context.
+ * @returns LocalAccount configured for signing operations
  * @throws Error if wallet retrieval fails or signing operations are not supported
  */
-export async function createSigner(
+export function createSigner(
   params: PrivyHostedWalletToActionsWalletOptions & NodeOptionsMap['privy'],
-): Promise<LocalAccount> {
-  const { walletId, address, privyClient } = params
-  const account = await createViemAccount({
+): LocalAccount {
+  const { walletId, address, privyClient, authorizationContext } = params
+  const account = createViemAccount(privyClient, {
     walletId,
     address,
-    // TODO: Fix this type error
-    privy: privyClient as unknown as GetViemAccountInputType['privy'],
+    authorizationContext,
   })
   return account
 }