Merge pull request #27 from iExecBlockchainComputing/release/sdk-v0.0.3-alpha

Release/sdk v0.0.3 alpha

Author: abbesBenayache

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.0.3-alpha] - 2025-04-04
+
+### Changed
+
+- Migrated the iApp codebase to ES Modules (ESM).
+- Migrated Bellecour subgraph URL to `https://thegraph.iex.ec`.
+
 ## [0.0.2-alpha] - 2025-03-11
 
 ### Changed

dapp/.eslintrc.json

@@ -2,7 +2,7 @@
   "root": true,
   "plugins": ["import", "sonarjs"],
   "parserOptions": {
-    "ecmaVersion": 2020
+    "ecmaVersion": 2022
   },
   "extends": ["airbnb-base", "prettier", "plugin:sonarjs/recommended"],
   "rules": {

dapp/jest.config.js

@@ -0,0 +1,6 @@
+export default {
+  transform: {},
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+};

dapp/package.json

@@ -3,6 +3,7 @@
   "version": "0.0.2-alpha",
   "description": "",
   "main": "index.js",
+  "type": "module",
   "engines": {
     "node": ">=14.0.0 <15.0.0",
     "npm": ">=6.0.0 <7.0.0"
@@ -38,4 +39,4 @@
     "jest": "^29.7.0",
     "prettier": "^2.8.8"
   }
-}
+}

dapp/src/app.js

@@ -1,4 +1,4 @@
-const start = require('./executeTask');
+import start from './executeTask';
 
 start().catch((error) => {
   console.error(`Error: ${error.message}`);

dapp/src/decryptContent.js

@@ -1,10 +1,10 @@
-const { Buffer } = require('buffer');
-const forge = require('node-forge');
-const fetch = require('node-fetch');
+import { Buffer } from 'buffer';
+import fetch from 'node-fetch';
+import forge from 'node-forge';
 
 const DEFAULT_IPFS_GATEWAY = 'https://ipfs-gateway.v8-bellecour.iex.ec';
 
-const downloadEncryptedContent = async (
+export const downloadEncryptedContent = async (
   multiaddr,
   { ipfsGateway = DEFAULT_IPFS_GATEWAY } = {}
 ) => {
@@ -22,7 +22,7 @@ const downloadEncryptedContent = async (
   }
 };
 
-const decryptContent = (encryptedContent, encryptionKey) => {
+export const decryptContent = (encryptedContent, encryptionKey) => {
   const ivBytes = encryptedContent.slice(0, 16);
   let ciphertextBytes = encryptedContent.slice(16);
   const key = forge.util.createBuffer(Buffer.from(encryptionKey, 'base64'));
@@ -53,5 +53,3 @@ const decryptContent = (encryptedContent, encryptionKey) => {
 
   return decryptedBuffer.toString();
 };
-
-module.exports = { downloadEncryptedContent, decryptContent };

dapp/src/executeTask.js

@@ -1,18 +1,13 @@
-const { promises: fs } = require('fs');
-const {
-  IExecDataProtectorDeserializer,
-} = require('@iexec/dataprotector-deserializer');
-const sendTelegram = require('./telegramService');
-const {
-  validateWorkerEnv,
+import { IExecDataProtectorDeserializer } from '@iexec/dataprotector-deserializer';
+import { promises as fs } from 'fs';
+import { decryptContent, downloadEncryptedContent } from './decryptContent';
+import sendTelegram from './telegramService';
+import {
   validateAppSecret,
-  validateRequesterSecret,
   validateProtectedData,
-} = require('./validation');
-const {
-  downloadEncryptedContent,
-  decryptContent,
-} = require('./decryptContent');
+  validateRequesterSecret,
+  validateWorkerEnv,
+} from './validation';
 
 async function writeTaskOutput(path, message) {
   try {
@@ -30,7 +25,6 @@ async function start() {
 
   // Check worker env
   const workerEnv = validateWorkerEnv({ IEXEC_OUT });
-
   // Parse the app developer secret environment variable
   let appDeveloperSecret;
   try {
@@ -51,7 +45,7 @@ async function start() {
   }
   requesterSecret = validateRequesterSecret(requesterSecret);
 
-  // parse the protected data and get the requester secret (chatId)
+  // Parse the protected data and get the requester secret (chatId)
   let protectedData;
   try {
     const deserializer = new IExecDataProtectorDeserializer();
@@ -61,7 +55,7 @@ async function start() {
   } catch (e) {
     throw Error(`Failed to parse ProtectedData: ${e.message}`);
   }
-  // validate the protected data (chatId)
+  // Validate the protected data (chatId)
   validateProtectedData(protectedData);
 
   const encryptedTelegramContent = await downloadEncryptedContent(
@@ -79,7 +73,6 @@ async function start() {
     botToken: appDeveloperSecret.TELEGRAM_BOT_TOKEN,
     senderName: requesterSecret.senderName,
   });
-
   await writeTaskOutput(
     `${workerEnv.IEXEC_OUT}/result.txt`,
     JSON.stringify(response, null, 2)
@@ -92,4 +85,4 @@ async function start() {
   );
 }
 
-module.exports = start;
+export default start;

dapp/src/telegramService.js

@@ -1,4 +1,4 @@
-const TelegramBot = require('node-telegram-bot-api');
+import TelegramBot from 'node-telegram-bot-api';
 
 async function sendTelegram({
   chatId,
@@ -35,4 +35,4 @@ async function sendTelegram({
   };
 }
 
-module.exports = sendTelegram;
+export default sendTelegram;

dapp/src/validation.js

@@ -1,10 +1,10 @@
-const Joi = require('joi');
+import Joi from 'joi';
 
 const workerEnvSchema = Joi.object({
   IEXEC_OUT: Joi.string().required(),
 });
 
-function validateWorkerEnv(envVars) {
+export function validateWorkerEnv(envVars) {
   const { error, value } = workerEnvSchema.validate(envVars, {
     abortEarly: false,
   });
@@ -19,7 +19,7 @@ const appSecretSchema = Joi.object({
   TELEGRAM_BOT_TOKEN: Joi.string().required(),
 });
 
-function validateAppSecret(obj) {
+export function validateAppSecret(obj) {
   const { error, value } = appSecretSchema.validate(obj, {
     abortEarly: false,
   });
@@ -42,7 +42,7 @@ const protectedDataChatIdSchema = Joi.object({
     .required(),
 });
 
-function validateProtectedData(obj) {
+export function validateProtectedData(obj) {
   const { error, value } = protectedDataChatIdSchema.validate(obj, {
     abortEarly: false,
   });
@@ -62,7 +62,7 @@ const requesterSecretSchema = Joi.object({
   senderName: Joi.string().min(3).max(20),
 });
 
-function validateRequesterSecret(obj) {
+export function validateRequesterSecret(obj) {
   const { error, value } = requesterSecretSchema.validate(obj, {
     abortEarly: false,
   });
@@ -72,10 +72,3 @@ function validateRequesterSecret(obj) {
   }
   return value;
 }
-
-module.exports = {
-  validateWorkerEnv,
-  validateAppSecret,
-  validateRequesterSecret,
-  validateProtectedData,
-};