@imtbl/sdk 1.13.0 → 1.13.2-alpha.1

package/dist/index.cjs

@@ -174,7 +174,7 @@ const flattenProperties$1 = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION$1 = '1.13.0';
+const SDK_VERSION$1 = '1.13.2-alpha.1';
 const getReferrer$1 = () => {
     if (isNode$1()) {
         return '';
@@ -410,6 +410,7 @@ const addKeysToHeadersOverride = (baseConfig, overrides) => {
     }
     if (baseConfig.publishableKey) {
         newHeaders[KeyHeaders$1.PUBLISHABLE_KEY] = baseConfig.publishableKey;
+        setPublishableApiKey(baseConfig.publishableKey);
     }
     if (baseConfig.rateLimitingKey) {
         newHeaders[KeyHeaders$1.RATE_LIMITING_KEY] = baseConfig.rateLimitingKey;
@@ -429,35 +430,13 @@ const addKeysToHeadersOverride = (baseConfig, overrides) => {
         headers: newHeaders,
     };
 };
-const API_KEY_PREFIX = 'sk_imapik-';
-const PUBLISHABLE_KEY_PREFIX$1 = 'pk_imapik-';
-const addApiKeyToAxiosHeader = (apiKey) => {
-    if (!apiKey.startsWith(API_KEY_PREFIX)) {
-        throw new Error('Invalid API key. Create your api key in Immutable developer hub. https://hub.immutable.com');
-    }
-    globalAxios$1.defaults.headers.common[KeyHeaders$1.API_KEY] = apiKey;
-};
-const addPublishableKeyToAxiosHeader = (publishableKey) => {
-    if (!publishableKey.startsWith(PUBLISHABLE_KEY_PREFIX$1)) {
-        throw new Error('Invalid Publishable key. Create your Publishable key in Immutable developer hub.'
-            + ' https://hub.immutable.com');
-    }
-    setPublishableApiKey(publishableKey);
-    globalAxios$1.defaults.headers.common[KeyHeaders$1.PUBLISHABLE_KEY] = publishableKey;
-};
-const addRateLimitingKeyToAxiosHeader = (rateLimitingKey) => {
-    globalAxios$1.defaults.headers.common[KeyHeaders$1.RATE_LIMITING_KEY] = rateLimitingKey;
-};
 
 var config = /*#__PURE__*/Object.freeze({
     __proto__: null,
     get Environment () { return Environment$1; },
     ImmutableConfiguration: ImmutableConfiguration,
     get KeyHeaders () { return KeyHeaders$1; },
-    addApiKeyToAxiosHeader: addApiKeyToAxiosHeader,
-    addKeysToHeadersOverride: addKeysToHeadersOverride,
-    addPublishableKeyToAxiosHeader: addPublishableKeyToAxiosHeader,
-    addRateLimitingKeyToAxiosHeader: addRateLimitingKeyToAxiosHeader
+    addKeysToHeadersOverride: addKeysToHeadersOverride
 });
 
 /* tslint:disable */
@@ -11571,7 +11550,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.13.0' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.13.2-alpha.1' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -11643,7 +11622,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.13.0',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.13.2-alpha.1',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -12126,7 +12105,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.13.0',
+    sdkVersion: 'ts-immutable-sdk-1.13.2-alpha.1',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -16732,6 +16711,17 @@ class DeviceCredentialsManager {
     }
 }
 
+const shouldLog = process?.env?.JEST_WORKER_ID === undefined;
+const warn = (...args) => {
+    if (shouldLog) {
+        // eslint-disable-next-line no-console
+        console.warn(...args);
+    }
+};
+var logger$f = {
+    warn,
+};
+
 function isIdTokenExpired(idToken) {
     if (!idToken) {
         return false;
@@ -16894,8 +16884,7 @@ class AuthManager {
             user = await this.getUser();
         }
         catch (err) {
-            // eslint-disable-next-line no-console
-            console.warn('failed to retrieve a cached user session:', err);
+            logger$f.warn('Failed to retrieve a cached user session', err);
         }
         return user || this.login();
     }
@@ -17039,8 +17028,7 @@ class AuthManager {
     }
     forceUserRefreshInBackground() {
         this.refreshTokenAndUpdatePromise().catch((error) => {
-            // eslint-disable-next-line no-console
-            console.warn('Failed to refresh user token', error);
+            logger$f.warn('Failed to refresh user token', error);
         });
     }
     async forceUserRefresh() {
@@ -17541,7 +17529,7 @@ async function registerOffchain$1(userAdminKeySigner, starkSigner, unregisteredU
             return response;
         }
         catch (err) {
-            if (globalAxios$1.isAxiosError(err) && err.status === 409) {
+            if (globalAxios$1.isAxiosError(err) && err.response?.status === 409) {
                 // The user already registered, but the user token is not updated yet.
                 await forceUserRefresh(authManager);
                 return { tx_hash: '' };
@@ -17560,8 +17548,8 @@ class PassportImxProvider {
     /**
      * 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
-     * `getAuthenticatedUserAndSigners` method.
-     * @see getAuthenticatedUserAndSigners
+     * `#getSigners` method.
+     * @see #getSigners
      */
     signers;
     signerInitialisationError;
@@ -17571,7 +17559,7 @@ class PassportImxProvider {
         this.magicAdapter = magicAdapter;
         this.imxApiClients = imxApiClients;
         this.guardianClient = guardianClient;
-        this.initialiseSigners();
+        this.#initialiseSigners();
         passportEventEmitter.on(PassportEvents.LOGGED_OUT, this.handleLogout);
     }
     handleLogout = () => {
@@ -17586,10 +17574,10 @@ class PassportImxProvider {
      * so that it doesn't result in an unhandled promise rejection.
      *
      * This error is thrown when the signers are requested through:
-     * @see getAuthenticatedUserAndSigners
+     * @see #getSigners
      *
      */
-    initialiseSigners() {
+    #initialiseSigners() {
         const generateSigners = async () => {
             const user = await this.authManager.getUser();
             // The user will be present because the factory validates it
@@ -17611,11 +17599,14 @@ class PassportImxProvider {
             }
         });
     }
-    async getAuthenticatedUserAndSigners() {
+    async #getAuthenticatedUser() {
         const user = await this.authManager.getUser();
         if (!user || !this.signers) {
             throw new PassportError('User has been logged out', PassportErrorType.NOT_LOGGED_IN_ERROR);
         }
+        return user;
+    }
+    async #getSigners() {
         const signers = await this.signers;
         // Throw the stored error if the signers failed to initialise
         if (typeof signers === 'undefined') {
@@ -17624,17 +17615,24 @@ class PassportImxProvider {
             }
             throw new Error('Signers failed to initialise');
         }
-        return { user, ...signers };
+        return signers;
     }
-    async getRegisteredImxUserAndSigners() {
-        const { user, starkSigner, ethSigner } = await this.getAuthenticatedUserAndSigners();
+    async #getRegisteredImxUserAndSigners() {
+        const [user, signers] = await Promise.all([
+            this.#getAuthenticatedUser(),
+            this.#getSigners(),
+        ]);
         if (!isUserImx(user)) {
             throw new PassportError('User has not been registered with StarkEx', PassportErrorType.USER_NOT_REGISTERED_ERROR);
         }
-        return { user, starkSigner, ethSigner };
+        return {
+            user,
+            starkSigner: signers.starkSigner,
+            ethSigner: signers.ethSigner,
+        };
     }
     async transfer(request) {
-        const { user, starkSigner } = await this.getRegisteredImxUserAndSigners();
+        const { user, starkSigner } = await this.#getRegisteredImxUserAndSigners();
         return transfer$1({
             request,
             user,
@@ -17644,20 +17642,22 @@ class PassportImxProvider {
         });
     }
     async registerOffchain() {
-        const { user, ethSigner, starkSigner } = await this.getAuthenticatedUserAndSigners();
-        return await registerOffchain$1(ethSigner, starkSigner, user, this.authManager, this.imxApiClients);
+        const [user, signers] = await Promise.all([
+            this.#getAuthenticatedUser(),
+            this.#getSigners(),
+        ]);
+        return await registerOffchain$1(signers.ethSigner, signers.starkSigner, user, this.authManager, this.imxApiClients);
     }
     async isRegisteredOffchain() {
-        const { user } = await this.getAuthenticatedUserAndSigners();
+        const user = await this.#getAuthenticatedUser();
         return !!user.imx;
     }
-    // TODO: Remove once implemented
     // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
     isRegisteredOnchain() {
         throw new PassportError('Operation not supported', PassportErrorType.OPERATION_NOT_SUPPORTED_ERROR);
     }
     async createOrder(request) {
-        const { user, starkSigner } = await this.getRegisteredImxUserAndSigners();
+        const { user, starkSigner } = await this.#getRegisteredImxUserAndSigners();
         return createOrder$1({
             request,
             user,
@@ -17667,7 +17667,7 @@ class PassportImxProvider {
         });
     }
     async cancelOrder(request) {
-        const { user, starkSigner } = await this.getRegisteredImxUserAndSigners();
+        const { user, starkSigner } = await this.#getRegisteredImxUserAndSigners();
         return cancelOrder$1({
             request,
             user,
@@ -17677,7 +17677,7 @@ class PassportImxProvider {
         });
     }
     async createTrade(request) {
-        const { user, starkSigner } = await this.getRegisteredImxUserAndSigners();
+        const { user, starkSigner } = await this.#getRegisteredImxUserAndSigners();
         return createTrade$1({
             request,
             user,
@@ -17687,7 +17687,7 @@ class PassportImxProvider {
         });
     }
     async batchNftTransfer(request) {
-        const { user, starkSigner } = await this.getRegisteredImxUserAndSigners();
+        const { user, starkSigner } = await this.#getRegisteredImxUserAndSigners();
         return batchNftTransfer({
             request,
             user,
@@ -17697,7 +17697,7 @@ class PassportImxProvider {
         });
     }
     async exchangeTransfer(request) {
-        const { user, starkSigner } = await this.getRegisteredImxUserAndSigners();
+        const { user, starkSigner } = await this.#getRegisteredImxUserAndSigners();
         return exchangeTransfer$1({
             request,
             user,
@@ -17705,17 +17705,14 @@ class PassportImxProvider {
             exchangesApi: this.immutableXClient.exchangeApi,
         });
     }
-    // TODO: Remove once implemented
     // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
     deposit(deposit) {
         throw new PassportError('Operation not supported', PassportErrorType.OPERATION_NOT_SUPPORTED_ERROR);
     }
-    // TODO: Remove once implemented
     // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
     prepareWithdrawal(request) {
         throw new PassportError('Operation not supported', PassportErrorType.OPERATION_NOT_SUPPORTED_ERROR);
     }
-    // TODO: Remove once implemented
     // eslint-disable-next-line class-methods-use-this
     completeWithdrawal(
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -17725,7 +17722,10 @@ class PassportImxProvider {
         throw new PassportError('Operation not supported', PassportErrorType.OPERATION_NOT_SUPPORTED_ERROR);
     }
     async getAddress() {
-        const { user } = await this.getRegisteredImxUserAndSigners();
+        const user = await this.#getAuthenticatedUser();
+        if (!isUserImx(user)) {
+            throw new PassportError('User has not been registered with StarkEx', PassportErrorType.USER_NOT_REGISTERED_ERROR);
+        }
         return Promise.resolve(user.imx.ethAddress);
     }
 }
@@ -18082,33 +18082,45 @@ function getNormalisedTransactions(txs) {
     return txs.map((t) => ({
         delegateCall: t.delegateCall === true,
         revertOnError: t.revertOnError === true,
-        gasLimit: t.gasLimit ?? ethers.ethers.constants.Zero,
-        target: t.to ?? ethers.ethers.constants.AddressZero,
-        value: t.value ?? ethers.ethers.constants.Zero,
+        gasLimit: t.gasLimit ?? ethers.constants.Zero,
+        target: t.to ?? ethers.constants.AddressZero,
+        value: t.value ?? ethers.constants.Zero,
         data: t.data ?? [],
     }));
 }
 function digestOfTransactionsAndNonce(nonce, normalisedTransactions) {
-    const packMetaTransactionsNonceData = ethers.ethers.utils.defaultAbiCoder.encode(['uint256', META_TRANSACTIONS_TYPE], [nonce, normalisedTransactions]);
-    return ethers.ethers.utils.keccak256(packMetaTransactionsNonceData);
+    const packMetaTransactionsNonceData = ethers.utils.defaultAbiCoder.encode(['uint256', META_TRANSACTIONS_TYPE], [nonce, normalisedTransactions]);
+    return ethers.utils.keccak256(packMetaTransactionsNonceData);
 }
 const getNonce = async (jsonRpcProvider, smartContractWalletAddress) => {
-    const code = await jsonRpcProvider.send('eth_getCode', [smartContractWalletAddress, 'latest']);
-    if (code && code !== '0x') {
-        const contract = new ethers.ethers.Contract(smartContractWalletAddress, abi.walletContracts.mainModule.abi, jsonRpcProvider);
-        return contract.nonce();
+    try {
+        const contract = new ethers.Contract(smartContractWalletAddress, abi.walletContracts.mainModule.abi, jsonRpcProvider);
+        const result = await contract.nonce();
+        if (result instanceof ethers.BigNumber) {
+            return result;
+        }
     }
-    return 0;
+    catch (error) {
+        if (error instanceof Error
+            && 'code' in error
+            && error.code === ethers.errors.CALL_EXCEPTION) {
+            // The most likely reason for a CALL_EXCEPTION is that the smart contract wallet
+            // has not been deployed yet, so we should default to a nonce of 0.
+            return ethers.BigNumber.from(0);
+        }
+        throw error;
+    }
+    throw new Error('Unexpected result from contract.nonce() call.');
 };
-const encodeMessageSubDigest = (chainId, walletAddress, digest) => (ethers.ethers.utils.solidityPack(['string', 'uint256', 'address', 'bytes32'], [ETH_SIGN_PREFIX, chainId, walletAddress, digest]));
+const encodeMessageSubDigest = (chainId, walletAddress, digest) => (ethers.utils.solidityPack(['string', 'uint256', 'address', 'bytes32'], [ETH_SIGN_PREFIX, chainId, walletAddress, digest]));
 const getSignedMetaTransactions = async (metaTransactions, nonce, chainId, walletAddress, signer) => {
     const normalisedMetaTransactions = getNormalisedTransactions(metaTransactions);
     // Get the hash
     const digest = digestOfTransactionsAndNonce(nonce, normalisedMetaTransactions);
     const completePayload = encodeMessageSubDigest(chainId, walletAddress, digest);
-    const hash = ethers.ethers.utils.keccak256(completePayload);
+    const hash = ethers.utils.keccak256(completePayload);
     // Sign the digest
-    const hashArray = ethers.ethers.utils.arrayify(hash);
+    const hashArray = ethers.utils.arrayify(hash);
     const ethsigNoType = await signer.signMessage(hashArray);
     const signedDigest = `${ethsigNoType}${ETH_SIGN_FLAG}`;
     // Add metadata
@@ -18125,7 +18137,7 @@ const getSignedMetaTransactions = async (metaTransactions, nonce, chainId, walle
         ],
     });
     // Encode the transaction;
-    const walletInterface = new ethers.ethers.utils.Interface(abi.walletContracts.mainModule.abi);
+    const walletInterface = new ethers.utils.Interface(abi.walletContracts.mainModule.abi);
     return walletInterface.encodeFunctionData(walletInterface.getFunction('execute'), [
         normalisedMetaTransactions,
         nonce,
@@ -18142,13 +18154,13 @@ const getSignedTypedData = async (typedData, relayerSignature, chainId, walletAd
     // @ts-ignore
     delete types.EIP712Domain;
     // Hash the EIP712 payload and generate the complete payload
-    const { _TypedDataEncoder: typedDataEncoder } = ethers.ethers.utils;
+    const { _TypedDataEncoder: typedDataEncoder } = ethers.utils;
     const typedDataHash = typedDataEncoder.hash(typedData.domain, types, typedData.message);
     const messageSubDigest = encodeMessageSubDigest(chainId, walletAddress, typedDataHash);
-    const hash = ethers.ethers.utils.keccak256(messageSubDigest);
+    const hash = ethers.utils.keccak256(messageSubDigest);
     // Sign the sub digest
     // https://github.com/immutable/wallet-contracts/blob/7824b5f24b2e0eb2dc465ecb5cd71f3984556b73/src/contracts/modules/commons/ModuleAuth.sol#L155
-    const hashArray = ethers.ethers.utils.arrayify(hash);
+    const hashArray = ethers.utils.arrayify(hash);
     const ethsigNoType = await signer.signMessage(hashArray);
     const signedDigest = `${ethsigNoType}${ETH_SIGN_FLAG}`;
     // Combine the relayer and user signatures; sort by address to match the imageHash order
@@ -19012,8 +19024,7 @@ class Passport {
             if (useCachedSession) {
                 throw error;
             }
-            // eslint-disable-next-line no-console
-            console.warn('login failed to retrieve a cached user session', error);
+            logger$f.warn('Failed to retrieve a cached user session', error);
         }
         if (!user && !useCachedSession) {
             user = await this.authManager.login(options?.anonymousId);
@@ -19047,8 +19058,7 @@ class Passport {
             await this.confirmationScreen.logout();
         }
         catch (err) {
-            // eslint-disable-next-line no-console
-            console.warn('Failed to logout from confirmation screen', err);
+            logger$f.warn('Failed to logout from confirmation screen', err);
         }
         await Promise.allSettled([
             this.authManager.logout(),
@@ -37857,7 +37867,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.13.0';
+const SDK_VERSION = '1.13.2-alpha.1';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -43033,7 +43043,7 @@ const IMMUTABLE_ZKVEM_GAS_OVERRIDES = {
     maxPriorityFeePerGas: ethers.BigNumber.from(10e9),
 };
 
-const SDK_VERSION_MARKER = '1.13.0';
+const SDK_VERSION_MARKER = '1.13.2-alpha.1';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 

package/dist/index.d.ts

@@ -23,23 +23,8 @@ declare class ImmutableConfiguration {
 declare const addKeysToHeadersOverride: <T extends {
     headers?: Record<string, string> | undefined;
 }>(baseConfig: ImmutableConfiguration | undefined, overrides: T | undefined) => T | undefined;
-declare const addApiKeyToAxiosHeader: (apiKey: string) => void;
-declare const addPublishableKeyToAxiosHeader: (publishableKey: string) => void;
-declare const addRateLimitingKeyToAxiosHeader: (rateLimitingKey: string) => void;
-type ImmutableConfigurationWithRequireableFields<T> = ImmutableConfiguration & (T extends {
-    apiKey: 'required';
-} ? Required<{
-    apiKey: string;
-}> : {}) & (T extends {
-    publishableKey: 'required';
-} ? Required<{
-    publishableKey: string;
-}> : {});
-type ImmutableConfigurationWithOmitableFields<T> = T extends {
-    apiKey: 'omit';
-} ? Omit<ImmutableConfigurationWithRequireableFields<T>, 'apiKey'> : ImmutableConfigurationWithRequireableFields<T>;
 interface ModuleConfiguration<T> {
-    baseConfig: ImmutableConfigurationWithOmitableFields<T>;
+    baseConfig: ImmutableConfiguration;
     overrides?: T;
 }
 
@@ -50,20 +35,14 @@ declare const config_d_ImmutableConfiguration: typeof ImmutableConfiguration;
 type config_d_KeyHeaders = KeyHeaders;
 declare const config_d_KeyHeaders: typeof KeyHeaders;
 type config_d_ModuleConfiguration<T> = ModuleConfiguration<T>;
-declare const config_d_addApiKeyToAxiosHeader: typeof addApiKeyToAxiosHeader;
 declare const config_d_addKeysToHeadersOverride: typeof addKeysToHeadersOverride;
-declare const config_d_addPublishableKeyToAxiosHeader: typeof addPublishableKeyToAxiosHeader;
-declare const config_d_addRateLimitingKeyToAxiosHeader: typeof addRateLimitingKeyToAxiosHeader;
 declare namespace config_d {
   export {
     config_d_Environment as Environment,
     config_d_ImmutableConfiguration as ImmutableConfiguration,
     config_d_KeyHeaders as KeyHeaders,
     config_d_ModuleConfiguration as ModuleConfiguration,
-    config_d_addApiKeyToAxiosHeader as addApiKeyToAxiosHeader,
     config_d_addKeysToHeadersOverride as addKeysToHeadersOverride,
-    config_d_addPublishableKeyToAxiosHeader as addPublishableKeyToAxiosHeader,
-    config_d_addRateLimitingKeyToAxiosHeader as addRateLimitingKeyToAxiosHeader,
   };
 }