@imtbl/sdk 1.12.2 → 1.13.0

package/dist/passport.js

@@ -2,7 +2,7 @@ import globalAxios$1, { isAxiosError as isAxiosError$1 } from 'axios';
 import { ImmutableX, Config, generateLegacyStarkPrivateKey, createStarkSigner } from '@imtbl/core-sdk';
 import { memorise } from 'lru-memorise';
 import { getGlobalisedValue as getGlobalisedValue$1 } from 'global-const';
-import { UserManager, User, InMemoryWebStorage, WebStorageStateStore } from 'oidc-client-ts';
+import { UserManager, User, ErrorTimeout, ErrorResponse, InMemoryWebStorage, WebStorageStateStore } from 'oidc-client-ts';
 import jwt_decode from 'jwt-decode';
 import * as crypto from 'crypto';
 import { Magic } from 'magic-sdk';
@@ -9346,7 +9346,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.12.2' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.13.0' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -9525,7 +9525,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.12.2';
+const SDK_VERSION = '1.13.0';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -9744,7 +9744,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.12.2',
+    sdkVersion: 'ts-immutable-sdk-1.13.0',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -14357,6 +14357,13 @@ function isTokenExpired(oidcUser) {
     return isIdTokenExpired(idToken);
 }
 
+var PassportEvents;
+(function (PassportEvents) {
+    PassportEvents["LOGGED_OUT"] = "loggedOut";
+})(PassportEvents || (PassportEvents = {}));
+const isUserZkEvm = (user) => !!user.zkEvm;
+const isUserImx = (user) => !!user.imx;
+
 const formUrlEncodedHeader = {
     headers: {
         'Content-Type': 'application/x-www-form-urlencoded',
@@ -14408,8 +14415,8 @@ function sha256(buffer) {
 }
 class AuthManager {
     userManager;
-    config;
     deviceCredentialsManager;
+    config;
     logoutMode;
     /**
      * Promise that is used to prevent multiple concurrent calls to the refresh token endpoint.
@@ -14639,6 +14646,12 @@ class AuthManager {
     async logoutSilentCallback(url) {
         return this.userManager.signoutSilentCallback(url);
     }
+    forceUserRefreshInBackground() {
+        this.refreshTokenAndUpdatePromise().catch((error) => {
+            // eslint-disable-next-line no-console
+            console.warn('Failed to refresh user token', error);
+        });
+    }
     async forceUserRefresh() {
         return this.refreshTokenAndUpdatePromise();
     }
@@ -14660,7 +14673,19 @@ class AuthManager {
                 resolve(null);
             }
             catch (err) {
-                reject(err);
+                let passportErrorType = PassportErrorType.AUTHENTICATION_ERROR;
+                let errorMessage = 'Failed to refresh token';
+                if (err instanceof ErrorTimeout) {
+                    passportErrorType = PassportErrorType.SILENT_LOGIN_ERROR;
+                }
+                else if (err instanceof ErrorResponse) {
+                    passportErrorType = PassportErrorType.NOT_LOGGED_IN_ERROR;
+                    errorMessage = `${err.message}: ${err.error_description}`;
+                }
+                else if (err instanceof Error) {
+                    errorMessage = err.message;
+                }
+                reject(new PassportError(errorMessage, passportErrorType));
             }
             finally {
                 this.refreshingPromise = null; // Reset the promise after completion
@@ -14669,22 +14694,56 @@ class AuthManager {
         return this.refreshingPromise;
     }
     /**
-     * Get the user from the cache or refresh the token if it's expired.
-     * return null if there's no refresh token.
+     *
+     * @param typeAssertion {(user: User) => boolean} - Optional. If provided, then the User will be checked against
+     * the typeAssertion. If the user meets the requirements, then it will be typed as T and returned. If the User
+     * does NOT meet the type assertion, then execution will continue, and we will attempt to obtain a User that does
+     * meet the type assertion.
+     *
+     * This function will attempt to obtain a User in the following order:
+     * 1. If the User is currently refreshing, wait for the refresh to complete.
+     * 2. Attempt to obtain a User from storage that has not expired.
+     * 3. Attempt to refresh the User if a refresh token is present.
+     * 4. Return null if no valid User can be obtained.
      */
-    async getUser() {
-        return withPassportError(async () => {
-            const oidcUser = await this.userManager.getUser();
-            if (!oidcUser)
-                return null;
-            if (!isTokenExpired(oidcUser)) {
-                return AuthManager.mapOidcUserToDomainModel(oidcUser);
-            }
-            if (oidcUser.refresh_token) {
-                return this.refreshTokenAndUpdatePromise();
+    async getUser(typeAssertion = (user) => true) {
+        if (this.refreshingPromise) {
+            const user = await this.refreshingPromise;
+            if (user && typeAssertion(user)) {
+                return user;
             }
             return null;
-        }, PassportErrorType.NOT_LOGGED_IN_ERROR);
+        }
+        const oidcUser = await this.userManager.getUser();
+        if (!oidcUser)
+            return null;
+        if (!isTokenExpired(oidcUser)) {
+            const user = AuthManager.mapOidcUserToDomainModel(oidcUser);
+            if (user && typeAssertion(user)) {
+                return user;
+            }
+        }
+        if (oidcUser.refresh_token) {
+            const user = await this.refreshTokenAndUpdatePromise();
+            if (user && typeAssertion(user)) {
+                return user;
+            }
+        }
+        return null;
+    }
+    async getUserZkEvm() {
+        const user = await this.getUser(isUserZkEvm);
+        if (!user) {
+            throw new Error('Failed to obtain a User with the required ZkEvm attributes');
+        }
+        return user;
+    }
+    async getUserImx() {
+        const user = await this.getUser(isUserImx);
+        if (!user) {
+            throw new Error('Failed to obtain a User with the required IMX attributes');
+        }
+        return user;
     }
 }
 
@@ -14753,11 +14812,6 @@ const getStarkSigner = async (signer) => withPassportError(async () => {
     return createStarkSigner(privateKey);
 }, PassportErrorType.WALLET_CONNECTION_ERROR);
 
-var PassportEvents;
-(function (PassportEvents) {
-    PassportEvents["LOGGED_OUT"] = "loggedOut";
-})(PassportEvents || (PassportEvents = {}));
-
 async function exchangeTransfer({ user, starkSigner, request, exchangesApi, }) {
     return withPassportError(async () => {
         const { ethAddress } = user.imx;
@@ -15144,7 +15198,7 @@ class PassportImxProvider {
      * @see getAuthenticatedUserAndSigners
      *
      */
-    async initialiseSigners() {
+    initialiseSigners() {
         const generateSigners = async () => {
             const user = await this.authManager.getUser();
             // The user will be present because the factory validates it
@@ -15183,7 +15237,6 @@ class PassportImxProvider {
     }
     async getRegisteredImxUserAndSigners() {
         const { user, starkSigner, ethSigner } = await this.getAuthenticatedUserAndSigners();
-        const isUserImx = (oidcUser) => oidcUser?.imx !== undefined;
         if (!isUserImx(user)) {
             throw new PassportError('User has not been registered with StarkEx', PassportErrorType.USER_NOT_REGISTERED_ERROR);
         }
@@ -15753,11 +15806,11 @@ class RelayerClient {
             jsonrpc: '2.0',
             ...request,
         };
-        const user = await this.authManager.getUser();
+        const user = await this.authManager.getUserZkEvm();
         const response = await fetch(`${this.config.relayerUrl}/v1/transactions`, {
             method: 'POST',
             headers: {
-                Authorization: `Bearer ${user?.accessToken}`,
+                Authorization: `Bearer ${user.accessToken}`,
                 'Content-Type': 'application/json',
             },
             body: JSON.stringify(body),
@@ -15863,7 +15916,7 @@ async function registerZkEvmUser({ authManager, ethSigner, multiRollupApiClients
         throw new JsonRpcError(RpcErrorCode.INTERNAL_ERROR, `Chain name does not exist on for chain id ${network.chainId}`);
     }
     try {
-        await multiRollupApiClients.passportApi.createCounterfactualAddressV2({
+        const registrationResponse = await multiRollupApiClients.passportApi.createCounterfactualAddressV2({
             chainName,
             createCounterfactualAddressRequest: {
                 ethereum_address: ethereumAddress,
@@ -15872,15 +15925,12 @@ async function registerZkEvmUser({ authManager, ethSigner, multiRollupApiClients
         }, {
             headers: { Authorization: `Bearer ${accessToken}` },
         });
+        authManager.forceUserRefreshInBackground();
+        return registrationResponse.data.counterfactual_address;
     }
     catch (error) {
         throw new JsonRpcError(RpcErrorCode.INTERNAL_ERROR, `Failed to create counterfactual address: ${error}`);
     }
-    const user = await authManager.forceUserRefresh();
-    if (!user?.zkEvm) {
-        throw new JsonRpcError(RpcErrorCode.INTERNAL_ERROR, 'Failed to refresh user details');
-    }
-    return user;
 }
 
 const transactionRejectedCrossSdkBridgeError = 'Transaction requires confirmation but this functionality is not'
@@ -15942,7 +15992,7 @@ class GuardianClient {
         const finallyFn = () => {
             this.confirmationScreen.closeWindow();
         };
-        const user = await this.authManager.getUser();
+        const user = await this.authManager.getUserImx();
         const headers = { Authorization: `Bearer ${user.accessToken}` };
         const transactionRes = await retryWithDelay(async () => this.transactionAPI.getTransactionByID({
             transactionID: payloadHash,
@@ -15972,7 +16022,7 @@ class GuardianClient {
         }
     }
     async evaluateEVMTransaction({ chainId, nonce, metaTransactions, }) {
-        const user = await this.authManager.getUser();
+        const user = await this.authManager.getUserZkEvm();
         const headers = { Authorization: `Bearer ${user.accessToken}` };
         const guardianTransactions = transformGuardianTransactions(metaTransactions);
         try {
@@ -16006,7 +16056,7 @@ class GuardianClient {
             throw new JsonRpcError(RpcErrorCode.TRANSACTION_REJECTED, transactionRejectedCrossSdkBridgeError);
         }
         if (confirmationRequired && !!transactionId) {
-            const user = await this.authManager.getUser();
+            const user = await this.authManager.getUserZkEvm();
             const confirmationResult = await this.confirmationScreen.requestConfirmation(transactionId, user.zkEvm.ethAddress, TransactionApprovalRequestChainTypeEnum.Evm, chainId);
             if (!confirmationResult.confirmed) {
                 throw new JsonRpcError(RpcErrorCode.TRANSACTION_REJECTED, 'Transaction rejected by user');
@@ -16018,7 +16068,7 @@ class GuardianClient {
     }
     async evaluateMessage({ chainID, payload }) {
         try {
-            const user = await this.authManager.getUser();
+            const user = await this.authManager.getUserZkEvm();
             if (user === null) {
                 throw new PassportError('evaluateMessage requires a valid ID token or refresh token. Please log in first', PassportErrorType.NOT_LOGGED_IN_ERROR);
             }
@@ -16036,7 +16086,7 @@ class GuardianClient {
             throw new JsonRpcError(RpcErrorCode.TRANSACTION_REJECTED, transactionRejectedCrossSdkBridgeError);
         }
         if (confirmationRequired && !!messageId) {
-            const user = await this.authManager.getUser();
+            const user = await this.authManager.getUserZkEvm();
             const confirmationResult = await this.confirmationScreen.requestMessageConfirmation(messageId, user.zkEvm.ethAddress);
             if (!confirmationResult.confirmed) {
                 throw new JsonRpcError(RpcErrorCode.TRANSACTION_REJECTED, 'Signature rejected by user');
@@ -16253,7 +16303,7 @@ class ZkEvmProvider {
      * @see #getSigner
      *
      */
-    async #initialiseEthSigner(user) {
+    #initialiseEthSigner(user) {
         const generateSigner = async () => {
             const magicRpcProvider = await this.#magicAdapter.login(user.idToken);
             const web3Provider = new Web3Provider(magicRpcProvider);
@@ -16292,14 +16342,13 @@ class ZkEvmProvider {
                 this.#initialiseEthSigner(user);
                 if (!isZkEvmUser(user)) {
                     const ethSigner = await this.#getSigner();
-                    const userZkEvm = await registerZkEvmUser({
+                    this.#zkEvmAddress = await registerZkEvmUser({
                         ethSigner,
                         authManager: this.#authManager,
                         multiRollupApiClients: this.#multiRollupApiClients,
                         accessToken: user.accessToken,
                         jsonRpcProvider: this.#jsonRpcProvider,
                     });
-                    this.#zkEvmAddress = userZkEvm.zkEvm.ethAddress;
                 }
                 else {
                     this.#zkEvmAddress = user.zkEvm.ethAddress;

package/dist/x.js

@@ -136,7 +136,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.12.2';
+const SDK_VERSION = '1.13.0';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -334,7 +334,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.12.2',
+    sdkVersion: 'ts-immutable-sdk-1.13.0',
 });
 /**
  * Sets `sdkVersion` at the time of build

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "1.12.2",
+  "version": "1.13.0",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",