feat(wallet): set up sequence provider (#2772)

Author: nattb8

packages/passport/sdk/src/Passport.ts

@@ -15,7 +15,6 @@ import {
 import type { DirectLoginOptions } from '@imtbl/auth';
 import {
   connectWallet,
-  ZkEvmProvider,
   WalletConfiguration,
   GuardianClient,
   MagicTEESigner,
@@ -24,7 +23,7 @@ import {
   EvmChain,
   getChainConfig,
 } from '@imtbl/wallet';
-import type { LinkWalletParams, LinkedWallet } from '@imtbl/wallet';
+import type { Provider, LinkWalletParams, LinkedWallet } from '@imtbl/wallet';
 import {
   PassportModuleConfiguration,
   ConnectEvmArguments,
@@ -205,7 +204,7 @@ export class Passport {
    * @param {EvmChain} options.chain - The EVM chain to connect to (defaults to ZKEVM)
    * @returns {Promise<Provider>} The EVM provider instance
    */
-  public async connectEvm(options: ConnectEvmArguments = { announceProvider: true }): Promise<ZkEvmProvider> {
+  public async connectEvm(options: ConnectEvmArguments = { announceProvider: true }): Promise<Provider> {
     return withMetricsAsync(async () => {
       const chain = options?.chain ?? EvmChain.ZKEVM;
 

packages/passport/sdk/src/types.ts

@@ -2,6 +2,7 @@ import { Environment, ModuleConfiguration } from '@imtbl/config';
 import { IMXClient } from '@imtbl/x-client';
 import { ImxApiClients } from '@imtbl/generated-clients';
 import { Flow } from '@imtbl/metrics';
+import { EvmChain } from '@imtbl/wallet';
 
 /**
  * Direct login method identifier
@@ -13,6 +14,7 @@ export type DirectLoginMethod = string;
 // Re-export events from auth and wallet
 export { AuthEvents } from '@imtbl/auth';
 export { WalletEvents } from '@imtbl/wallet';
+export { EvmChain };
 
 export type AccountsRequestedEvent = {
   environment: Environment;
@@ -121,16 +123,13 @@ export type PKCEData = {
 // Re-export wallet linking types from wallet package
 export type { LinkWalletParams, LinkedWallet } from '@imtbl/wallet';
 
-// Re-export EvmChain enum for specifying which chain to connect to
-export { EvmChain } from '@imtbl/wallet';
-
 export type ConnectEvmArguments = {
   announceProvider: boolean;
   /**
    * The EVM chain to connect to (defaults to ZKEVM)
    * @default EvmChain.ZKEVM
    */
-  chain?: import('@imtbl/wallet').EvmChain;
+  chain?: EvmChain;
 };
 
 // Export ZkEvmProvider for return type

packages/wallet/src/connectWallet.test.ts

@@ -42,6 +42,10 @@ jest.mock('./zkEvm/zkEvmProvider', () => ({
   ZkEvmProvider: jest.fn(),
 }));
 
+jest.mock('./sequence/sequenceProvider', () => ({
+  SequenceProvider: jest.fn(),
+}));
+
 jest.mock('./provider/eip6963', () => ({
   announceProvider: jest.fn(),
   passportProviderInfo: { name: 'passport', rdns: 'com.immutable.passport', icon: '' },
@@ -51,15 +55,24 @@ const { connectWallet } = require('./connectWallet');
 
 const { announceProvider } = jest.requireMock('./provider/eip6963');
 const { ZkEvmProvider } = jest.requireMock('./zkEvm/zkEvmProvider');
+const { SequenceProvider } = jest.requireMock('./sequence/sequenceProvider');
 
-const chain = {
+const zkEvmChain = {
   chainId: 13473,
   rpcUrl: 'https://rpc.sandbox.immutable.com',
   relayerUrl: 'https://relayer.sandbox.immutable.com',
   apiUrl: 'https://api.sandbox.immutable.com',
   name: 'Immutable zkEVM Testnet',
 };
 
+const arbitrumChain = {
+  chainId: 42161,
+  rpcUrl: 'https://arb1.arbitrum.io/rpc',
+  relayerUrl: 'https://next-arbitrum-one-relayer.sequence.app',
+  apiUrl: 'https://api.immutable.com',
+  name: 'Arbitrum One',
+};
+
 const createAuthStub = () => ({
   getConfig: jest.fn().mockReturnValue({
     authenticationDomain: 'https://auth.immutable.com',
@@ -82,7 +95,7 @@ describe('connectWallet', () => {
   it('announces provider by default', async () => {
     const auth = createAuthStub();
 
-    const provider = await connectWallet({ auth, chains: [chain] });
+    const provider = await connectWallet({ auth, chains: [zkEvmChain] });
 
     expect(ZkEvmProvider).toHaveBeenCalled();
     expect(announceProvider).toHaveBeenCalledWith({
@@ -94,8 +107,46 @@ describe('connectWallet', () => {
   it('does not announce provider when disabled', async () => {
     const auth = createAuthStub();
 
-    await connectWallet({ auth, chains: [chain], announceProvider: false });
+    await connectWallet({ auth, chains: [zkEvmChain], announceProvider: false });
 
     expect(announceProvider).not.toHaveBeenCalled();
   });
+
+  describe('provider selection', () => {
+    it('uses ZkEvmProvider for zkEVM chain (by chainId)', async () => {
+      const auth = createAuthStub();
+
+      await connectWallet({ auth, chains: [zkEvmChain] });
+
+      expect(ZkEvmProvider).toHaveBeenCalled();
+      expect(SequenceProvider).not.toHaveBeenCalled();
+    });
+
+    it('uses ZkEvmProvider for chain with magic config', async () => {
+      const auth = createAuthStub();
+      const devChain = {
+        chainId: 99999, // unknown chainId
+        rpcUrl: 'https://rpc.dev.immutable.com',
+        relayerUrl: 'https://relayer.dev.immutable.com',
+        apiUrl: 'https://api.dev.immutable.com',
+        name: 'Dev Chain',
+        magicPublishableApiKey: 'pk_test_123',
+        magicProviderId: 'provider-123',
+      };
+
+      await connectWallet({ auth, chains: [devChain] });
+
+      expect(ZkEvmProvider).toHaveBeenCalled();
+      expect(SequenceProvider).not.toHaveBeenCalled();
+    });
+
+    it('uses SequenceProvider for non-zkEVM chain (Arbitrum)', async () => {
+      const auth = createAuthStub();
+
+      await connectWallet({ auth, chains: [arbitrumChain] });
+
+      expect(SequenceProvider).toHaveBeenCalled();
+      expect(ZkEvmProvider).not.toHaveBeenCalled();
+    });
+  });
 });

packages/wallet/src/connectWallet.ts

@@ -10,13 +10,19 @@ import {
   mr,
 } from '@imtbl/generated-clients';
 import { ZkEvmProvider } from './zkEvm/zkEvmProvider';
-import { ConnectWalletOptions, PassportEventMap, ChainConfig } from './types';
+import { SequenceProvider } from './sequence/sequenceProvider';
+import {
+  ConnectWalletOptions, PassportEventMap, ChainConfig, Provider,
+} from './types';
 import { WalletConfiguration } from './config';
 import GuardianClient from './guardian';
 import MagicTEESigner from './magic/magicTEESigner';
 import { announceProvider, passportProviderInfo } from './provider/eip6963';
 import { DEFAULT_CHAINS } from './presets';
-import { MAGIC_CONFIG, IMMUTABLE_ZKEVM_TESTNET_CHAIN_ID } from './constants';
+import {
+  MAGIC_CONFIG,
+  IMMUTABLE_ZKEVM_TESTNET_CHAIN_ID,
+} from './constants';
 
 /**
  * Type guard to check if chainId is a valid key for MAGIC_CONFIG
@@ -64,6 +70,11 @@ const DEFAULT_REDIRECT_FALLBACK = 'https://auth.immutable.com/im-logged-in';
 const DEFAULT_AUTHENTICATION_DOMAIN = 'https://auth.immutable.com';
 const SANDBOX_DOMAIN_REGEX = /(sandbox|testnet)/i;
 
+function isZkEvmChain(chain: ChainConfig): boolean {
+  // Only zkEVM chains use magic
+  return !!chain.magicPublishableApiKey || isValidMagicChainId(chain.chainId);
+}
+
 function isSandboxChain(chain: ChainConfig): boolean {
   if (chain.chainId === IMMUTABLE_ZKEVM_TESTNET_CHAIN_ID) {
     return true;
@@ -156,7 +167,7 @@ function createDefaultAuth(initialChain: ChainConfig, options: ConnectWalletOpti
  */
 export async function connectWallet(
   config: ConnectWalletOptions = {},
-): Promise<ZkEvmProvider> {
+): Promise<Provider> {
   // Use default chains if not provided (testnet + mainnet)
   const chains = config.chains && config.chains.length > 0
     ? config.chains
@@ -216,7 +227,10 @@ export async function connectWallet(
     feeTokenSymbol: config.feeTokenSymbol,
   });
 
-  // 6. Create GuardianClient
+  // 6. Create PassportEventEmitter
+  const passportEventEmitter = config.passportEventEmitter || new TypedEventEmitter<PassportEventMap>();
+
+  // 7. Create GuardianClient
   const guardianApi = new mr.GuardianApi(apiConfig);
 
   const guardianClient = new GuardianClient({
@@ -226,50 +240,57 @@ export async function connectWallet(
     authConfig,
   });
 
-  // 7. Get Magic config for initial chain (from chain config or hard-coded default)
-  const magicConfig = getMagicConfigForChain(initialChain);
+  // 8. Create provider based on chain type
+  let provider: Provider;
 
-  // 8. Create MagicTEESigner with Magic TEE base path (separate from backend API)
-  const magicTeeBasePath = initialChain.magicTeeBasePath || 'https://tee.express.magiclabs.com';
-  const magicTeeApiClients = new MagicTeeApiClients({
-    basePath: magicTeeBasePath,
-    timeout: 10000,
-    magicPublishableApiKey: magicConfig.magicPublishableApiKey,
-    magicProviderId: magicConfig.magicProviderId,
-  });
+  if (isZkEvmChain(initialChain)) {
+    // 9. Get Magic config for initial chain (from chain config or hard-coded default)
+    const magicConfig = getMagicConfigForChain(initialChain);
 
-  const ethSigner = new MagicTEESigner(auth, magicTeeApiClients);
-
-  // 9. Determine session activity API URL (only for mainnet, testnet, devnet)
-  let sessionActivityApiUrl: string | null = null;
-  if (initialChain.chainId === 13371) {
-    // Mainnet
-    sessionActivityApiUrl = 'https://api.immutable.com';
-  } else if (initialChain.chainId === 13473) {
-    // Testnet
-    sessionActivityApiUrl = 'https://api.sandbox.immutable.com';
-  } else if (initialChain.apiUrl) {
-    // Devnet - use the apiUrl from chain config
-    sessionActivityApiUrl = initialChain.apiUrl;
+    // 10. Create MagicTEESigner with Magic TEE base path (separate from backend API)
+    const magicTeeBasePath = initialChain.magicTeeBasePath || 'https://tee.express.magiclabs.com';
+    const magicTeeApiClients = new MagicTeeApiClients({
+      basePath: magicTeeBasePath,
+      timeout: 10000,
+      magicPublishableApiKey: magicConfig.magicPublishableApiKey,
+      magicProviderId: magicConfig.magicProviderId,
+    });
+    const ethSigner = new MagicTEESigner(auth, magicTeeApiClients);
+
+    // 11. Determine session activity API URL (only for mainnet, testnet, devnet)
+    let sessionActivityApiUrl: string | null = null;
+    if (initialChain.chainId === 13371) {
+      // Mainnet
+      sessionActivityApiUrl = 'https://api.immutable.com';
+    } else if (initialChain.chainId === 13473) {
+      // Testnet
+      sessionActivityApiUrl = 'https://api.sandbox.immutable.com';
+    } else if (initialChain.apiUrl) {
+      // Devnet - use the apiUrl from chain config
+      sessionActivityApiUrl = initialChain.apiUrl;
+    }
+    // For any other chain, sessionActivityApiUrl remains null (no session activity tracking)
+
+    // 12. Create ZkEvmProvider
+    provider = new ZkEvmProvider({
+      auth,
+      config: walletConfig,
+      multiRollupApiClients,
+      passportEventEmitter,
+      guardianClient,
+      ethSigner,
+      user,
+      sessionActivityApiUrl,
+    });
+  } else {
+    // Non-zkEVM chain - use SequenceProvider
+    provider = new SequenceProvider({
+      chainConfig: initialChain,
+      guardianClient,
+    });
   }
-  // For any other chain, sessionActivityApiUrl remains null (no session activity tracking)
-
-  // 10. Create PassportEventEmitter
-  const passportEventEmitter = config.passportEventEmitter || new TypedEventEmitter<PassportEventMap>();
-
-  // 11. Create ZkEvmProvider
-  const provider = new ZkEvmProvider({
-    auth,
-    config: walletConfig,
-    multiRollupApiClients,
-    passportEventEmitter,
-    guardianClient,
-    ethSigner,
-    user,
-    sessionActivityApiUrl,
-  });
 
-  // 12. Announce provider via EIP-6963
+  // 13. Announce provider via EIP-6963
   if (config.announceProvider !== false) {
     announceProvider({
       info: passportProviderInfo,

packages/wallet/src/index.ts

@@ -28,8 +28,9 @@ export {
 // Export chain registry for looking up chain configs
 export { getChainConfig } from './chainRegistry';
 
-// Export main wallet provider
+// Export main wallet providers
 export { ZkEvmProvider } from './zkEvm/zkEvmProvider';
+export { SequenceProvider } from './sequence/sequenceProvider';
 
 // Export internal configuration (for Passport/advanced usage)
 export { WalletConfiguration } from './config';