feat(sendTelegram): add allowDeposit parameter to enable automatic deposit

- Add allowDeposit optional parameter to SendTelegramParams type
- Add allowDeposit parameter to sendTelegram function with default value false
- Pass allowDeposit to matchOrders call
- Add e2e tests for allowDeposit feature

This feature allows users to automatically deposit funds when their balance
is insufficient to cover the task cost.

Author: abbesBenayache

src/web3telegram/sendTelegram.ts

@@ -50,6 +50,7 @@ export const sendTelegram = async ({
   workerpoolMaxPrice = MAX_DESIRED_WORKERPOOL_ORDER_PRICE,
   protectedData,
   useVoucher = false,
+  allowDeposit = false,
 }: IExecConsumer &
   SubgraphConsumer &
   DappAddressConsumer &
@@ -94,6 +95,9 @@ export const sendTelegram = async ({
     const vUseVoucher = booleanSchema()
       .label('useVoucher')
       .validateSync(useVoucher);
+    const vAllowDeposit = booleanSchema()
+      .label('allowDeposit')
+      .validateSync(allowDeposit);
 
     // Check protected data validity through subgraph
     const isValidProtectedData = await checkProtectedDataValidity(
@@ -286,7 +290,10 @@ export const sendTelegram = async ({
         workerpoolorder: workerpoolorder,
         requestorder: requestorder,
       },
-      { useVoucher: vUseVoucher }
+      // TODO: Remove @ts-ignore once iexec SDK is updated to a version that includes allowDeposit in matchOrders types
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-ignore - allowDeposit is supported at runtime but not yet in TypeScript types
+      { useVoucher: vUseVoucher, allowDeposit: vAllowDeposit }
     );
     const taskId = await iexec.deal.computeTaskId(dealId, 0);
     return {

src/web3telegram/types.ts

@@ -77,6 +77,7 @@ export type SendTelegramParams = {
   appMaxPrice?: number;
   workerpoolMaxPrice?: number;
   useVoucher?: boolean;
+  allowDeposit?: boolean;
 };
 
 export type SendTelegramResponse = {

tests/e2e/sendTelegram.test.ts

@@ -46,14 +46,14 @@ describe('web3telegram.sendTelegram()', () => {
   const iexecOptions = getTestIExecOption();
   const prodWorkerpoolPublicPrice = 1000;
   const defaultConfig = getChainDefaultConfig(DEFAULT_CHAIN_ID);
-
+  const workerpoolprice = 1_000;
   beforeAll(async () => {
     // (default) prod workerpool (not free) always available
     await createAndPublishWorkerpoolOrder(
       TEST_CHAIN.prodWorkerpool,
       TEST_CHAIN.prodWorkerpoolOwnerWallet,
       NULL_ADDRESS,
-      1_000,
+      workerpoolprice,
       prodWorkerpoolPublicPrice
     );
     // learn prod pool (free) assumed always available
@@ -613,4 +613,75 @@ describe('web3telegram.sendTelegram()', () => {
       });
     });
   });
+
+  describe('allowDeposit', () => {
+    let protectData: ProtectedDataWithSecretProps;
+    consumerWallet = getRandomWallet();
+    const dataPricePerAccess = 1000;
+    let web3telegramConsumerInstance: IExecWeb3telegram;
+    beforeAll(async () => {
+      protectData = await dataProtector.protectData({
+        data: { telegram_chatId: '12345' },
+        name: 'test do not use',
+      });
+      await dataProtector.grantAccess({
+        authorizedApp: getChainDefaultConfig(DEFAULT_CHAIN_ID).dappAddress,
+        protectedData: protectData.address,
+        authorizedUser: consumerWallet.address, // consumer wallet
+        numberOfAccess: 1000,
+        pricePerAccess: dataPricePerAccess,
+      });
+      await waitSubgraphIndexing();
+      web3telegramConsumerInstance = new IExecWeb3telegram(
+        ...getTestConfig(consumerWallet.privateKey)
+      );
+    }, 2 * MAX_EXPECTED_BLOCKTIME);
+    it(
+      'should throw error if insufficient total balance to cover task cost and allowDeposit is false',
+      async () => {
+        let error;
+        try {
+          await web3telegramConsumerInstance.sendTelegram({
+            telegramContent: 'e2e telegram content for test',
+            protectedData: protectData.address,
+            dataMaxPrice: dataPricePerAccess,
+            workerpoolMaxPrice: workerpoolprice,
+            allowDeposit: false,
+          });
+        } catch (err) {
+          error = err;
+        }
+        expect(error).toBeInstanceOf(Web3TelegramWorkflowError);
+        expect(error).toBeInstanceOf(Error);
+        expect(error.message).toBe('Failed to sendTelegram');
+        const causeMsg =
+          error.errorCause?.message ||
+          error.cause?.message ||
+          error.cause ||
+          error.errorCause;
+        expect(causeMsg).toBe(
+          `Cost per task (${
+            dataPricePerAccess + workerpoolprice
+          }) is greater than requester account stake (0). Orders can't be matched. If you are the requester, you should deposit to top up your account`
+        );
+      },
+      3 * MAX_EXPECTED_BLOCKTIME + MAX_EXPECTED_WEB2_SERVICES_TIME
+    );
+    it(
+      'should send telegram after depositing sufficient funds to cover task cost when allowDeposit is true',
+      async () => {
+        const result = await web3telegramConsumerInstance.sendTelegram({
+          telegramContent: 'e2e telegram content for test',
+          protectedData: protectData.address,
+          dataMaxPrice: dataPricePerAccess,
+          workerpoolMaxPrice: workerpoolprice,
+          allowDeposit: true,
+        });
+        expect(result).toBeDefined();
+        expect(result).toHaveProperty('taskId');
+        expect(result).toHaveProperty('dealId');
+      },
+      3 * MAX_EXPECTED_BLOCKTIME + MAX_EXPECTED_WEB2_SERVICES_TIME
+    );
+  });
 });