@imtbl/passport 2.8.1-alpha.0 → 2.9.0-alpha.0

package/dist/types/magic/magicTEESigner.d.ts

@@ -0,0 +1,24 @@
+import { AbstractSigner, Signer } from 'ethers';
+import { MagicTeeApiClients } from '@imtbl/generated-clients';
+import AuthManager from '../authManager';
+export default class MagicTEESigner extends AbstractSigner {
+    private readonly authManager;
+    private readonly magicTeeApiClient;
+    private userWallet;
+    private createWalletPromise;
+    constructor(authManager: AuthManager, magicTeeApiClient: MagicTeeApiClients);
+    private getUserWallet;
+    /**
+     * This method calls the createWallet endpoint. The user's wallet must be created before it can be used to sign messages.
+     * The createWallet endpoint is idempotent, so it can be called multiple times without causing an error.
+     * If a createWallet request is already in flight, return the existing promise.
+     */
+    private createWallet;
+    private getUserOrThrow;
+    private static getHeaders;
+    getAddress(): Promise<string>;
+    signMessage(message: string | Uint8Array): Promise<string>;
+    connect(): Signer;
+    signTransaction(): Promise<string>;
+    signTypedData(): Promise<string>;
+}

package/dist/types/mocks/zkEvm/msw.d.ts

@@ -3,6 +3,16 @@ import { MockedRequest, RequestHandler } from 'msw';
 export declare const relayerId = "0x745";
 export declare const transactionHash = "0x867";
 export declare const mswHandlers: {
+    magicTEE: {
+        createWallet: {
+            success: import("msw").RestHandler<MockedRequest<import("msw").DefaultBodyType>>;
+            internalServerError: import("msw").RestHandler<MockedRequest<import("msw").DefaultBodyType>>;
+        };
+        personalSign: {
+            success: import("msw").RestHandler<MockedRequest<import("msw").DefaultBodyType>>;
+            internalServerError: import("msw").RestHandler<MockedRequest<import("msw").DefaultBodyType>>;
+        };
+    };
     counterfactualAddress: {
         success: import("msw").RestHandler<MockedRequest<import("msw").DefaultBodyType>>;
         internalServerError: import("msw").RestHandler<MockedRequest<import("msw").DefaultBodyType>>;

package/dist/types/starkEx/passportImxProvider.d.ts

@@ -2,16 +2,16 @@ import { AnyToken, IMXClient, NftTransferDetails, TokenAmount, UnsignedExchangeT
 import { IMXProvider } from '@imtbl/x-provider';
 import { imx, ImxApiClients } from '@imtbl/generated-clients';
 import { TransactionResponse } from 'ethers';
-import TypedEventEmitter from '../utils/typedEventEmitter';
 import AuthManager from '../authManager';
 import GuardianClient from '../guardian';
 import { PassportEventMap } from '../types';
-import MagicAdapter from '../magic/magicAdapter';
+import MagicTEESigner from '../magic/magicTEESigner';
+import TypedEventEmitter from '../utils/typedEventEmitter';
 export interface PassportImxProviderOptions {
     authManager: AuthManager;
     immutableXClient: IMXClient;
     passportEventEmitter: TypedEventEmitter<PassportEventMap>;
-    magicAdapter: MagicAdapter;
+    magicTEESigner: MagicTEESigner;
     imxApiClients: ImxApiClients;
     guardianClient: GuardianClient;
 }
@@ -21,16 +21,16 @@ export declare class PassportImxProvider implements IMXProvider {
     private readonly immutableXClient;
     protected readonly guardianClient: GuardianClient;
     protected readonly imxApiClients: ImxApiClients;
-    protected magicAdapter: MagicAdapter;
+    protected magicTEESigner: MagicTEESigner;
     /**
      * This property is set during initialisation and stores the signers in a promise.
      * This property is not meant to be accessed directly, but through the
      * `#getSigners` method.
      * @see #getSigners
      */
-    private signers;
+    private starkSigner;
     private signerInitialisationError;
-    constructor({ authManager, immutableXClient, passportEventEmitter, magicAdapter, imxApiClients, guardianClient, }: PassportImxProviderOptions);
+    constructor({ authManager, immutableXClient, passportEventEmitter, magicTEESigner, imxApiClients, guardianClient, }: PassportImxProviderOptions);
     private handleLogout;
     transfer(request: UnsignedTransferRequest): Promise<imx.CreateTransferResponseV1>;
     registerOffchain(): Promise<imx.RegisterUserResponse>;

package/dist/types/starkEx/passportImxProviderFactory.d.ts

@@ -2,14 +2,14 @@ import { IMXClient } from '@imtbl/x-client';
 import { IMXProvider } from '@imtbl/x-provider';
 import { ImxApiClients } from '@imtbl/generated-clients';
 import AuthManager from '../authManager';
-import MagicAdapter from '../magic/magicAdapter';
 import { PassportEventMap } from '../types';
-import TypedEventEmitter from '../utils/typedEventEmitter';
 import GuardianClient from '../guardian';
+import MagicTEESigner from '../magic/magicTEESigner';
+import TypedEventEmitter from '../utils/typedEventEmitter';
 export type PassportImxProviderFactoryInput = {
     authManager: AuthManager;
     immutableXClient: IMXClient;
-    magicAdapter: MagicAdapter;
+    magicTEESigner: MagicTEESigner;
     passportEventEmitter: TypedEventEmitter<PassportEventMap>;
     imxApiClients: ImxApiClients;
     guardianClient: GuardianClient;
@@ -17,11 +17,11 @@ export type PassportImxProviderFactoryInput = {
 export declare class PassportImxProviderFactory {
     private readonly authManager;
     private readonly immutableXClient;
-    private readonly magicAdapter;
+    private readonly magicTEESigner;
     private readonly passportEventEmitter;
     readonly imxApiClients: ImxApiClients;
     private readonly guardianClient;
-    constructor({ authManager, immutableXClient, magicAdapter, passportEventEmitter, imxApiClients, guardianClient, }: PassportImxProviderFactoryInput);
+    constructor({ authManager, immutableXClient, magicTEESigner, passportEventEmitter, imxApiClients, guardianClient, }: PassportImxProviderFactoryInput);
     getProvider(): Promise<IMXProvider>;
     getProviderSilent(): Promise<IMXProvider | null>;
     private createProviderInstance;

package/dist/types/types.d.ts

@@ -1,5 +1,5 @@
 import { Environment, ModuleConfiguration } from '@imtbl/config';
-import { EthSigner, IMXClient, StarkSigner } from '@imtbl/x-client';
+import { IMXClient } from '@imtbl/x-client';
 import { ImxApiClients } from '@imtbl/generated-clients';
 import { Flow } from '@imtbl/metrics';
 /**
@@ -30,18 +30,22 @@ export type UserProfile = {
     nickname?: string;
     sub: string;
 };
+export declare enum RollupType {
+    IMX = "imx",
+    ZKEVM = "zkEvm"
+}
 export type User = {
     idToken?: string;
     accessToken: string;
     refreshToken?: string;
     profile: UserProfile;
     expired?: boolean;
-    imx?: {
+    [RollupType.IMX]?: {
         ethAddress: string;
         starkAddress: string;
         userAdminAddress: string;
     };
-    zkEvm?: {
+    [RollupType.ZKEVM]?: {
         ethAddress: string;
         userAdminAddress: string;
     };
@@ -107,8 +111,8 @@ export interface PassportModuleConfiguration extends ModuleConfiguration<Passpor
 type WithRequired<T, K extends keyof T> = T & {
     [P in K]-?: T[P];
 };
-export type UserImx = WithRequired<User, 'imx'>;
-export type UserZkEvm = WithRequired<User, 'zkEvm'>;
+export type UserImx = WithRequired<User, RollupType.IMX>;
+export type UserZkEvm = WithRequired<User, RollupType.ZKEVM>;
 export declare const isUserZkEvm: (user: User) => user is UserZkEvm;
 export declare const isUserImx: (user: User) => user is UserImx;
 export type DeviceTokenResponse = {
@@ -135,10 +139,6 @@ export type PKCEData = {
     state: string;
     verifier: string;
 };
-export type IMXSigners = {
-    starkSigner: StarkSigner;
-    ethSigner: EthSigner;
-};
 export type LinkWalletParams = {
     type: string;
     walletAddress: string;

package/dist/types/zkEvm/zkEvmProvider.d.ts

@@ -1,23 +1,24 @@
 import { MultiRollupApiClients } from '@imtbl/generated-clients';
+import { Signer } from 'ethers';
 import { Provider, RequestArguments } from './types';
 import AuthManager from '../authManager';
-import MagicAdapter from '../magic/magicAdapter';
 import TypedEventEmitter from '../utils/typedEventEmitter';
 import { PassportConfiguration } from '../config';
-import { PassportEventMap } from '../types';
+import { PassportEventMap, User } from '../types';
 import GuardianClient from '../guardian';
 export type ZkEvmProviderInput = {
     authManager: AuthManager;
-    magicAdapter: MagicAdapter;
     config: PassportConfiguration;
     multiRollupApiClients: MultiRollupApiClients;
     passportEventEmitter: TypedEventEmitter<PassportEventMap>;
     guardianClient: GuardianClient;
+    ethSigner: Signer;
+    user: User | null;
 };
 export declare class ZkEvmProvider implements Provider {
     #private;
     readonly isPassport: boolean;
-    constructor({ authManager, magicAdapter, config, multiRollupApiClients, passportEventEmitter, guardianClient, }: ZkEvmProviderInput);
+    constructor({ authManager, config, multiRollupApiClients, passportEventEmitter, guardianClient, ethSigner, user, }: ZkEvmProviderInput);
     request(request: RequestArguments): Promise<any>;
     on(event: string, listener: (...args: any[]) => void): void;
     removeListener(event: string, listener: (...args: any[]) => void): void;

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@imtbl/passport",
   "description": "Passport module for Immutable SDK",
-  "version": "2.8.1-alpha.0",
+  "version": "2.9.0-alpha.0",
   "author": "Immutable",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
   "dependencies": {
     "@0xsequence/abi": "^2.0.25",
     "@0xsequence/core": "^2.0.25",
-    "@imtbl/config": "2.8.1-alpha.0",
-    "@imtbl/generated-clients": "2.8.1-alpha.0",
-    "@imtbl/metrics": "2.8.1-alpha.0",
-    "@imtbl/toolkit": "2.8.1-alpha.0",
-    "@imtbl/x-client": "2.8.1-alpha.0",
-    "@imtbl/x-provider": "2.8.1-alpha.0",
+    "@imtbl/config": "2.9.0-alpha.0",
+    "@imtbl/generated-clients": "2.9.0-alpha.0",
+    "@imtbl/metrics": "2.9.0-alpha.0",
+    "@imtbl/toolkit": "2.9.0-alpha.0",
+    "@imtbl/x-client": "2.9.0-alpha.0",
+    "@imtbl/x-provider": "2.9.0-alpha.0",
     "@magic-ext/oidc": "12.0.5",
     "@magic-sdk/provider": "^29.0.5",
     "@metamask/detect-provider": "^2.0.0",

package/dist/types/magic/magicAdapter.d.ts

@@ -1,12 +0,0 @@
-import { Eip1193Provider } from 'ethers';
-import { PassportConfiguration } from '../config';
-import { MagicProviderProxyFactory } from './magicProviderProxyFactory';
-export default class MagicAdapter {
-    private readonly config;
-    private readonly magicProviderProxyFactory;
-    private readonly magicClient?;
-    constructor(config: PassportConfiguration, magicProviderProxyFactory: MagicProviderProxyFactory);
-    private getMagicClient;
-    login(idToken: string): Promise<Eip1193Provider>;
-    logout(): Promise<void>;
-}

package/dist/types/magic/magicProviderProxyFactory.d.ts

@@ -1,15 +0,0 @@
-import { Eip1193Provider } from 'ethers';
-import AuthManager from '../authManager';
-import { PassportConfiguration } from '../config';
-import { MagicClient } from './types';
-/**
- * Factory class for creating a Magic provider that automatically handles re-authentication.
- * This proxy wraps the Magic RPC provider to intercept certain RPC methods (`personal_sign`, `eth_accounts`)
- * and ensures the user is properly authenticated before executing them.
- */
-export declare class MagicProviderProxyFactory {
-    private authManager;
-    private config;
-    constructor(authManager: AuthManager, config: PassportConfiguration);
-    createProxy(magicClient: MagicClient): Eip1193Provider;
-}

package/dist/types/magic/magicProviderProxyFactory.test.d.ts

@@ -1 +0,0 @@
-export {};