Merge pull request #299 from iExecBlockchainComputing/feature/detect-user-rejection

PierreJeanjacquot · web-flow · commit 82cdac70f18c · 2024-11-20T11:49:16.000+01:00
added Web3ProviderError.isUserRejection
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 ## Next
 
+### Added
+
+- added key `isUserRejection` in `Web3ProviderError` set to `true` when the error is detected as a user rejection
+
 ### Changed
 
 - `iexec_result_storage_proxy` default value is no more set in request params
diff --git a/docs/classes/errors.Web3ProviderCallError.md b/docs/classes/errors.Web3ProviderCallError.md
@@ -21,6 +21,7 @@ Web3ProviderCallError encapsulates an error thrown by the web3 provider during a
 ### Properties
 
 - [cause](errors.Web3ProviderCallError.md#cause)
+- [isUserRejection](errors.Web3ProviderCallError.md#isuserrejection)
 - [originalError](errors.Web3ProviderCallError.md#originalerror)
 
 ## Constructors
@@ -58,6 +59,18 @@ The original Error object that caused this web3 provider error.
 
 ___
 
+### isUserRejection
+
+• `Optional` **isUserRejection**: `boolean`
+
+Wether the error was caused by a user rejection
+
+#### Inherited from
+
+[Web3ProviderError](errors.Web3ProviderError.md).[isUserRejection](errors.Web3ProviderError.md#isuserrejection)
+
+___
+
 ### originalError
 
 • **originalError**: `Error`
diff --git a/docs/classes/errors.Web3ProviderError.md b/docs/classes/errors.Web3ProviderError.md
@@ -27,6 +27,7 @@ Web3ProviderError encapsulates an error thrown by the web3 provider.
 ### Properties
 
 - [cause](errors.Web3ProviderError.md#cause)
+- [isUserRejection](errors.Web3ProviderError.md#isuserrejection)
 - [originalError](errors.Web3ProviderError.md#originalerror)
 
 ## Constructors
@@ -60,6 +61,14 @@ The original Error object that caused this web3 provider error.
 
 ___
 
+### isUserRejection
+
+• `Optional` **isUserRejection**: `boolean`
+
+Wether the error was caused by a user rejection
+
+___
+
 ### originalError
 
 • **originalError**: `Error`
diff --git a/docs/classes/errors.Web3ProviderSendError.md b/docs/classes/errors.Web3ProviderSendError.md
@@ -21,6 +21,7 @@ Web3ProviderSendError encapsulates an error thrown by the web3 provider during a
 ### Properties
 
 - [cause](errors.Web3ProviderSendError.md#cause)
+- [isUserRejection](errors.Web3ProviderSendError.md#isuserrejection)
 - [originalError](errors.Web3ProviderSendError.md#originalerror)
 
 ## Constructors
@@ -58,6 +59,18 @@ The original Error object that caused this web3 provider error.
 
 ___
 
+### isUserRejection
+
+• `Optional` **isUserRejection**: `boolean`
+
+Wether the error was caused by a user rejection
+
+#### Inherited from
+
+[Web3ProviderError](errors.Web3ProviderError.md).[isUserRejection](errors.Web3ProviderError.md#isuserrejection)
+
+___
+
 ### originalError
 
 • **originalError**: `Error`
diff --git a/docs/classes/errors.Web3ProviderSignMessageError.md b/docs/classes/errors.Web3ProviderSignMessageError.md
@@ -21,6 +21,7 @@ Web3ProviderSignMessageError encapsulates an error thrown by the web3 provider d
 ### Properties
 
 - [cause](errors.Web3ProviderSignMessageError.md#cause)
+- [isUserRejection](errors.Web3ProviderSignMessageError.md#isuserrejection)
 - [originalError](errors.Web3ProviderSignMessageError.md#originalerror)
 
 ## Constructors
@@ -58,6 +59,18 @@ The original Error object that caused this web3 provider error.
 
 ___
 
+### isUserRejection
+
+• `Optional` **isUserRejection**: `boolean`
+
+Wether the error was caused by a user rejection
+
+#### Inherited from
+
+[Web3ProviderError](errors.Web3ProviderError.md).[isUserRejection](errors.Web3ProviderError.md#isuserrejection)
+
+___
+
 ### originalError
 
 • **originalError**: `Error`
diff --git a/src/common/utils/errors.js b/src/common/utils/errors.js
@@ -29,6 +29,10 @@ export class Web3ProviderError extends Error {
     if (originalError && typeof originalError === 'object') {
       Object.assign(this, getPropsToCopy(originalError));
     }
+    // detect user rejection from ethers error code
+    if (originalError?.code === 'ACTION_REJECTED') {
+      this.isUserRejection = true;
+    }
   }
 }
 
diff --git a/src/lib/errors.d.ts b/src/lib/errors.d.ts
@@ -29,6 +29,10 @@ export class Web3ProviderError extends Error {
    * The original Error object that caused this web3 provider error.
    */
   cause: Error;
+  /**
+   * Wether the error was caused by a user rejection
+   */
+  isUserRejection?: boolean;
 }
 /**
  * Web3ProviderCallError encapsulates an error thrown by the web3 provider during a web3 call.
diff --git a/test/lib/unit/errorWrappers.test.js b/test/lib/unit/errorWrappers.test.js
@@ -0,0 +1,128 @@
+// @jest/global comes with jest
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { describe, test, expect } from '@jest/globals';
+import { BrowserProvider } from 'ethers';
+import {
+  getRandomWallet,
+  InjectedProvider,
+  NULL_ADDRESS,
+} from '../../test-utils.js';
+import {
+  wrapPersonalSign,
+  wrapSignTypedData,
+  wrapSend,
+} from '../../../src/common/utils/errorWrappers.js';
+import {
+  Web3ProviderSendError,
+  Web3ProviderSignMessageError,
+} from '../../../src/lib/errors.js';
+
+describe('wrapPersonalSign', () => {
+  test('detects user signature rejection', async () => {
+    const userRejectSigner = await new BrowserProvider(
+      new InjectedProvider(
+        'https://bellecour.iex.ec',
+        getRandomWallet().privateKey,
+        {
+          mockUserRejection: true,
+        },
+      ),
+    ).getSigner();
+    const rejectError = await wrapPersonalSign(
+      userRejectSigner.signMessage('foo'),
+    ).catch((e) => e);
+    expect(rejectError).toBeInstanceOf(Web3ProviderSignMessageError);
+    expect(rejectError.isUserRejection).toBe(true);
+
+    const errorSigner = await new BrowserProvider(
+      new InjectedProvider(
+        'https://bellecour.iex.ec',
+        getRandomWallet().privateKey,
+        {
+          mockError: true,
+        },
+      ),
+    ).getSigner();
+    const unknownError = await wrapPersonalSign(
+      errorSigner.signMessage('foo'),
+    ).catch((e) => e);
+    expect(unknownError).toBeInstanceOf(Web3ProviderSignMessageError);
+    expect(unknownError.isUserRejection).toBe(undefined);
+  });
+});
+
+describe('wrapSignTypedData', () => {
+  test('detects user signature rejection', async () => {
+    const userRejectSigner = await new BrowserProvider(
+      new InjectedProvider(
+        'https://bellecour.iex.ec',
+        getRandomWallet().privateKey,
+        {
+          mockUserRejection: true,
+        },
+      ),
+    ).getSigner();
+    const rejectError = await wrapSignTypedData(
+      userRejectSigner.signTypedData(
+        { name: 'domain' },
+        { custom: [{ name: 'foo', type: 'string' }] },
+        { foo: 'bar' },
+      ),
+    ).catch((e) => e);
+    expect(rejectError).toBeInstanceOf(Web3ProviderSignMessageError);
+    expect(rejectError.isUserRejection).toBe(true);
+
+    const errorSigner = await new BrowserProvider(
+      new InjectedProvider(
+        'https://bellecour.iex.ec',
+        getRandomWallet().privateKey,
+        {
+          mockError: true,
+        },
+      ),
+    ).getSigner();
+    const unknownError = await wrapSignTypedData(
+      errorSigner.signTypedData(
+        { name: 'domain' },
+        { custom: [{ name: 'foo', type: 'string' }] },
+        { foo: 'bar' },
+      ),
+    ).catch((e) => e);
+    expect(unknownError).toBeInstanceOf(Web3ProviderSignMessageError);
+    expect(unknownError.isUserRejection).toBe(undefined);
+  });
+});
+
+describe('wrapSend', () => {
+  test('detects user signature rejection', async () => {
+    const userRejectSigner = await new BrowserProvider(
+      new InjectedProvider(
+        'https://bellecour.iex.ec',
+        getRandomWallet().privateKey,
+        {
+          mockUserRejection: true,
+        },
+      ),
+    ).getSigner();
+    const rejectError = await wrapSend(
+      userRejectSigner.sendTransaction({ to: NULL_ADDRESS }),
+    ).catch((e) => e);
+    expect(rejectError).toBeInstanceOf(Web3ProviderSendError);
+    expect(rejectError.isUserRejection).toBe(true);
+
+    const errorSigner = await new BrowserProvider(
+      new InjectedProvider(
+        'https://bellecour.iex.ec',
+        getRandomWallet().privateKey,
+        {
+          mockError: true,
+        },
+      ),
+    ).getSigner();
+    const unknownError = await wrapSend(
+      errorSigner.sendTransaction({ to: NULL_ADDRESS }),
+    ).catch((e) => e);
+    expect(unknownError).toBeInstanceOf(Web3ProviderSendError);
+    expect(unknownError.isUserRejection).toBe(undefined);
+  });
+});
diff --git a/test/test-utils.js b/test/test-utils.js
@@ -148,53 +148,56 @@ export const getRandomAddress = () => getRandomWallet().address;
 
 export const getRandomBytes32 = () => hexlify(randomBytes(32));
 export class InjectedProvider {
-  constructor(rpcUrl, privateKey) {
-    this.signer = new Wallet(
-      privateKey,
-      new JsonRpcProvider(rpcUrl, undefined, { pollingInterval: 100 }), // fast polling for tests
-    );
+  constructor(rpcUrl, privateKey, { mockUserRejection, mockError } = {}) {
+    this.provider = new JsonRpcProvider(rpcUrl, undefined, {
+      pollingInterval: 100,
+    }); // fast polling for tests
+    this.signer = new Wallet(privateKey, this.provider);
+    this.mockUserRejection = mockUserRejection;
+    this.mockError = mockError;
   }
 
   async request(args) {
     const { method, params } = args;
-    let rpcPromise;
     switch (method) {
       case 'eth_requestAccounts':
       case 'eth_accounts':
-        rpcPromise = Promise.resolve([this.signer.address]);
-        break;
+        return Promise.resolve([this.signer.address]);
       case 'eth_chainId':
-        rpcPromise = this.signer.provider
+        return this.provider
           .getNetwork()
           .then((network) => network.chainId.toString());
-        break;
+      case 'eth_blockNumber':
+        return this.provider.getBlockNumber();
       case 'personal_sign':
-        rpcPromise = this.signer.signMessage(params[0]);
-        break;
+        if (this.mockError) return Promise.reject(Error('error'));
+        if (this.mockUserRejection) return Promise.reject(Error('user denied'));
+        return this.signer.signMessage(params[0]);
       case 'eth_signTypedData_v3':
       case 'eth_signTypedData_v4':
-        rpcPromise = (async () => {
+        if (this.mockError) return Promise.reject(Error('error'));
+        if (this.mockUserRejection) return Promise.reject(Error('user denied'));
+        return (async () => {
           const typedData = JSON.parse(params[1]);
           const { EIP712Domain, ...types } = typedData.types;
           const { message, domain } = typedData;
           return this.signer.signTypedData(domain, types, message);
         })();
-        break;
       case 'eth_call':
-        rpcPromise = this.provider.call(params[0]);
-        break;
+        return this.provider.call(params[0]);
+      case 'eth_estimateGas':
+        return this.provider.estimateGas(params[0]);
       case 'eth_sendTransaction':
-        rpcPromise = (async () => {
+        if (this.mockError) return Promise.reject(Error('error'));
+        if (this.mockUserRejection) return Promise.reject(Error('user denied'));
+        return (async () => {
           const { gas, ...gasStripped } = params[0];
           const transaction = await this.signer.sendTransaction(gasStripped);
           return transaction.hash;
         })();
-        break;
       default:
-        rpcPromise = Promise.reject(Error('not implemented'));
-        break;
+        return Promise.reject(Error('not implemented'));
     }
-    return rpcPromise;
   }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,10 @@ export class Web3ProviderError extends Error {`
`29`	`29`	`if (originalError && typeof originalError === 'object') {`
`30`	`30`	`Object.assign(this, getPropsToCopy(originalError));`
`31`	`31`	`}`
	`32`	`+ // detect user rejection from ethers error code`
	`33`	`+ if (originalError?.code === 'ACTION_REJECTED') {`
	`34`	`+ this.isUserRejection = true;`
	`35`	`+ }`
`32`	`36`	`}`
`33`	`37`	`}`
`34`	`38`