ES module error on aa-alchemy on latest recent versions

[HatimPatwa]

I am constantly getting below error when using latest versions of aa-alchemy

ts-node-dev ver. 2.0.0 (using ts-node ver. 10.9.2, typescript ver. 5.3.3)
Error [ERR_REQUIRE_ESM]: require() of ES Module /home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/@wagmi/core/dist/esm/exports/index.js from /home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/@alchemy/aa-alchemy/dist/cjs/config/utils/cookies.js not supported.
Instead change the require of index.js in /home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/@alchemy/aa-alchemy/dist/cjs/config/utils/cookies.js to a dynamic import() which is available in all CommonJS modules.
    at require.extensions..jsx.require.extensions..js (/tmp/ts-node-dev-hook-5656836233995166.js:114:20)
    at Object.nodeDevHook [as .js] (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/ts-node-dev/lib/hook.js:63:13)
    at Object.<anonymous> (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/@alchemy/aa-alchemy/dist/cjs/config/utils/cookies.js:7:16)
    at Module._compile (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/source-map-support/source-map-support.js:568:25)
    at require.extensions..jsx.require.extensions..js (/tmp/ts-node-dev-hook-5656836233995166.js:114:20)
    at Object.nodeDevHook [as .js] (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/ts-node-dev/lib/hook.js:63:13)
    at Object.<anonymous> (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/@alchemy/aa-alchemy/dist/cjs/signer/index.js:9:20)
    at Module._compile (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/source-map-support/source-map-support.js:568:25)
    at require.extensions..jsx.require.extensions..js (/tmp/ts-node-dev-hook-5656836233995166.js:114:20)
    at Object.nodeDevHook [as .js] (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/ts-node-dev/lib/hook.js:63:13)
    at Object.<anonymous> (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/@alchemy/aa-alchemy/dist/cjs/index.js:40:18)
    at Module._compile (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/source-map-support/source-map-support.js:568:25)
    at require.extensions..jsx.require.extensions..js (/tmp/ts-node-dev-hook-5656836233995166.js:114:20)
    at Object.nodeDevHook [as .js] (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/ts-node-dev/lib/hook.js:63:13)
    at Object.<anonymous> (/home/hatimpatwa/Hatim/race/Race-wallet/backend/src/services/wallet.service.ts:9:22)
    at Module._compile (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/source-map-support/source-map-support.js:568:25)
    at m._compile (/tmp/ts-node-dev-hook-5656836233995166.js:69:33)
    at require.extensions..jsx.require.extensions..js (/tmp/ts-node-dev-hook-5656836233995166.js:114:20)
    at require.extensions.<computed> (/tmp/ts-node-dev-hook-5656836233995166.js:71:20)
    at Object.nodeDevHook [as .ts] (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/ts-node-dev/lib/hook.js:63:13)
    at Object.<anonymous> (/home/hatimpatwa/Hatim/race/Race-wallet/backend/src/controllers/wallet.controller.ts:7:42)
    at Module._compile (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/source-map-support/source-map-support.js:568:25)
    at m._compile (/tmp/ts-node-dev-hook-5656836233995166.js:69:33)
    at require.extensions..jsx.require.extensions..js (/tmp/ts-node-dev-hook-5656836233995166.js:114:20)
    at require.extensions.<computed> (/tmp/ts-node-dev-hook-5656836233995166.js:71:20)
    at Object.nodeDevHook [as .ts] (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/ts-node-dev/lib/hook.js:63:13)
    at Object.<anonymous> (/home/hatimpatwa/Hatim/race/Race-wallet/backend/src/server.ts:20:45)
    at Module._compile (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/source-map-support/source-map-support.js:568:25)
    at m._compile (/tmp/ts-node-dev-hook-5656836233995166.js:69:33)
    at require.extensions..jsx.require.extensions..js (/tmp/ts-node-dev-hook-5656836233995166.js:114:20)
    at require.extensions.<computed> (/tmp/ts-node-dev-hook-5656836233995166.js:71:20)
    at Object.nodeDevHook [as .ts] (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/ts-node-dev/lib/hook.js:63:13)
    at Object.<anonymous> (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/ts-node-dev/lib/wrap.js:104:1)
    at Module._compile (/home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/source-map-support/source-map-support.js:568:25)
    at require.extensions..jsx.require.extensions..js (/tmp/ts-node-dev-hook-5656836233995166.js:95:24)
[ERROR] 17:14:17 Error: require() of ES Module /home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/@wagmi/core/dist/esm/exports/index.js from /home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/@alchemy/aa-alchemy/dist/cjs/config/utils/cookies.js not supported.
Instead change the require of index.js in /home/hatimpatwa/Hatim/race/Race-wallet/backend/node_modules/@alchemy/aa-alchemy/dist/cjs/config/utils/cookies.js to a dynamic import() which is available in all CommonJS modules.

And this is the below list of npm packages i currently have

├── @alchemy/aa-accounts@3.18.2
├── @alchemy/aa-alchemy@3.18.2
├── @alchemy/aa-core@3.18.2
├── @dfns/sdk-keysigner@0.3.2
├── @dfns/sdk@0.3.2
├── @types/cors@2.8.17
├── @types/dotenv@8.2.0
├── @types/express@4.17.21
├── @types/helmet@4.0.0
├── @wagmi/core@2.11.2
├── alchemy-sdk@3.2.0
├── base64url@3.0.1
├── bcrypt@5.1.1
├── cors@2.8.5
├── countries-states-cities@1.0.6
├── crypto@1.0.1
├── dotenv@16.4.5
├── ejs@3.1.10
├── env-cmd@10.1.0
├── express@4.18.2
├── fcm-node@1.6.1
├── firebase-admin@12.1.0
├── fs@0.0.1-security
├── helmet@7.1.0
├── http-status-codes@2.3.0
├── http@0.0.1-security
├── https@1.0.0
├── joi@17.12.2
├── jsonwebtoken@9.0.2
├── multer@1.4.5-lts.1
├── mysql2@3.9.2
├── node-cron@3.0.3
├── nodemailer@6.9.13
├── otplib@12.0.1
├── sequelize-cli@6.6.2
├── sequelize@6.37.1
├── socket.io@4.7.5
├── ts-node-dev@2.0.0
├── twilio@5.0.3
├── typescript@5.3.3
├── viem@2.8.6
└── winston@3.11.0

Any suggestion would be helpful

[avarobinson]

@HatimPatwa What version of node are you using? Can you share your package.json file?

[HatimPatwa]

sure here it is ,

node versions tested with

• lts/iron v20.16.0
• lts/hydrogen v18.20.4

package json

{
  "name": "wallet-backend",
  "version": "1.0.0",
  "description": "wallet app backend code",
  "main": "index.js",
  "scripts": {
    "start": "tsc && node dist/server.js",
    "dev": "ts-node-dev --respawn --transpile-only src/server.ts",
    "dev:prod": "env-cmd -f .env.production ts-node-dev --respawn --transpile-only src/server.ts",
    "build": "tsc --build",
    "lint": "eslint . --ext .ts",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [
    "race",
    "wallet",
    "backend",
    "js",
    "javascript",
    "typescript"
  ],
  "author": "Hatim Patwa",
  "license": "ISC",
  "devDependencies": {
    "@types/cors": "^2.8.17",
    "@types/dotenv": "^8.2.0",
    "@types/express": "^4.17.21",
    "@types/helmet": "^4.0.0",
    "env-cmd": "^10.1.0",
    "ts-node-dev": "^2.0.0",
    "typescript": "^5.3.3"
  },
  "dependencies": {
    "@alchemy/aa-accounts": "^3.18.2",
    "@alchemy/aa-alchemy": "^3.18.2",
    "@alchemy/aa-core": "^3.18.2",
    "@dfns/sdk": "^0.3.2",
    "@dfns/sdk-keysigner": "^0.3.2",
    "alchemy-sdk": "^3.2.0",
    "base64url": "^3.0.1",
    "bcrypt": "^5.1.1",
    "cors": "^2.8.5",
    "countries-states-cities": "^1.0.6",
    "crypto": "^1.0.1",
    "dotenv": "^16.4.5",
    "ejs": "^3.1.10",
    "express": "^4.18.2",
    "fcm-node": "^1.6.1",
    "firebase-admin": "^12.1.0",
    "fs": "^0.0.1-security",
    "helmet": "^7.1.0",
    "http": "^0.0.1-security",
    "http-status-codes": "^2.3.0",
    "https": "^1.0.0",
    "joi": "^17.12.2",
    "jsonwebtoken": "^9.0.2",
    "multer": "^1.4.5-lts.1",
    "mysql2": "^3.9.2",
    "node-cron": "^3.0.3",
    "nodemailer": "^6.9.13",
    "otplib": "^12.0.1",
    "sequelize": "^6.37.1",
    "sequelize-cli": "^6.6.2",
    "socket.io": "^4.7.5",
    "twilio": "^5.0.3",
    "viem": "^2.7.14",
    "winston": "^3.11.0"
  }
}

[HatimPatwa]

@avarobinson
Also, i am doing temporary fix by changing line no. 3 require to dynamic import
(line no. 7 in node_modules/@alchemy/aa-alchemy/dist/cjs/config/utils/cookies.js file )

prev:

Object.defineProperty(exports, "__esModule", { value: true });
exports.parseCookie = exports.cookieToInitialState = exports.cookieStorage = void 0;
const core_1 = require("@wagmi/core"); //changed this line
const js_cookie_1 = __importDefault(require("js-cookie"));
const manager_js_1 = require("../../signer/session/manager.js");
const deserialize_js_1 = require("./deserialize.js");

new:

Object.defineProperty(exports, "__esModule", { value: true });
exports.parseCookie = exports.cookieToInitialState = exports.cookieStorage = void 0;
const core_1 = import("@wagmi/core"); //changed this line to import
const js_cookie_1 = __importDefault(require("js-cookie"));
const manager_js_1 = require("../../signer/session/manager.js");
const deserialize_js_1 = require("./deserialize.js");

[moldy530]

does that not make core_1 a Promise? I can take a look into it a bit more, but since we depend on wagmi v2, we may have to drop CJS support.

The wagmi docs have a guide on migrating to ESM from CJS. Due to this, we'll be dropping CJS support in v4 as well: https://wagmi.sh/react/guides/migrate-from-v1-to-v2#dropped-commonjs-support