fix(StarkEx): Revert StarkEx Ethers v6

packages/checkout/sdk/tsup.config.js

@@ -33,7 +33,7 @@ export default defineConfig((options) => {
             Buffer: true,
             process: true,
           },
-          modules: ['crypto', 'buffer', 'process']
+          fallback: 'error'
         }),
         replace({ 
           '__SDK_VERSION__': pkg.version, 

packages/internal/toolkit/package.json

@@ -7,12 +7,14 @@
   "dependencies": {
     "@imtbl/x-client": "workspace:*",
     "@magic-ext/oidc": "12.0.5",
+    "@imtbl/metrics": "workspace:*",
     "@metamask/detect-provider": "^2.0.0",
     "axios": "^1.6.5",
     "bn.js": "^5.2.1",
     "enc-utils": "^3.0.0",
     "ethers": "^6.13.4",
     "magic-sdk": "^29.0.5",
+    "ethers-v5": "npm:ethers@5.7.2",
     "oidc-client-ts": "2.4.0"
   },
   "devDependencies": {

packages/internal/toolkit/src/crypto.ts

@@ -1,6 +1,8 @@
 import BN from 'bn.js';
 import * as encUtils from 'enc-utils';
-import { Signer } from 'ethers';
+import { toUtf8Bytes, Signer } from 'ethers';
+import { Signer as EthersV5Signer } from 'ethers-v5';
+import { track } from '@imtbl/metrics';
 
 type SignatureOptions = {
   r: BN;
@@ -40,9 +42,72 @@ function deserializeSignature(sig: string, size = 64): SignatureOptions {
 
 export async function signRaw(
   payload: string,
-  signer: Signer,
+  signer: Signer | EthersV5Signer,
 ): Promise<string> {
-  const signature = deserializeSignature(await signer.signMessage(payload));
+  const address = await signer.getAddress();
+  track('xProvider', 'log', {
+    address,
+    param: 'signRaw.payload',
+    val: payload,
+  });
+  track('xProvider', 'log', {
+    address,
+    param: 'signRaw.toUtf8Bytes',
+    val: toUtf8Bytes(payload).toString(),
+  });
+  track('xProvider', 'log', {
+    address,
+    param: 'signRaw.payload.normalize() === payload',
+    val: payload === payload.normalize(),
+  });
+
+  // prevent utf-8 encoding issues
+  const encoder = new TextEncoder();
+  const buffer = encoder.encode(payload);
+  // use this message to sign
+  const message = new TextDecoder('utf-8').decode(buffer);
+
+  const buffer2 = Buffer.from(payload, 'utf8');
+  const message2 = new TextDecoder('utf-8').decode(buffer2);
+
+  // compare message utf8 bytes with payload.normalize()
+  track('xProvider', 'log', {
+    address,
+    param: 'signRaw.message === payload.normalize()',
+    val: message === payload.normalize(),
+  });
+  track('xProvider', 'log', {
+    address,
+    param: 'signRaw.message2 === payload.normalize()',
+    val: message2 === payload.normalize(),
+  });
+
+  // output utf8 bytes
+  track('xProvider', 'log', {
+    address,
+    param: 'signRaw.message',
+    val: message,
+    bytes: toUtf8Bytes(message).toString(),
+  });
+  track('xProvider', 'log', {
+    address,
+    param: 'signRaw.message2',
+    val: message2,
+    bytes: toUtf8Bytes(message2).toString(),
+  });
+  // compare utf8 bytes output
+  track('xProvider', 'log', {
+    address,
+    param: 'signRaw.toUtf8Bytes === toUtf8Bytes(message)',
+    val: toUtf8Bytes(payload).toString() === toUtf8Bytes(message).toString(),
+  });
+  track('xProvider', 'log', {
+    address,
+    param: 'signRaw.toUtf8Bytes === toUtf8Bytes(message2)',
+    val: toUtf8Bytes(payload).toString() === toUtf8Bytes(message2).toString(),
+  });
+
+  const signature = deserializeSignature(await signer.signMessage(toUtf8Bytes(message)));
   return serializeEthSignature(signature);
 }
 
@@ -52,7 +117,7 @@ type IMXAuthorisationHeaders = {
 };
 
 export async function generateIMXAuthorisationHeaders(
-  ethSigner: Signer,
+  ethSigner: Signer | EthersV5Signer,
 ): Promise<IMXAuthorisationHeaders> {
   const timestamp = Math.floor(Date.now() / 1000).toString();
   const signature = await signRaw(timestamp, ethSigner);
@@ -65,7 +130,7 @@ export async function generateIMXAuthorisationHeaders(
 
 export async function signMessage(
   message: string,
-  signer: Signer,
+  signer: Signer | EthersV5Signer,
 ): Promise<{ message: string; ethAddress: string; ethSignature: string }> {
   const ethAddress = await signer.getAddress();
   const ethSignature = await signRaw(message, signer);

packages/passport/sdk/jest.setup.js

@@ -1,7 +1,7 @@
-import { TextEncoder } from 'util';
+import { TextEncoder, TextDecoder } from 'util';
 
 global.TextEncoder = TextEncoder;
-
+global.TextDecoder = TextDecoder;
 /**
  * Required for ethers v6
  * @see https://github.com/ethers-io/ethers.js/issues/4365

packages/passport/sdk/package.json

@@ -7,6 +7,8 @@
   "dependencies": {
     "@0xsequence/abi": "^2.0.25",
     "@0xsequence/core": "^2.0.25",
+    "@ethersproject/abstract-provider": "^5.8.0",
+    "@ethersproject/providers": "^5.7.2",
     "@imtbl/config": "workspace:*",
     "@imtbl/generated-clients": "workspace:*",
     "@imtbl/metrics": "workspace:*",
@@ -18,6 +20,7 @@
     "@metamask/detect-provider": "^2.0.0",
     "axios": "^1.6.5",
     "ethers": "^6.13.4",
+    "ethers-v5": "npm:ethers@5.7.2",
     "events": "^3.3.0",
     "jwt-decode": "^3.1.2",
     "localforage": "^1.10.0",

packages/passport/sdk/src/starkEx/getStarkSigner.test.ts

@@ -2,7 +2,7 @@ import {
   createStarkSigner,
   generateLegacyStarkPrivateKey,
 } from '@imtbl/x-client';
-import { ethers } from 'ethers';
+import { ethers } from 'ethers-v5';
 import { getStarkSigner } from './getStarkSigner';
 import { PassportError, PassportErrorType } from '../errors/passportError';
 

packages/passport/sdk/src/starkEx/getStarkSigner.ts

@@ -1,4 +1,4 @@
-import { Signer } from 'ethers';
+import { Signer } from 'ethers-v5';
 import {
   createStarkSigner,
   generateLegacyStarkPrivateKey,

packages/passport/sdk/src/starkEx/passportImxProvider.test.ts

@@ -1,4 +1,5 @@
 import { Environment, ImmutableConfiguration } from '@imtbl/config';
+import { Web3Provider } from '@ethersproject/providers';
 import {
   imx,
   ImxApiClients,
@@ -12,7 +13,6 @@ import {
   UnsignedTransferRequest,
 } from '@imtbl/x-client';
 import { trackError, trackFlow } from '@imtbl/metrics';
-import { BrowserProvider } from 'ethers';
 import registerPassportStarkEx from './workflows/registration';
 import { mockUser, mockUserImx } from '../test/mocks';
 import { PassportError, PassportErrorType } from '../errors/passportError';
@@ -27,10 +27,7 @@ import MagicAdapter from '../magic/magicAdapter';
 import { getStarkSigner } from './getStarkSigner';
 import GuardianClient from '../guardian';
 
-jest.mock('ethers', () => ({
-  ...jest.requireActual('ethers'),
-  BrowserProvider: jest.fn(),
-}));
+jest.mock('@ethersproject/providers');
 jest.mock('./workflows');
 jest.mock('./workflows/registration');
 jest.mock('./getStarkSigner');
@@ -98,7 +95,7 @@ describe('PassportImxProvider', () => {
 
     // Signers
     magicAdapterMock.login.mockResolvedValue({ getSigner: getSignerMock });
-    (BrowserProvider as unknown as jest.Mock).mockReturnValue({ getSigner: getSignerMock });
+    (Web3Provider as unknown as jest.Mock).mockReturnValue({ getSigner: getSignerMock });
     (getStarkSigner as jest.Mock).mockResolvedValue(mockStarkSigner);
 
     passportImxProvider = new PassportImxProvider({
@@ -130,6 +127,9 @@ describe('PassportImxProvider', () => {
     });
 
     it('re-throws the initialisation error when a method is called', async () => {
+      jest.resetAllMocks();
+      jest.restoreAllMocks();
+
       mockAuthManager.getUser.mockResolvedValue(mockUserImx);
       // Signers
       magicAdapterMock.login.mockResolvedValue({});

packages/passport/sdk/src/starkEx/passportImxProvider.ts

@@ -1,3 +1,4 @@
+import { TransactionResponse } from '@ethersproject/abstract-provider';
 import {
   AnyToken,
   EthSigner,
@@ -10,11 +11,11 @@ import {
   UnsignedTransferRequest,
 } from '@imtbl/x-client';
 import { IMXProvider } from '@imtbl/x-provider';
+import { Web3Provider } from '@ethersproject/providers';
 import {
   imx,
   ImxApiClients,
 } from '@imtbl/generated-clients';
-import { BrowserProvider, TransactionResponse } from 'ethers';
 import TypedEventEmitter from '../utils/typedEventEmitter';
 import AuthManager from '../authManager';
 import GuardianClient from '../guardian';
@@ -105,9 +106,9 @@ export class PassportImxProvider implements IMXProvider {
       const user = await this.authManager.getUser();
       // The user will be present because the factory validates it
       const magicRpcProvider = await this.magicAdapter.login(user!.idToken!);
-      const browserProvider = new BrowserProvider(magicRpcProvider);
+      const web3Provider = new Web3Provider(magicRpcProvider);
 
-      const ethSigner = await browserProvider.getSigner();
+      const ethSigner = web3Provider.getSigner();
       const starkSigner = await getStarkSigner(ethSigner);
 
       return { ethSigner, starkSigner };

packages/passport/sdk/src/starkEx/workflows/registerOffchain.test.ts

@@ -1,17 +1,15 @@
+import { Web3Provider } from '@ethersproject/providers';
+import { Signer } from 'ethers-v5';
 import { AxiosError } from 'axios';
 import { ImxApiClients } from '@imtbl/generated-clients';
 import { StarkSigner } from '@imtbl/x-client';
-import { Signer, BrowserProvider } from 'ethers';
 import AuthManager from '../../authManager';
 import { mockUserImx } from '../../test/mocks';
 import registerPassportStarkEx from './registration';
 import { PassportError, PassportErrorType } from '../../errors/passportError';
 import registerOffchain from './registerOffchain';
 
-jest.mock('ethers', () => ({
-  ...jest.requireActual('ethers'),
-  BrowserProvider: jest.fn(),
-}));
+jest.mock('@ethersproject/providers');
 jest.mock('./registration');
 jest.mock('@imtbl/generated-clients');
 
@@ -36,7 +34,7 @@ const mockStarkSigner = {
 const mockReturnHash = '0x123';
 
 mockGetSigner.mockReturnValue(mockEthSigner);
-(BrowserProvider as unknown as jest.Mock).mockReturnValue({
+(Web3Provider as unknown as jest.Mock).mockReturnValue({
   getSigner: mockGetSigner,
 });
 

packages/x-client/package.json

@@ -4,23 +4,31 @@
   "version": "0.0.0",
   "author": "Immutable",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
-  "dependencies": {
-    "@ethereumjs/wallet": "^2.0.4",
+  "dependencies": {    
+    "ethereumjs-wallet": "^1.0.2",
+    "@ethersproject/abi": "^5.7.0",
+    "@ethersproject/abstract-signer": "^5.7.0",
+    "@ethersproject/bytes": "^5.7.0",
+    "@ethersproject/keccak256": "^5.7.0",
+    "@ethersproject/providers": "^5.7.2",
+    "@ethersproject/strings": "^5.7.0",
+    "@ethersproject/wallet": "^5.7.0",
     "@imtbl/config": "workspace:*",
     "@imtbl/generated-clients": "workspace:*",
     "axios": "^1.6.5",
     "bn.js": "^5.2.1",
+    "crypto": "1.0.1",
     "elliptic": "^6.6.1",
     "enc-utils": "^3.0.0",
-    "ethers": "^6.13.4",
+    "ethers-v5": "npm:ethers@5.7.2",
     "hash.js": "^1.1.7"
   },
   "devDependencies": {
     "@swc/core": "^1.3.36",
     "@swc/jest": "^0.2.37",
     "@types/bn.js": "^5.1.6",
     "@types/jest": "^29.4.3",
-    "crypto": "^1.0.1",
+    "assert": "^2.1.0",
     "eslint": "^8.40.0",
     "jest": "^29.4.3",
     "jest-environment-jsdom": "^29.4.3",