@imtbl/sdk 0.28.4 → 0.28.5-alpha.2

package/dist/passport.d.ts

@@ -9732,6 +9732,12 @@ interface IMXProvider {
      * @return {Promise<RegisterUserResponse>} Returns a promise that resolves with the user registration response
      */
     registerOffchain(): Promise<RegisterUserResponse>;
+    /**
+     *  Checks if a User is registered off-chain
+     *
+     *  @return {Promise<boolean>} Returns a promise that resolves with true if the User is registered with IMX, false otherwise
+     */
+    isRegisteredOffchain(): Promise<boolean>;
     /**
      * Checks if a User is registered on-chain
      *
@@ -10184,7 +10190,7 @@ type UserProfile = {
 };
 declare enum Networks {
     PRODUCTION = "mainnet",
-    SANDBOX = "goerli"
+    SANDBOX = "sepolia"
 }
 interface OidcConfiguration {
     clientId: string;

package/dist/passport.js

@@ -2072,7 +2072,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.28.4' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.28.5-alpha.2' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -2128,7 +2128,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.28.4',
+    sdkVersion: 'ts-immutable-sdk-0.28.5-alpha.2',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -7056,39 +7056,63 @@ class AuthManager {
     }
 }
 
+const lazyLoad = (promiseToAwait, initialiseFunction) => (promiseToAwait().then(initialiseFunction));
+const lazyDocumentReady = (initialiseFunction) => {
+    const documentReadyPromise = () => new Promise((resolve) => {
+        if (window.document.readyState === 'complete') {
+            resolve();
+        }
+        else {
+            const onReadyStateChange = () => {
+                if (window.document.readyState === 'complete') {
+                    resolve();
+                    window.document.removeEventListener('readystatechange', onReadyStateChange);
+                }
+            };
+            window.document.addEventListener('readystatechange', onReadyStateChange);
+        }
+    });
+    return lazyLoad(documentReadyPromise, initialiseFunction);
+};
+
 class MagicAdapter {
     config;
-    magicClient;
+    lazyMagicClient;
     constructor(config) {
         this.config = config;
         if (typeof window !== 'undefined') {
-            this.magicClient = this.initMagicClient();
-            this.magicClient.preload();
+            this.lazyMagicClient = lazyDocumentReady(() => {
+                const client = new Magic(this.config.magicPublishableApiKey, {
+                    extensions: [new OpenIdExtension()],
+                    network: this.config.network,
+                });
+                client.preload();
+                return client;
+            });
+        }
+    }
+    get magicClient() {
+        if (!this.lazyMagicClient) {
+            throw new Error('Cannot perform this action outside of the browser');
         }
+        return this.lazyMagicClient;
     }
     async login(idToken) {
         return withPassportError(async () => {
-            if (!this.magicClient) {
-                this.magicClient = this.initMagicClient();
-            }
-            await this.magicClient.openid.loginWithOIDC({
+            const magicClient = await this.magicClient;
+            await magicClient.openid.loginWithOIDC({
                 jwt: idToken,
                 providerId: this.config.magicProviderId,
             });
-            return this.magicClient.rpcProvider;
+            return magicClient.rpcProvider;
         }, PassportErrorType.WALLET_CONNECTION_ERROR);
     }
     async logout() {
-        if (this.magicClient?.user) {
-            await this.magicClient.user.logout();
+        const magicClient = await this.magicClient;
+        if (magicClient.user) {
+            await magicClient.user.logout();
         }
     }
-    initMagicClient() {
-        return new Magic(this.config.magicPublishableApiKey, {
-            extensions: [new OpenIdExtension()],
-            network: this.config.network,
-        });
-    }
 }
 
 const getStarkSigner = async (signer) => withPassportError(async () => {
@@ -7315,7 +7339,7 @@ var PassportEvents;
 var Networks;
 (function (Networks) {
     Networks["PRODUCTION"] = "mainnet";
-    Networks["SANDBOX"] = "goerli";
+    Networks["SANDBOX"] = "sepolia";
 })(Networks || (Networks = {}));
 
 async function exchangeTransfer({ user, starkSigner, request, exchangesApi, }) {
@@ -7664,6 +7688,11 @@ class PassportImxProvider {
     }
     // TODO: Remove once implemented
     // eslint-disable-next-line class-methods-use-this
+    isRegisteredOffchain() {
+        throw new PassportError('Operation not supported', PassportErrorType.OPERATION_NOT_SUPPORTED_ERROR);
+    }
+    // TODO: Remove once implemented
+    // eslint-disable-next-line class-methods-use-this
     isRegisteredOnchain() {
         throw new PassportError('Operation not supported', PassportErrorType.OPERATION_NOT_SUPPORTED_ERROR);
     }
@@ -7757,7 +7786,17 @@ class PassportImxProviderFactory {
         this.passportEventEmitter = passportEventEmitter;
     }
     async getProvider() {
-        const user = await this.authManager.loginSilent() || await this.authManager.login();
+        let user = null;
+        try {
+            user = await this.authManager.loginSilent();
+        }
+        catch (e) {
+            // eslint-disable-next-line no-console
+            console.warn(e);
+        }
+        if (!user) {
+            user = await this.authManager.login();
+        }
         return this.createProviderInstance(user);
     }
     async getProviderSilent() {
@@ -8812,7 +8851,14 @@ class Passport {
      */
     async login(options) {
         const { useCachedSession = false } = options || {};
-        let user = await this.authManager.loginSilent();
+        let user = null;
+        try {
+            user = await this.authManager.loginSilent();
+        }
+        catch (error) {
+            // eslint-disable-next-line no-console
+            console.warn('loginSilent failed with error:', error);
+        }
         if (!user && !useCachedSession) {
             user = await this.authManager.login();
         }

package/dist/provider.d.ts

@@ -1,5 +1,3 @@
-import { ProviderConfiguration as ProviderConfiguration$1 } from 'config';
-
 declare type Bytes = ArrayLike<number>;
 declare type BytesLike = Bytes | string;
 interface Hexable {
@@ -833,6 +831,12 @@ interface IMXProvider {
      * @return {Promise<RegisterUserResponse>} Returns a promise that resolves with the user registration response
      */
     registerOffchain(): Promise<RegisterUserResponse>;
+    /**
+     *  Checks if a User is registered off-chain
+     *
+     *  @return {Promise<boolean>} Returns a promise that resolves with true if the User is registered with IMX, false otherwise
+     */
+    isRegisteredOffchain(): Promise<boolean>;
     /**
      * Checks if a User is registered on-chain
      *
@@ -905,31 +909,6 @@ interface IMXProvider {
     completeWithdrawal(starkPublicKey: string, token: AnyToken): Promise<TransactionResponse>;
 }
 
-declare class GenericIMXProvider implements IMXProvider {
-    private readonly config;
-    private readonly signers;
-    constructor(config: ProviderConfiguration$1, ethSigner: Signer, starkSigner: StarkSigner);
-    getAddress(): Promise<string>;
-    registerOffchain(): Promise<RegisterUserResponse>;
-    batchNftTransfer(request: Array<NftTransferDetails>): Promise<CreateTransferResponse>;
-    cancelOrder(request: GetSignableCancelOrderRequest): Promise<CancelOrderResponse>;
-    completeWithdrawal(starkPublicKey: string, token: AnyToken): Promise<TransactionResponse>;
-    createOrder(request: UnsignedOrderRequest): Promise<CreateOrderResponse>;
-    createTrade(request: GetSignableTradeRequest): Promise<CreateTradeResponse>;
-    deposit(tokenAmount: TokenAmount): Promise<TransactionResponse>;
-    exchangeTransfer(request: UnsignedExchangeTransferRequest): Promise<CreateTransferResponseV1>;
-    isRegisteredOnchain(): Promise<boolean>;
-    prepareWithdrawal(request: TokenAmount): Promise<CreateWithdrawalResponse>;
-    transfer(request: UnsignedTransferRequest): Promise<CreateTransferResponseV1>;
-}
-
-declare class MetaMaskIMXProvider extends GenericIMXProvider {
-    private static imxSigner;
-    static connect(config: ProviderConfiguration$1): Promise<MetaMaskIMXProvider>;
-    static disconnect(): Promise<void>;
-    static signMessage(message: string): Promise<string>;
-}
-
 declare enum Environment {
     PRODUCTION = "production",
     SANDBOX = "sandbox"
@@ -962,4 +941,30 @@ declare class ProviderConfiguration {
     constructor({ baseConfig, overrides }: ProviderModuleConfiguration);
 }
 
+declare class GenericIMXProvider implements IMXProvider {
+    private readonly config;
+    private readonly signers;
+    constructor(config: ProviderConfiguration, ethSigner: Signer, starkSigner: StarkSigner);
+    getAddress(): Promise<string>;
+    isRegisteredOffchain(): Promise<boolean>;
+    registerOffchain(): Promise<RegisterUserResponse>;
+    batchNftTransfer(request: Array<NftTransferDetails>): Promise<CreateTransferResponse>;
+    cancelOrder(request: GetSignableCancelOrderRequest): Promise<CancelOrderResponse>;
+    completeWithdrawal(starkPublicKey: string, token: AnyToken): Promise<TransactionResponse>;
+    createOrder(request: UnsignedOrderRequest): Promise<CreateOrderResponse>;
+    createTrade(request: GetSignableTradeRequest): Promise<CreateTradeResponse>;
+    deposit(tokenAmount: TokenAmount): Promise<TransactionResponse>;
+    exchangeTransfer(request: UnsignedExchangeTransferRequest): Promise<CreateTransferResponseV1>;
+    isRegisteredOnchain(): Promise<boolean>;
+    prepareWithdrawal(request: TokenAmount): Promise<CreateWithdrawalResponse>;
+    transfer(request: UnsignedTransferRequest): Promise<CreateTransferResponseV1>;
+}
+
+declare class MetaMaskIMXProvider extends GenericIMXProvider {
+    private static imxSigner;
+    static connect(config: ProviderConfiguration): Promise<MetaMaskIMXProvider>;
+    static disconnect(): Promise<void>;
+    static signMessage(message: string): Promise<string>;
+}
+
 export { GenericIMXProvider, IMXProvider, MetaMaskIMXProvider, ProviderConfiguration };

package/dist/provider.js

@@ -1,11 +1,11 @@
 import { Config, TransfersApi, OrdersApi, UsersApi, Contracts, TradesApi, ExchangesApi, WithdrawalsApi, MintsApi, DepositsApi, EncodingApi, TokensApi } from '@imtbl/core-sdk';
 import BN from 'bn.js';
 import * as encUtils from 'enc-utils';
+import { AxiosError } from 'axios';
 import { parseUnits } from '@ethersproject/units';
 import { BigNumber } from '@ethersproject/bignumber';
 import { ethers } from 'ethers';
 import detectEthereumProvider from '@metamask/detect-provider';
-import 'axios';
 
 // used to sign message with L1 keys. Used for registration
 function serializeEthSignature(sig) {
@@ -285,6 +285,22 @@ async function registerOffchain(signers, config) {
     });
     return registeredUser.data;
 }
+async function isRegisteredOffchain(ethAddress, config) {
+    try {
+        const usersApi = new UsersApi(config.immutableXConfig.apiConfiguration);
+        const getUsersResult = await usersApi.getUsers({
+            user: ethAddress,
+        });
+        const { accounts } = getUsersResult.data;
+        return accounts?.length > 0;
+    }
+    catch (ex) {
+        if (ex instanceof AxiosError && ex.response?.status === 404) {
+            return false;
+        }
+        throw ex;
+    }
+}
 async function isRegisteredOnChain(starkPublicKey, ethSigner, config) {
     await validateChain(ethSigner, config.immutableXConfig);
     const registrationContract = Contracts.Registration.connect(config.immutableXConfig.ethConfiguration.registrationContractAddress, ethSigner);
@@ -820,7 +836,11 @@ class GenericIMXProvider {
         this.signers = { ethSigner, starkSigner };
     }
     async getAddress() {
-        return await this.signers.ethSigner.getAddress();
+        return this.signers.ethSigner.getAddress();
+    }
+    async isRegisteredOffchain() {
+        const ethAddress = await this.getAddress();
+        return isRegisteredOffchain(ethAddress, this.config);
     }
     registerOffchain() {
         return registerOffchain(this.signers, this.config);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "0.28.4",
+  "version": "0.28.5-alpha.2",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
@@ -14,7 +14,7 @@
     "@ethersproject/wallet": "^5.7.0",
     "@imtbl/core-sdk": "^2.4.0",
     "@jest/globals": "^29.5.0",
-    "@magic-ext/oidc": "^1.0.1",
+    "@magic-ext/oidc": "^4.2.0",
     "@metamask/detect-provider": "^2.0.0",
     "@opensea/seaport-js": "2.0.7",
     "@uniswap/router-sdk": "^1.4.0",
@@ -25,7 +25,7 @@
     "enc-utils": "^3.0.0",
     "ethers": "^5.7.2",
     "jwt-decode": "^3.1.2",
-    "magic-sdk": "^13.3.1",
+    "magic-sdk": "^21.2.0",
     "oidc-client-ts": "^2.2.1"
   },
   "devDependencies": {
@@ -90,14 +90,6 @@
     "./provider": {
       "types": "./dist/provider.d.ts",
       "import": "./dist/provider.js"
-    },
-    "./checkout_sdk": {
-      "types": "./dist/checkout_sdk.d.ts",
-      "import": "./dist/checkout_sdk.js"
-    },
-    "./checkout_widgets": {
-      "types": "./dist/checkout_widgets.d.ts",
-      "import": "./dist/checkout_widgets.js"
     }
   },
   "files": [