@imtbl/sdk 0.17.5 → 0.18.0

package/dist/passport.d.ts

@@ -10546,6 +10546,27 @@ declare class JsonRpcError extends Error {
     constructor(code: ProviderErrorCode | RpcErrorCode, message: string);
 }
 
+interface TypedDataPayload {
+    types: {
+        EIP712Domain: Array<{
+            name: string;
+            type: string;
+        }>;
+        [key: string]: Array<{
+            name: string;
+            type: string;
+        }>;
+    };
+    domain: {
+        name?: string;
+        version?: string;
+        chainId?: number;
+        verifyingContract?: string;
+        salt?: string;
+    };
+    primaryType: string;
+    message: Record<string, any>;
+}
 interface RequestArguments {
     method: string;
     params?: Array<any>;
@@ -10613,4 +10634,4 @@ declare class Passport {
     getLinkedAddresses(): Promise<string[]>;
 }
 
-export { AccountsChangedEvent, DeviceConnectResponse, DeviceTokenResponse, JsonRpcError, JsonRpcRequestCallback, JsonRpcRequestPayload, JsonRpcResponsePayload, Networks, Passport, PassportError, PassportModuleConfiguration, PassportOverrides, Provider, ProviderErrorCode, ProviderEvent, RequestArguments, RpcErrorCode, UserProfile };
+export { AccountsChangedEvent, DeviceConnectResponse, DeviceTokenResponse, JsonRpcError, JsonRpcRequestCallback, JsonRpcRequestPayload, JsonRpcResponsePayload, Networks, Passport, PassportError, PassportModuleConfiguration, PassportOverrides, Provider, ProviderErrorCode, ProviderEvent, RequestArguments, RpcErrorCode, TypedDataPayload, UserProfile };

package/dist/passport.js

@@ -11,7 +11,7 @@ import * as encUtils from 'enc-utils';
 import { Web3Provider, JsonRpcProvider } from '@ethersproject/providers';
 import { EventEmitter } from 'events';
 import { walletContracts } from '@0xsequence/abi';
-import { encodeSignature } from '@0xsequence/config';
+import { encodeSignature, decodeSignature } from '@0xsequence/config';
 
 /* tslint:disable */
 /* eslint-disable */
@@ -1709,7 +1709,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.17.5' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.18.0' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -1765,7 +1765,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.17.5',
+    sdkVersion: 'ts-immutable-sdk-0.18.0',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -5489,6 +5489,8 @@ var globalAxios = axios;
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+// Some imports not used depending on template conditions
+// @ts-ignore
 const BASE_PATH = "https://guardian.sandbox.imtbl.com".replace(/\/+$/, "");
 /**
  *
@@ -5516,10 +5518,10 @@ class BaseAPI {
  */
 class RequiredError extends Error {
     field;
+    name = "RequiredError";
     constructor(field, msg) {
         super(msg);
         this.field = field;
-        this.name = "RequiredError";
     }
 }
 
@@ -5564,8 +5566,6 @@ const setBearerAuthToObject = async function (object, configuration) {
     }
 };
 function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
-    if (parameter == null)
-        return;
     if (typeof parameter === "object") {
         if (Array.isArray(parameter)) {
             parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
@@ -5623,6 +5623,208 @@ const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, confi
     };
 };
 
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Guardian
+ * Guardian API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * MessagesApi - axios parameter creator
+ * @export
+ */
+const MessagesApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Approve a pending evm message
+         * @summary Approve a pending evm message
+         * @param {string} messageID id for the message
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        approvePendingMessage: async (messageID, options = {}) => {
+            // verify required parameter 'messageID' is not null or undefined
+            assertParamExists('approvePendingMessage', 'messageID', messageID);
+            const localVarPath = `/guardian/v1/messages/{messageID}/approve`
+                .replace(`{${"messageID"}}`, encodeURIComponent(String(messageID)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            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(localVarHeaderParameter, configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Check if a given message is valid  for EVM
+         * @summary Evaluate an evm message to sign
+         * @param {MessageEvaluationRequest} messageEvaluationRequest Specifies the kind of transaction
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        evaluateMessage: async (messageEvaluationRequest, options = {}) => {
+            // verify required parameter 'messageEvaluationRequest' is not null or undefined
+            assertParamExists('evaluateMessage', 'messageEvaluationRequest', messageEvaluationRequest);
+            const localVarPath = `/guardian/v1/messages/evaluate`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            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(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            localVarRequestOptions.data = serializeDataIfNeeded(messageEvaluationRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Get an evm message by id
+         * @summary Info for a specific evm message
+         * @param {string} messageID The id of the evm message
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMessageByID: async (messageID, options = {}) => {
+            // verify required parameter 'messageID' is not null or undefined
+            assertParamExists('getMessageByID', 'messageID', messageID);
+            const localVarPath = `/guardian/v1/messages/{messageID}`
+                .replace(`{${"messageID"}}`, encodeURIComponent(String(messageID)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            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(localVarHeaderParameter, configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    };
+};
+/**
+ * MessagesApi - functional programming interface
+ * @export
+ */
+const MessagesApiFp = function (configuration) {
+    const localVarAxiosParamCreator = MessagesApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Approve a pending evm message
+         * @summary Approve a pending evm message
+         * @param {string} messageID id for the message
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async approvePendingMessage(messageID, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.approvePendingMessage(messageID, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Check if a given message is valid  for EVM
+         * @summary Evaluate an evm message to sign
+         * @param {MessageEvaluationRequest} messageEvaluationRequest Specifies the kind of transaction
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async evaluateMessage(messageEvaluationRequest, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.evaluateMessage(messageEvaluationRequest, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Get an evm message by id
+         * @summary Info for a specific evm message
+         * @param {string} messageID The id of the evm message
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getMessageByID(messageID, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getMessageByID(messageID, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    };
+};
+/**
+ * MessagesApi - object-oriented interface
+ * @export
+ * @class MessagesApi
+ * @extends {BaseAPI}
+ */
+class MessagesApi extends BaseAPI {
+    /**
+     * Approve a pending evm message
+     * @summary Approve a pending evm message
+     * @param {MessagesApiApprovePendingMessageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MessagesApi
+     */
+    approvePendingMessage(requestParameters, options) {
+        return MessagesApiFp(this.configuration).approvePendingMessage(requestParameters.messageID, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Check if a given message is valid  for EVM
+     * @summary Evaluate an evm message to sign
+     * @param {MessagesApiEvaluateMessageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MessagesApi
+     */
+    evaluateMessage(requestParameters, options) {
+        return MessagesApiFp(this.configuration).evaluateMessage(requestParameters.messageEvaluationRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Get an evm message by id
+     * @summary Info for a specific evm message
+     * @param {MessagesApiGetMessageByIDRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MessagesApi
+     */
+    getMessageByID(requestParameters, options) {
+        return MessagesApiFp(this.configuration).getMessageByID(requestParameters.messageID, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
 /* tslint:disable */
 /* eslint-disable */
 /**
@@ -5646,7 +5848,7 @@ const TransactionsApiAxiosParamCreator = function (configuration) {
          * Approve a pending transaction
          * @summary Approve a pending transaction given chain
          * @param {string} payloadHash Hash for the payload
-         * @param {TransactionApprovalRequest} transactionApprovalRequest request body for approving a pending transactio
+         * @param {TransactionApprovalRequest} transactionApprovalRequest request body for approving a pending transaction
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -5771,7 +5973,7 @@ const TransactionsApiFp = function (configuration) {
          * Approve a pending transaction
          * @summary Approve a pending transaction given chain
          * @param {string} payloadHash Hash for the payload
-         * @param {TransactionApprovalRequest} transactionApprovalRequest request body for approving a pending transactio
+         * @param {TransactionApprovalRequest} transactionApprovalRequest request body for approving a pending transaction
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -6528,18 +6730,18 @@ const transformGuardianTransactions = (txs) => {
 };
 class GuardianClient {
     transactionAPI;
+    messageAPI;
     confirmationScreen;
     // TODO: ID-977, make this rollup agnostic
     imxEtherAddress;
     crossSdkBridgeEnabled;
     constructor({ accessToken, confirmationScreen, imxEtherAddress, config, }) {
+        const guardianConfiguration = new Configuration({ accessToken, basePath: config.imxPublicApiDomain });
         this.confirmationScreen = confirmationScreen;
-        this.transactionAPI = new TransactionsApi(new Configuration({
-            accessToken,
-            basePath: config.imxPublicApiDomain,
-        }));
+        this.transactionAPI = new TransactionsApi(new Configuration(guardianConfiguration));
         this.imxEtherAddress = imxEtherAddress;
         this.crossSdkBridgeEnabled = config.crossSdkBridgeEnabled;
+        this.messageAPI = new MessagesApi(guardianConfiguration);
     }
     /**
      * Open confirmation screen and close it automatically if the
@@ -6638,6 +6840,31 @@ class GuardianClient {
             this.confirmationScreen.closeWindow();
         }
     }
+    async evaluateMessage({ chainID, payload, user }) {
+        try {
+            const messageEvalResponse = await this.messageAPI.evaluateMessage({ messageEvaluationRequest: { chainID, payload } }, { headers: { Authorization: `Bearer ${user.accessToken}` } });
+            return messageEvalResponse.data;
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            throw new JsonRpcError(RpcErrorCode.INTERNAL_ERROR, `Message failed to validate with error: ${errorMessage}`);
+        }
+    }
+    async validateMessage({ chainID, payload, user }) {
+        const { messageId, confirmationRequired } = await this.evaluateMessage({ chainID, payload, user });
+        if (confirmationRequired && this.crossSdkBridgeEnabled) {
+            throw new JsonRpcError(RpcErrorCode.TRANSACTION_REJECTED, transactionRejectedCrossSdkBridgeError);
+        }
+        if (confirmationRequired && !!messageId) {
+            const confirmationResult = await this.confirmationScreen.requestMessageConfirmation(messageId);
+            if (!confirmationResult.confirmed) {
+                throw new JsonRpcError(RpcErrorCode.TRANSACTION_REJECTED, 'Signature rejected by user');
+            }
+        }
+        else {
+            this.confirmationScreen.closeWindow();
+        }
+    }
 }
 
 var PassportEvents;
@@ -7265,6 +7492,8 @@ var ReceiveMessage;
     ReceiveMessage["CONFIRMATION_WINDOW_READY"] = "confirmation_window_ready";
     ReceiveMessage["TRANSACTION_CONFIRMED"] = "transaction_confirmed";
     ReceiveMessage["TRANSACTION_ERROR"] = "transaction_error";
+    ReceiveMessage["MESSAGE_CONFIRMED"] = "message_confirmed";
+    ReceiveMessage["MESSAGE_REJECTED"] = "message_rejected";
 })(ReceiveMessage || (ReceiveMessage = {}));
 const PASSPORT_EVENT_TYPE = 'imx_passport_confirmation';
 
@@ -7318,11 +7547,11 @@ class ConfirmationScreen {
                         reject(new Error('Unsupported message type'));
                 }
             };
-            window.addEventListener('message', messageHandler);
             if (!this.confirmationWindow) {
                 resolve({ confirmed: false });
                 return;
             }
+            window.addEventListener('message', messageHandler);
             let href = '';
             if (chainType === TransactionApprovalRequestChainTypeEnum.Starkex) {
                 // eslint-disable-next-line max-len
@@ -7332,15 +7561,39 @@ class ConfirmationScreen {
                 // eslint-disable-next-line max-len
                 href = `${this.config.passportDomain}/transaction-confirmation/zkevm?transactionId=${transactionId}&imxEtherAddress=${imxEtherAddress}&chainType=evm&chainId=${chainId}`;
             }
-            this.confirmationWindow.location.href = href;
-            // https://stackoverflow.com/questions/9388380/capture-the-close-event-of-popup-window-in-javascript/48240128#48240128
-            const timer = setInterval(() => {
-                if (this.confirmationWindow?.closed) {
-                    clearInterval(timer);
-                    window.removeEventListener('message', messageHandler);
-                    resolve({ confirmed: false });
+            this.showConfirmationScreen(href, messageHandler, resolve);
+        });
+    }
+    requestMessageConfirmation(messageId) {
+        return new Promise((resolve, reject) => {
+            const messageHandler = ({ data, origin }) => {
+                if (origin !== this.config.passportDomain
+                    || data.eventType !== PASSPORT_EVENT_TYPE) {
+                    return;
+                }
+                switch (data.messageType) {
+                    case ReceiveMessage.CONFIRMATION_WINDOW_READY: {
+                        break;
+                    }
+                    case ReceiveMessage.MESSAGE_CONFIRMED: {
+                        resolve({ confirmed: true });
+                        break;
+                    }
+                    case ReceiveMessage.MESSAGE_REJECTED: {
+                        reject(new Error('Message rejected'));
+                        break;
+                    }
+                    default:
+                        reject(new Error('Unsupported message type'));
                 }
-            }, CONFIRMATION_WINDOW_CLOSED_POLLING_DURATION);
+            };
+            if (!this.confirmationWindow) {
+                resolve({ confirmed: false });
+                return;
+            }
+            window.addEventListener('message', messageHandler);
+            const href = `${this.config.passportDomain}/transaction-confirmation/zkevm/message?messageID=${messageId}`;
+            this.showConfirmationScreen(href, messageHandler, resolve);
         });
     }
     loading(popupOptions) {
@@ -7358,6 +7611,17 @@ class ConfirmationScreen {
     closeWindow() {
         this.confirmationWindow?.close();
     }
+    showConfirmationScreen(href, messageHandler, resolve) {
+        this.confirmationWindow.location.href = href;
+        // https://stackoverflow.com/questions/9388380/capture-the-close-event-of-popup-window-in-javascript/48240128#48240128
+        const timer = setInterval(() => {
+            if (this.confirmationWindow?.closed) {
+                clearInterval(timer);
+                window.removeEventListener('message', messageHandler);
+                resolve({ confirmed: false });
+            }
+        }, CONFIRMATION_WINDOW_CLOSED_POLLING_DURATION);
+    }
 }
 
 var RelayerTransactionStatus;
@@ -7386,13 +7650,9 @@ class TypedEventEmitter {
     }
 }
 
-// These are ignored by the Relayer but for consistency we set them to the
-// appropriate values for a 1/1 wallet.
-//
-// Weight of a single signature in the multisig
-const SIGNATURE_WEIGHT = 1;
-// Total required weight in the multisig
-const SIGNATURE_THRESHOLD = 1;
+const SIGNATURE_WEIGHT = 1; // Weight of a single signature in the multi-sig
+const TRANSACTION_SIGNATURE_THRESHOLD = 1; // Total required weight in the multi-sig for a transaction
+const EIP712_SIGNATURE_THRESHOLD = 2; // Total required weight in the multi-sig for data signing
 const ETH_SIGN_FLAG = '02';
 const ETH_SIGN_PREFIX = '\x19\x01';
 const META_TRANSACTIONS_TYPE = `tuple(
@@ -7425,11 +7685,12 @@ const getNonce = async (jsonRpcProvider, smartContractWalletAddress) => {
     }
     return 0;
 };
+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 = ethers.utils.solidityPack(['string', 'uint256', 'address', 'bytes32'], [ETH_SIGN_PREFIX, chainId, walletAddress, digest]);
+    const completePayload = encodeMessageSubDigest(chainId, walletAddress, digest);
     const hash = ethers.utils.keccak256(completePayload);
     // Sign the digest
     const hashArray = ethers.utils.arrayify(hash);
@@ -7437,7 +7698,7 @@ const getSignedMetaTransactions = async (metaTransactions, nonce, chainId, walle
     const signedDigest = `${ethsigNoType}${ETH_SIGN_FLAG}`;
     // Add metadata
     const encodedSignature = encodeSignature({
-        threshold: SIGNATURE_THRESHOLD,
+        threshold: TRANSACTION_SIGNATURE_THRESHOLD,
         signers: [
             {
                 weight: SIGNATURE_WEIGHT,
@@ -7453,6 +7714,35 @@ const getSignedMetaTransactions = async (metaTransactions, nonce, chainId, walle
         encodedSignature,
     ]);
 };
+const decodeRelayerTypedDataSignature = (relayerSignature) => {
+    const signatureWithThreshold = `0000${relayerSignature}`;
+    return decodeSignature(signatureWithThreshold);
+};
+const getSignedTypedData = async (typedData, relayerSignature, chainId, walletAddress, signer) => {
+    // Ethers auto-generates the EIP712Domain type in the TypedDataEncoder, and so it needs to be removed
+    const types = { ...typedData.types };
+    // @ts-ignore
+    delete types.EIP712Domain;
+    // eslint-disable-next-line no-underscore-dangle
+    const digest = ethers.utils._TypedDataEncoder.hash(typedData.domain, types, typedData.message);
+    const completePayload = encodeMessageSubDigest(chainId, walletAddress, digest);
+    const hash = ethers.utils.keccak256(completePayload);
+    // Sign the digest
+    const hashArray = ethers.utils.arrayify(hash);
+    const ethsigNoType = await signer.signMessage(hashArray);
+    const signedDigest = `${ethsigNoType}${ETH_SIGN_FLAG}`;
+    const { signers } = decodeRelayerTypedDataSignature(relayerSignature);
+    return encodeSignature({
+        threshold: EIP712_SIGNATURE_THRESHOLD,
+        signers: [
+            ...signers,
+            {
+                weight: SIGNATURE_WEIGHT,
+                signature: signedDigest,
+            },
+        ],
+    });
+};
 const getEip155ChainId = (chainId) => `eip155:${chainId}`;
 
 class RelayerClient {
@@ -7518,6 +7808,19 @@ class RelayerClient {
         const { result } = await this.postToRelayer(payload);
         return result;
     }
+    async imSignTypedData(address, eip712Payload) {
+        const { chainId } = await this.jsonRpcProvider.ready;
+        const payload = {
+            method: 'im_signTypedData',
+            params: [{
+                    address,
+                    eip712Payload,
+                    chainId: getEip155ChainId(chainId),
+                }],
+        };
+        const { result } = await this.postToRelayer(payload);
+        return result;
+    }
 }
 
 const MESSAGE_TO_SIGN = 'Only sign this message from Immutable Passport';
@@ -7658,6 +7961,60 @@ const sendTransaction = ({ params, magicProvider, jsonRpcProvider, relayerClient
     return relayerTransaction.hash;
 });
 
+const REQUIRED_TYPED_DATA_PROPERTIES = ['types', 'domain', 'primaryType', 'message'];
+const isValidTypedDataPayload = (typedData) => (REQUIRED_TYPED_DATA_PROPERTIES.every((key) => key in typedData));
+const transformTypedData = (typedData, chainId) => {
+    let transformedTypedData;
+    if (typeof typedData === 'string') {
+        try {
+            transformedTypedData = JSON.parse(typedData);
+        }
+        catch (err) {
+            throw new JsonRpcError(RpcErrorCode.INVALID_PARAMS, `Failed to parse typed data JSON: ${err}`);
+        }
+    }
+    else if (typeof typedData === 'object') {
+        transformedTypedData = typedData;
+    }
+    else {
+        throw new JsonRpcError(RpcErrorCode.INVALID_PARAMS, `Invalid typed data argument: ${typedData}`);
+    }
+    if (!isValidTypedDataPayload(transformedTypedData)) {
+        throw new JsonRpcError(RpcErrorCode.INVALID_PARAMS, `Invalid typed data argument. The following properties are required: ${REQUIRED_TYPED_DATA_PROPERTIES.join(', ')}`);
+    }
+    const providedChainId = transformedTypedData.domain?.chainId;
+    if (providedChainId) {
+        // domain.chainId (if defined) can be a number, string, or hex value, but the relayer & guardian only accept a number.
+        if (typeof providedChainId === 'string') {
+            if (providedChainId.startsWith('0x')) {
+                transformedTypedData.domain.chainId = parseInt(providedChainId, 16);
+            }
+            else {
+                transformedTypedData.domain.chainId = parseInt(providedChainId, 10);
+            }
+        }
+        if (transformedTypedData.domain.chainId !== chainId) {
+            throw new JsonRpcError(RpcErrorCode.INVALID_PARAMS, `Invalid chainId, expected ${chainId}`);
+        }
+    }
+    return transformedTypedData;
+};
+const signTypedDataV4 = async ({ params, method, magicProvider, jsonRpcProvider, relayerClient, guardianClient, user, }) => guardianClient
+    .withConfirmationScreen({ width: 480, height: 730 })(async () => {
+    const fromAddress = params[0];
+    const typedDataParam = params[1];
+    if (!fromAddress || !typedDataParam) {
+        throw new JsonRpcError(RpcErrorCode.INVALID_PARAMS, `${method} requires an address and a typed data JSON`);
+    }
+    const { chainId } = await jsonRpcProvider.ready;
+    const typedData = transformTypedData(typedDataParam, chainId);
+    await guardianClient.validateMessage({ chainID: String(chainId), payload: typedData, user });
+    const relayerSignature = await relayerClient.imSignTypedData(fromAddress, typedData);
+    const magicWeb3Provider = new Web3Provider(magicProvider);
+    const signer = magicWeb3Provider.getSigner();
+    return getSignedTypedData(typedData, relayerSignature, BigNumber.from(chainId), fromAddress, signer);
+});
+
 class ZkEvmProvider {
     authManager;
     config;
@@ -7741,6 +8098,21 @@ class ZkEvmProvider {
             case 'eth_accounts': {
                 return this.isLoggedIn() ? [this.user.zkEvm.ethAddress] : [];
             }
+            case 'eth_signTypedData':
+            case 'eth_signTypedData_v4': {
+                if (!this.isLoggedIn()) {
+                    throw new JsonRpcError(ProviderErrorCode.UNAUTHORIZED, 'Unauthorised - call eth_requestAccounts first');
+                }
+                return signTypedDataV4({
+                    method: request.method,
+                    params: request.params || [],
+                    magicProvider: this.magicProvider,
+                    jsonRpcProvider: this.jsonRpcProvider,
+                    relayerClient: this.relayerClient,
+                    user: this.user,
+                    guardianClient: this.guardianClient,
+                });
+            }
             // Pass through methods
             case 'eth_gasPrice':
             case 'eth_getBalance':

package/package.json

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