test(sdk): add arweave upload stub server

Author: PierreJeanjacquot

packages/sdk/package-lock.json

@@ -73,6 +73,7 @@
     "@swc/core": "^1.7.3",
     "@swc/jest": "^0.2.36",
     "@types/debug": "^4.1.7",
+    "@types/express": "^5.0.2",
     "@types/jest": "^29.5.12",
     "@typescript-eslint/eslint-plugin": "^6.7.5",
     "@typescript-eslint/parser": "^6.7.5",
@@ -85,6 +86,7 @@
     "eslint-plugin-jest": "^27.4.2",
     "eslint-plugin-sonarjs": "^0.21.0",
     "eslint-plugin-unicorn": "^51.0.1",
+    "express": "^5.1.0",
     "jest": "^29.7.0",
     "prettier": "^2.8.4",
     "rimraf": "^5.0.5",

packages/sdk/package.json

@@ -1,7 +1,7 @@
 import { AbstractProvider, AbstractSigner, Eip1193Provider } from 'ethers';
 import { GraphQLClient } from 'graphql-request';
 import { IExec } from 'iexec';
-import { CHAIN_CONFIG } from '../config/config.js';
+import { CHAIN_CONFIG, DEFAULT_ARWEAVE_UPLOAD_API } from '../config/config.js';
 import { getChainIdFromProvider } from '../utils/getChainId.js';
 import {
   AddressOrENS,
@@ -38,6 +38,8 @@ abstract class IExecDataProtectorModule {
 
   protected ipfsGateway!: string;
 
+  protected arweaveUploadApi: string = DEFAULT_ARWEAVE_UPLOAD_API;
+
   protected defaultWorkerpool!: string;
 
   protected iexec!: IExec;

packages/sdk/src/lib/IExecDataProtectorModule.ts

@@ -39,6 +39,7 @@ class IExecDataProtectorCore extends IExecDataProtectorModule {
       dataprotectorContractAddress: this.dataprotectorContractAddress,
       ipfsNode: this.ipfsNode,
       ipfsGateway: this.ipfsGateway,
+      arweaveUploadApi: this.arweaveUploadApi,
       iexec: this.iexec,
       iexecDebug: this.iexecDebug,
     });

packages/sdk/src/lib/dataProtectorCore/IExecDataProtectorCore.ts

@@ -32,6 +32,7 @@ import {
   ProtectedDataWithSecretProps,
 } from '../types/index.js';
 import {
+  ArweaveUploadConsumer,
   DataProtectorContractConsumer,
   IExecConsumer,
   IExecDebugConsumer,
@@ -50,13 +51,15 @@ export const protectData = async ({
   uploadMode = 'ipfs',
   ipfsNode,
   ipfsGateway,
+  arweaveUploadApi,
   allowDebug = false,
   data,
   onStatusUpdate = () => {},
 }: IExecConsumer &
   IExecDebugConsumer &
   DataProtectorContractConsumer &
   IpfsNodeAndGateway &
+  ArweaveUploadConsumer &
   ProtectDataParams): Promise<ProtectedDataWithSecretProps> => {
   const vName = stringSchema().label('name').validateSync(name);
   const vUploadMode = stringSchema()
@@ -163,12 +166,14 @@ export const protectData = async ({
     let multiaddrBytes: Uint8Array;
 
     if (vUploadMode === 'arweave') {
-      const arweaveId = await arweave.add(encryptedFile).catch((e: Error) => {
-        throw new WorkflowError({
-          message: 'Failed to upload encrypted data',
-          errorCause: e,
+      const arweaveId = await arweave
+        .add(encryptedFile, { arweaveUploadApi })
+        .catch((e: Error) => {
+          throw new WorkflowError({
+            message: 'Failed to upload encrypted data',
+            errorCause: e,
+          });
         });
-      });
       multiaddr = `${DEFAULT_ARWEAVE_GATEWAY}/${arweaveId}`;
       multiaddrBytes = new TextEncoder().encode(multiaddr);
       vOnStatusUpdate({

packages/sdk/src/lib/dataProtectorCore/protectData.ts

@@ -17,6 +17,10 @@ export type DataProtectorContractConsumer = {
   dataprotectorContractAddress: AddressOrENS;
 };
 
+export type ArweaveUploadConsumer = {
+  arweaveUploadApi?: string;
+};
+
 export type SubgraphConsumer = {
   graphQLClient: GraphQLClient;
 };

packages/sdk/src/lib/types/internalTypes.ts

@@ -14,6 +14,10 @@ import {
   getTestRpcProvider,
   getTestWeb3SignerProvider,
 } from '../../test-utils.js';
+import {
+  getArweaveUploadStubServer,
+  ArweaveUploadStubServer,
+} from '../../utils/arweaveUploadApi.js';
 
 describe('dataProtectorCore.protectData()', () => {
   let dataProtectorCore: IExecDataProtectorCore;
@@ -224,6 +228,13 @@ describe('dataProtectorCore.protectData()', () => {
 
   // TODO use a local service for Arweave upload API
   describe('when `uploadMode: "arweave"`', () => {
+    let arweaveUploadServerStub: ArweaveUploadStubServer;
+    beforeAll(async () => {
+      arweaveUploadServerStub = await getArweaveUploadStubServer();
+    });
+    afterAll(async () => {
+      await arweaveUploadServerStub.stop();
+    });
     it(
       'creates the protected data',
       async () => {
@@ -277,6 +288,12 @@ describe('dataProtectorCore.protectData()', () => {
           },
         };
 
+        // override protected property to use stub server
+        dataProtectorCore[
+          // eslint-disable-next-line @typescript-eslint/dot-notation
+          'arweaveUploadApi'
+        ] = arweaveUploadServerStub.url;
+
         const result = await dataProtectorCore.protectData({
           data,
           uploadMode: 'arweave',
@@ -292,7 +309,6 @@ describe('dataProtectorCore.protectData()', () => {
         expect(typeof result.encryptionKey).toBe('string');
         expect(typeof result.multiaddr).toBe('string');
         expect(result.multiaddr.startsWith(DEFAULT_ARWEAVE_GATEWAY)).toBe(true);
-        console.log(result.multiaddr);
 
         const ethProvider = getTestRpcProvider();
         const iexecOptions = getTestIExecOption();

packages/sdk/tests/e2e/dataProtectorCore/protectData.test.ts

@@ -0,0 +1,43 @@
+import { AddressInfo } from 'net';
+import express from 'express';
+
+// stub for https://github.com/iExecBlockchainComputing/iexec-arweave-api
+const app = express();
+app.use('/upload', (req, res) => {
+  const fileId = 'd1BnXCOft0eM8usWdgd172zLaktRTmjmTp2RoX-Gb1M';
+  res
+    .status(200)
+    .json({ arweaveId: fileId, url: `https://arweave.net/${fileId}` });
+});
+
+export type ArweaveUploadStubServer = {
+  url: string;
+  stop: () => Promise<void>;
+};
+
+export const getArweaveUploadStubServer: () => Promise<ArweaveUploadStubServer> =
+  async () =>
+    new Promise((resolve, reject) => {
+      const server = app.listen((listenErr) => {
+        if (listenErr) {
+          reject(listenErr);
+        } else {
+          const addressInfo = server.address() as AddressInfo;
+          const url = `http://127.0.0.1:${addressInfo.port}`;
+          const stop = () =>
+            new Promise<void>((res, rej) =>
+              server.close((closeErr) => {
+                if (closeErr) {
+                  rej(closeErr);
+                } else {
+                  res();
+                }
+              })
+            );
+          resolve({
+            url,
+            stop,
+          });
+        }
+      });
+    });