Release/sdk v1.0.4

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.0.4] (2024-08-08)
+
+### Added
+
+- support for ethers `AbstractProvider` and `AbstractSigner` in constructor
+
+### Changed
+
+- update `kubo-rpc-client` from v3 to v4
+- update `iexec` and `ethers` dependencies
+
 ## [1.0.3]
 
 ### Changed

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iexec/web3mail",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "This product enables users to confidentially store data–such as mail address, documents, personal information ...",
   "main": "./dist/index.js",
   "type": "module",
@@ -45,10 +45,10 @@
     "@ethersproject/bytes": "^5.7.0",
     "@ethersproject/random": "^5.7.0",
     "buffer": "^6.0.3",
-    "ethers": "^6.8.1",
+    "ethers": "^6.13.2",
     "graphql-request": "^6.1.0",
-    "iexec": "^8.9.1",
-    "kubo-rpc-client": "^3.0.1",
+    "iexec": "^8.10.0",
+    "kubo-rpc-client": "^4.1.1",
     "yup": "^1.1.1"
   },
   "devDependencies": {

src/web3mail/IExecWeb3mail.ts

@@ -1,4 +1,4 @@
-import { Eip1193Provider } from 'ethers';
+import { AbstractProvider, AbstractSigner, Eip1193Provider } from 'ethers';
 import { IExec } from 'iexec';
 import { fetchUserContacts } from './fetchUserContacts.js';
 import { fetchMyContacts } from './fetchMyContacts.js';
@@ -39,7 +39,12 @@ export class IExecWeb3mail {
   private graphQLClient: GraphQLClient;
 
   constructor(
-    ethProvider?: Eip1193Provider | Web3SignerProvider | string,
+    ethProvider?:
+      | Eip1193Provider
+      | AbstractProvider
+      | AbstractSigner
+      | Web3SignerProvider
+      | string,
     options?: Web3MailConfigOptions
   ) {
     try {

tests/e2e/fetchMyContacts.test.ts

@@ -14,6 +14,7 @@ import {
   getTestConfig,
   getTestWeb3SignerProvider,
   getTestIExecOption,
+  waitSubgraphIndexing,
 } from '../test-utils.js';
 import IExec from 'iexec/IExec';
 
@@ -31,6 +32,7 @@ describe('web3mail.fetchMyContacts()', () => {
       data: { email: '[email protected]' },
       name: 'test do not use',
     });
+    await waitSubgraphIndexing();
   }, 2 * MAX_EXPECTED_BLOCKTIME + MAX_EXPECTED_WEB2_SERVICES_TIME);
 
   it(
@@ -119,6 +121,7 @@ describe('web3mail.fetchMyContacts()', () => {
         data: { notemail: 'not email' },
         name: 'test do not use',
       });
+      await waitSubgraphIndexing();
 
       await dataProtector.grantAccess({
         authorizedApp: WEB3_MAIL_DAPP_ADDRESS,

tests/e2e/fetchUserContacts.test.ts

@@ -10,6 +10,7 @@ import {
   MAX_EXPECTED_BLOCKTIME,
   MAX_EXPECTED_WEB2_SERVICES_TIME,
   getTestConfig,
+  waitSubgraphIndexing,
 } from '../test-utils.js';
 
 describe('web3mail.fetchMyContacts()', () => {
@@ -33,6 +34,7 @@ describe('web3mail.fetchMyContacts()', () => {
       data: { email: '[email protected]' },
       name: 'test do not use',
     });
+    await waitSubgraphIndexing();
   }, 4 * MAX_EXPECTED_BLOCKTIME + MAX_EXPECTED_WEB2_SERVICES_TIME);
 
   it(

tests/e2e/sendEmail.test.ts

@@ -19,7 +19,7 @@ import {
   getTestConfig,
   getTestIExecOption,
   getTestWeb3SignerProvider,
-  sleep,
+  waitSubgraphIndexing,
 } from '../test-utils.js';
 import { IExec } from 'iexec';
 
@@ -83,10 +83,8 @@ describe('web3mail.sendEmail()', () => {
       data: { foo: 'bar' },
       name: 'test do not use',
     });
-
+    await waitSubgraphIndexing();
     web3mail = new IExecWeb3mail(...getTestConfig(consumerWallet.privateKey));
-    // avoid race condition with subgraph indexation
-    await sleep(5_000);
   }, 4 * MAX_EXPECTED_BLOCKTIME + MAX_EXPECTED_WEB2_SERVICES_TIME + 5_000);
 
   it(
@@ -112,6 +110,8 @@ describe('web3mail.sendEmail()', () => {
         data: { email: '[email protected]' },
         name: 'test do not use',
       });
+      await waitSubgraphIndexing();
+
       //grant access to whitelist
       await dataProtector.grantAccess({
         authorizedApp: WHITELIST_SMART_CONTRACT_ADDRESS, //whitelist address
@@ -176,13 +176,14 @@ describe('web3mail.sendEmail()', () => {
         data: { email: '[email protected]' },
         name: 'test do not use',
       });
+      await waitSubgraphIndexing();
+
       const params = {
         emailSubject: 'e2e mail object for test',
         emailContent: 'e2e mail content for test',
         protectedData: protectedData.address,
         workerpoolAddressOrEns: workerpoolAddress,
       };
-      await sleep(5_000);
       await expect(web3mail.sendEmail(params)).rejects.toThrow(
         new WorkflowError({
           message: 'Failed to sendEmail',

tests/test-utils.ts

@@ -8,6 +8,8 @@ import { randomInt } from 'crypto';
 
 export const sleep = (ms: number) => new Promise((res) => setTimeout(res, ms));
 
+export const waitSubgraphIndexing = () => sleep(5_000);
+
 export const getRequiredFieldMessage = (field: string = 'this') =>
   `${field} is a required field`;