@imtbl/sdk 0.29.0-alpha.1 → 0.30.0

package/dist/passport.js

@@ -1924,14 +1924,18 @@ const PassportApiAxiosParamCreator = function (configuration) {
         /**
          * Create a counterfactual address for a user based on their Ethereum address
          * @summary Create a counterfactual address
+         * @param {string} chainName
          * @param {CreateCounterfactualAddressRequest} createCounterfactualAddressRequest
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createCounterfactualAddress: async (createCounterfactualAddressRequest, options = {}) => {
+        createCounterfactualAddress: async (chainName, createCounterfactualAddressRequest, options = {}) => {
+            // verify required parameter 'chainName' is not null or undefined
+            assertParamExists$1('createCounterfactualAddress', 'chainName', chainName);
             // verify required parameter 'createCounterfactualAddressRequest' is not null or undefined
             assertParamExists$1('createCounterfactualAddress', 'createCounterfactualAddressRequest', createCounterfactualAddressRequest);
-            const localVarPath = `/passport-mr/v1/counterfactual-address`;
+            const localVarPath = `/v1/chains/{chain_name}/passport/counterfactual-address`
+                .replace(`{${"chain_name"}}`, encodeURIComponent(String(chainName)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL$1);
             let baseOptions;
@@ -1954,16 +1958,85 @@ const PassportApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Create a counterfactual address for a user based on their Ethereum address
+         * @summary Create a counterfactual address
+         * @param {CreateCounterfactualAddressRequestDeprecated} createCounterfactualAddressRequestDeprecated
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createCounterfactualAddressDeprecated: async (createCounterfactualAddressRequestDeprecated, options = {}) => {
+            // verify required parameter 'createCounterfactualAddressRequestDeprecated' is not null or undefined
+            assertParamExists$1('createCounterfactualAddressDeprecated', 'createCounterfactualAddressRequestDeprecated', createCounterfactualAddressRequestDeprecated);
+            const localVarPath = `/passport-mr/v1/counterfactual-address`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL$1);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication BearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject$1(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams$1(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            localVarRequestOptions.data = serializeDataIfNeeded$1(createCounterfactualAddressRequestDeprecated, localVarRequestOptions, configuration);
+            return {
+                url: toPathString$1(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Get all the Ethereum linked addresses for a user based on its userId
          * @summary Get Ethereum linked addresses for a user
          * @param {string} userId The user\'s userId
+         * @param {string} chainName
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getLinkedAddresses: async (userId, options = {}) => {
+        getLinkedAddresses: async (userId, chainName, options = {}) => {
             // verify required parameter 'userId' is not null or undefined
             assertParamExists$1('getLinkedAddresses', 'userId', userId);
+            // verify required parameter 'chainName' is not null or undefined
+            assertParamExists$1('getLinkedAddresses', 'chainName', chainName);
+            const localVarPath = `/v1/chains/{chain_name}/passport/users/{user_id}/linked-addresses`
+                .replace(`{${"user_id"}}`, encodeURIComponent(String(userId)))
+                .replace(`{${"chain_name"}}`, encodeURIComponent(String(chainName)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL$1);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication BearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject$1(localVarHeaderParameter, configuration);
+            setSearchParams$1(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: toPathString$1(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Get all the Ethereum linked addresses for a user based on its userId
+         * @summary Get Ethereum linked addresses for a user
+         * @param {string} userId The user\'s userId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLinkedAddressesDeprecated: async (userId, options = {}) => {
+            // verify required parameter 'userId' is not null or undefined
+            assertParamExists$1('getLinkedAddressesDeprecated', 'userId', userId);
             const localVarPath = `/passport-mr/v1/users/{userId}/linked-addresses`
                 .replace(`{${"userId"}}`, encodeURIComponent(String(userId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -1998,12 +2071,36 @@ const PassportApiFp = function (configuration) {
         /**
          * Create a counterfactual address for a user based on their Ethereum address
          * @summary Create a counterfactual address
+         * @param {string} chainName
          * @param {CreateCounterfactualAddressRequest} createCounterfactualAddressRequest
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async createCounterfactualAddress(createCounterfactualAddressRequest, options) {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.createCounterfactualAddress(createCounterfactualAddressRequest, options);
+        async createCounterfactualAddress(chainName, createCounterfactualAddressRequest, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createCounterfactualAddress(chainName, createCounterfactualAddressRequest, options);
+            return createRequestFunction$1(localVarAxiosArgs, globalAxios$1, BASE_PATH$1, configuration);
+        },
+        /**
+         * Create a counterfactual address for a user based on their Ethereum address
+         * @summary Create a counterfactual address
+         * @param {CreateCounterfactualAddressRequestDeprecated} createCounterfactualAddressRequestDeprecated
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createCounterfactualAddressDeprecated(createCounterfactualAddressRequestDeprecated, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createCounterfactualAddressDeprecated(createCounterfactualAddressRequestDeprecated, options);
+            return createRequestFunction$1(localVarAxiosArgs, globalAxios$1, BASE_PATH$1, configuration);
+        },
+        /**
+         * Get all the Ethereum linked addresses for a user based on its userId
+         * @summary Get Ethereum linked addresses for a user
+         * @param {string} userId The user\'s userId
+         * @param {string} chainName
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getLinkedAddresses(userId, chainName, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getLinkedAddresses(userId, chainName, options);
             return createRequestFunction$1(localVarAxiosArgs, globalAxios$1, BASE_PATH$1, configuration);
         },
         /**
@@ -2013,8 +2110,8 @@ const PassportApiFp = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getLinkedAddresses(userId, options) {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getLinkedAddresses(userId, options);
+        async getLinkedAddressesDeprecated(userId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getLinkedAddressesDeprecated(userId, options);
             return createRequestFunction$1(localVarAxiosArgs, globalAxios$1, BASE_PATH$1, configuration);
         },
     };
@@ -2035,7 +2132,18 @@ class PassportApi extends BaseAPI$1 {
      * @memberof PassportApi
      */
     createCounterfactualAddress(requestParameters, options) {
-        return PassportApiFp(this.configuration).createCounterfactualAddress(requestParameters.createCounterfactualAddressRequest, options).then((request) => request(this.axios, this.basePath));
+        return PassportApiFp(this.configuration).createCounterfactualAddress(requestParameters.chainName, requestParameters.createCounterfactualAddressRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Create a counterfactual address for a user based on their Ethereum address
+     * @summary Create a counterfactual address
+     * @param {PassportApiCreateCounterfactualAddressDeprecatedRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PassportApi
+     */
+    createCounterfactualAddressDeprecated(requestParameters, options) {
+        return PassportApiFp(this.configuration).createCounterfactualAddressDeprecated(requestParameters.createCounterfactualAddressRequestDeprecated, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Get all the Ethereum linked addresses for a user based on its userId
@@ -2046,7 +2154,18 @@ class PassportApi extends BaseAPI$1 {
      * @memberof PassportApi
      */
     getLinkedAddresses(requestParameters, options) {
-        return PassportApiFp(this.configuration).getLinkedAddresses(requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
+        return PassportApiFp(this.configuration).getLinkedAddresses(requestParameters.userId, requestParameters.chainName, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Get all the Ethereum linked addresses for a user based on its userId
+     * @summary Get Ethereum linked addresses for a user
+     * @param {PassportApiGetLinkedAddressesDeprecatedRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PassportApi
+     */
+    getLinkedAddressesDeprecated(requestParameters, options) {
+        return PassportApiFp(this.configuration).getLinkedAddressesDeprecated(requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
     }
 }
 
@@ -2072,7 +2191,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.29.0-alpha.1' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.30.0' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -2128,7 +2247,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.29.0-alpha.1',
+    sdkVersion: 'ts-immutable-sdk-0.30.0',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -6626,6 +6745,41 @@ const withPassportError = async (fn, customErrorType) => {
     }
 };
 
+/**
+ * Enum representing different chain IDs.
+ * @enum {number}
+ * @property {number} IMTBL_ZKEVM_MAINNET - The chain ID for IMTBL ZKEVM Mainnet.
+ * @property {number} IMTBL_ZKEVM_TESTNET - The chain ID for IMTBL ZKEVM Testnet.
+ * @property {number} IMTBL_ZKEVM_DEVNET - The chain ID for IMTBL ZKEVM Devnet.
+ * @property {number} ETHEREUM - The chain ID for Ethereum.
+ * @property {number} SEPOLIA - The chain ID for Sepolia.
+ */
+var ChainId;
+(function (ChainId) {
+    ChainId[ChainId["IMTBL_ZKEVM_MAINNET"] = 13371] = "IMTBL_ZKEVM_MAINNET";
+    ChainId[ChainId["IMTBL_ZKEVM_TESTNET"] = 13472] = "IMTBL_ZKEVM_TESTNET";
+    ChainId[ChainId["IMTBL_ZKEVM_DEVNET"] = 13433] = "IMTBL_ZKEVM_DEVNET";
+    ChainId[ChainId["ETHEREUM"] = 1] = "ETHEREUM";
+    ChainId[ChainId["SEPOLIA"] = 11155111] = "SEPOLIA";
+})(ChainId || (ChainId = {}));
+/**
+ * Enum representing different chain names.
+ * @enum {number}
+ * @property {number} IMTBL_ZKEVM_MAINNET - The chain name for IMTBL ZKEVM Mainnet.
+ * @property {number} IMTBL_ZKEVM_TESTNET - The chain name for IMTBL ZKEVM Testnet.
+ * @property {number} IMTBL_ZKEVM_DEVNET - The chain name for IMTBL ZKEVM Devnet.
+ * @property {number} ETHEREUM - The chain name for Ethereum.
+ * @property {number} SEPOLIA - The chain name for Sepolia.
+ */
+var ChainName;
+(function (ChainName) {
+    ChainName["ETHEREUM"] = "Ethereum";
+    ChainName["SEPOLIA"] = "Sepolia";
+    ChainName["IMTBL_ZKEVM_TESTNET"] = "Immutable zkEVM Test";
+    ChainName["IMTBL_ZKEVM_DEVNET"] = "Immutable zkEVM Dev";
+    ChainName["IMTBL_ZKEVM_MAINNET"] = "Immutable zkEVM";
+})(ChainName || (ChainName = {}));
+
 const keyCrendentials = 'passport_credentials';
 const KEY_PKCE_STATE = 'pkce_state';
 const KEY_PKCE_VERIFIER = 'pkce_verifier';
@@ -8391,18 +8545,47 @@ class RelayerClient {
     }
 }
 
+const CHAIN_NAME_MAP = new Map([
+    [
+        ChainId.ETHEREUM,
+        ChainName.ETHEREUM,
+    ],
+    [
+        ChainId.SEPOLIA,
+        ChainName.SEPOLIA,
+    ],
+    [
+        ChainId.IMTBL_ZKEVM_MAINNET,
+        ChainName.IMTBL_ZKEVM_MAINNET,
+    ],
+    [
+        ChainId.IMTBL_ZKEVM_TESTNET,
+        ChainName.IMTBL_ZKEVM_TESTNET,
+    ],
+    [
+        ChainId.IMTBL_ZKEVM_DEVNET,
+        ChainName.IMTBL_ZKEVM_DEVNET,
+    ],
+]);
+
 const MESSAGE_TO_SIGN = 'Only sign this message from Immutable Passport';
-async function registerZkEvmUser({ authManager, config, magicProvider, multiRollupApiClients, accessToken, }) {
+async function registerZkEvmUser({ authManager, config, magicProvider, multiRollupApiClients, accessToken, jsonRpcProvider, }) {
     const web3Provider = new Web3Provider(magicProvider);
     const ethSigner = web3Provider.getSigner();
     const ethereumAddress = await ethSigner.getAddress();
     const ethereumSignature = await signRaw(MESSAGE_TO_SIGN, ethSigner);
     const headers = { Authorization: `Bearer ${accessToken}` };
+    const { chainId } = await jsonRpcProvider.ready;
     try {
+        const chainName = CHAIN_NAME_MAP.get(chainId);
+        if (!chainName) {
+            throw new JsonRpcError(RpcErrorCode.INTERNAL_ERROR, `Chain name does not exist on for chain id ${chainId}`);
+        }
         await multiRollupApiClients.passportApi.createCounterfactualAddress({
+            chainName,
             createCounterfactualAddressRequest: {
-                ethereumAddress,
-                ethereumSignature,
+                ethereum_address: ethereumAddress,
+                ethereum_signature: ethereumSignature,
             },
         }, { headers });
     }
@@ -8426,7 +8609,7 @@ async function registerZkEvmUser({ authManager, config, magicProvider, multiRoll
     return user;
 }
 
-const loginZkEvmUser = async ({ authManager, config, magicAdapter, multiRollupApiClients, }) => {
+const loginZkEvmUser = async ({ authManager, config, magicAdapter, multiRollupApiClients, jsonRpcProvider, }) => {
     const user = await authManager.getUser() || await authManager.getUserDeviceFlow() || await authManager.login();
     if (!user.idToken) {
         throw new Error('User is missing idToken');
@@ -8440,6 +8623,7 @@ const loginZkEvmUser = async ({ authManager, config, magicAdapter, multiRollupAp
             magicProvider,
             multiRollupApiClients,
             accessToken: user.accessToken,
+            jsonRpcProvider,
         });
         return {
             user: userZkevm,
@@ -8654,6 +8838,7 @@ class ZkEvmProvider {
                     config: this.config,
                     magicAdapter: this.magicAdapter,
                     multiRollupApiClients: this.multiRollupApiClients,
+                    jsonRpcProvider: this.jsonRpcProvider,
                 });
                 this.user = user;
                 this.magicProvider = magicProvider;
@@ -8958,9 +9143,10 @@ class Passport {
         }
         const headers = { Authorization: `Bearer ${user.accessToken}` };
         const linkedAddressesResult = await this.multiRollupApiClients.passportApi.getLinkedAddresses({
+            chainName: ChainName.ETHEREUM,
             userId: user?.profile.sub,
         }, { headers });
-        return linkedAddressesResult.data.linkedAddresses;
+        return linkedAddressesResult.data.linked_addresses;
     }
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "0.29.0-alpha.1",
+  "version": "0.30.0",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
@@ -36,9 +36,6 @@
     "oidc-client-ts": "^2.2.1",
     "os-browserify": "^0.3.0",
     "pako": "^2.1.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "react-router-dom": "^6.11.0",
     "stream-browserify": "^3.0.0",
     "stream-http": "^3.2.0",
     "url": "^0.11.0"