Add support for EP7.0 and Etherspot's Modular accounts

.circleci/config.yml

@@ -111,12 +111,12 @@ jobs:
           name: Publish package to npm
           command: |
             cd ~/etherspot-prime-sdk
-            npm publish
+            npm publish --tag v2-modular
       - run:
           name: Announce Publish
           command: |
             chmod +x .circleci/announcePublish.sh
-            .circleci/announcePublish.sh "Etherspot Prime SDK" "$(node -e "console.log(require('./package.json').version)")"
+            .circleci/announcePublish.sh "Etherspot Prime SDK Modular" "$(node -e "console.log(require('./package.json').version)")"
   publish-github-release:
     docker:
       - image: ardd97/ghr
@@ -127,7 +127,7 @@ jobs:
           command: |
             PACKAGE_VERSION="$(jq .version package.json -r)"
             echo $PACKAGE_VERSION
-            ghr -t "${GITHUB_TOKEN}" -u "${CIRCLE_PROJECT_USERNAME}" -r "${CIRCLE_PROJECT_REPONAME}" -c "${CIRCLE_SHA1}" "$PACKAGE_VERSION"
+            ghr -t "${GITHUB_TOKEN}" -u "${CIRCLE_PROJECT_USERNAME}" -r "${CIRCLE_PROJECT_REPONAME}" -c "${CIRCLE_SHA1}" -n "V2 Modular" "$PACKAGE_VERSION"
 
 workflows:
   version: 2.1
@@ -150,12 +150,12 @@ workflows:
           filters:
             branches:
               only:
-                  - master
+                  - v2-modular
       - publish-github-release:
           context: general-vars
           requires:
             - publish-npm-package
           filters:
             branches:
               only:
-                  - master
+                  - v2-modular

CHANGELOG.md

@@ -1,4 +1,10 @@
 # Changelog
+## [1.8.2] - 2024-05-28
+### New
+- Added support for EP7.0 and Etherspot's Modular accounts
+- Added `installModule` function to install module
+- Added `uninstallModule` function to remove module
+
 ## [1.8.1] - 2024-05-14
 ### New
 - Added signTypedData method to all providers supported

examples/02-transfer-funds.ts

@@ -1,4 +1,4 @@
-import { ethers } from 'ethers';
+import { BigNumber, ethers } from 'ethers';
 import { EtherspotBundler, PrimeSdk } from '../src';
 import { printOp } from '../src/sdk/common/OperationUtils';
 import * as dotenv from 'dotenv';
@@ -33,7 +33,9 @@ async function main() {
   console.log('balances: ', balance);
 
   // estimate transactions added to the batch and get the fee data for the UserOp
-  const op = await primeSdk.estimate();
+  const op = await primeSdk.estimate({
+    key: BigNumber.from('0x1E714c551Fe6234B6eE406899Ec3Be9234Ad2124') // multipleOwnerECDSAValidator address
+  });
   console.log(`Estimate UserOp: ${await printOp(op)}`);
 
   // sign the UserOp and sending to the bundler...

examples/03-transfer-erc20.ts

@@ -1,4 +1,4 @@
-import { ethers } from 'ethers';
+import { BigNumber, ethers } from 'ethers';
 import { EtherspotBundler, PrimeSdk } from '../src';
 import { printOp } from '../src/sdk/common/OperationUtils';
 import { ERC20_ABI } from '../src/sdk/helpers/abi/ERC20_ABI';
@@ -41,7 +41,9 @@ async function main() {
   console.log('transactions: ', userOpsBatch);
 
   // estimate transactions added to the batch and get the fee data for the UserOp
-  const op = await primeSdk.estimate();
+  const op = await primeSdk.estimate({
+    key: BigNumber.from('0x1E714c551Fe6234B6eE406899Ec3Be9234Ad2124') // multipleOwnerECDSAValidator address
+  });
   console.log(`Estimate UserOp: ${await printOp(op)}`);
 
   // sign the UserOp and sending to the bundler...

examples/26-install-module.ts

@@ -0,0 +1,60 @@
+import { BigNumber, ethers } from 'ethers';
+import { EtherspotBundler, PrimeSdk } from '../src';
+import { printOp } from '../src/sdk/common/OperationUtils';
+import * as dotenv from 'dotenv';
+import { MODULE_TYPE, sleep } from '../src/sdk/common';
+
+dotenv.config();
+
+async function main() {
+  const bundlerApiKey = 'eyJvcmciOiI2NTIzZjY5MzUwOTBmNzAwMDFiYjJkZWIiLCJpZCI6IjMxMDZiOGY2NTRhZTRhZTM4MGVjYjJiN2Q2NDMzMjM4IiwiaCI6Im11cm11cjEyOCJ9';
+
+  // initializating sdk...
+  const primeSdk = new PrimeSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, { chainId: Number(process.env.CHAIN_ID), bundlerProvider: new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey) })
+
+  console.log('address: ', primeSdk.state.EOAAddress);
+
+  // get address of EtherspotWallet
+  const address: string = await primeSdk.getCounterFactualAddress();
+
+  console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet address: ${address}`);
+
+  const initData = ethers.utils.defaultAbiCoder.encode(
+    ["address", "bytes"],
+    ['0x0000000000000000000000000000000000000001', '0x00']
+  );
+
+  // get installData of module
+  const installData = await primeSdk.installModule(MODULE_TYPE.VALIDATOR, '0x6a00da4DEEf677Ad854B7c14F17Ed9312c2B5fDf', initData);
+
+  // clear the transaction batch
+  await primeSdk.clearUserOpsFromBatch();
+
+  // add transactions to the batch
+  const userOpsBatch = await primeSdk.addUserOpsToBatch({ to: address, data: installData });
+  console.log('transactions: ', userOpsBatch);
+
+  // sign transactions added to the batch
+  const op = await primeSdk.estimate({
+    key: BigNumber.from('0x1E714c551Fe6234B6eE406899Ec3Be9234Ad2124') // multipleOwnerECDSAValidator address
+  });
+  console.log(`Estimated UserOp: ${await printOp(op)}`);
+
+  // sign the userOps and sending to the bundler...
+  const uoHash = await primeSdk.send(op);
+  console.log(`UserOpHash: ${uoHash}`);
+
+  // get transaction hash...
+  console.log('Waiting for transaction...');
+  let userOpsReceipt = null;
+  const timeout = Date.now() + 60000; // 1 minute timeout
+  while (userOpsReceipt == null && Date.now() < timeout) {
+    await sleep(2);
+    userOpsReceipt = await primeSdk.getUserOpReceipt(uoHash);
+  }
+  console.log('\x1b[33m%s\x1b[0m', `Transaction Receipt: `, userOpsReceipt);
+}
+
+main()
+  .catch(console.error)
+  .finally(() => process.exit());

examples/27-uninstall-module.ts

@@ -0,0 +1,60 @@
+import { BigNumber, ethers } from 'ethers';
+import { EtherspotBundler, PrimeSdk } from '../src';
+import { printOp } from '../src/sdk/common/OperationUtils';
+import * as dotenv from 'dotenv';
+import { MODULE_TYPE, sleep } from '../src/sdk/common';
+
+dotenv.config();
+
+async function main() {
+  const bundlerApiKey = 'eyJvcmciOiI2NTIzZjY5MzUwOTBmNzAwMDFiYjJkZWIiLCJpZCI6IjMxMDZiOGY2NTRhZTRhZTM4MGVjYjJiN2Q2NDMzMjM4IiwiaCI6Im11cm11cjEyOCJ9';
+
+  // initializating sdk...
+  const primeSdk = new PrimeSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, { chainId: Number(process.env.CHAIN_ID), bundlerProvider: new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey) })
+
+  console.log('address: ', primeSdk.state.EOAAddress);
+
+  // get address of EtherspotWallet
+  const address: string = await primeSdk.getCounterFactualAddress();
+
+  console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet address: ${address}`);
+
+  const deInitData = ethers.utils.defaultAbiCoder.encode(
+    ["address", "bytes"],
+    ['0x0000000000000000000000000000000000000001', '0x00']
+  );
+
+  // get uninstallData of module
+  const uninstallData = await primeSdk.uninstallModule(MODULE_TYPE.VALIDATOR, '0x6a00da4DEEf677Ad854B7c14F17Ed9312c2B5fDf', deInitData);
+
+  // clear the transaction batch
+  await primeSdk.clearUserOpsFromBatch();
+
+  // add transactions to the batch
+  const userOpsBatch = await primeSdk.addUserOpsToBatch({ to: address, data: uninstallData });
+  console.log('transactions: ', userOpsBatch);
+
+  // sign transactions added to the batch
+  const op = await primeSdk.estimate({
+    key: BigNumber.from('0x1E714c551Fe6234B6eE406899Ec3Be9234Ad2124') // multipleOwnerECDSAValidator address
+  });
+  console.log(`Estimated UserOp: ${await printOp(op)}`);
+
+  // sign the userOps and sending to the bundler...
+  const uoHash = await primeSdk.send(op);
+  console.log(`UserOpHash: ${uoHash}`);
+
+  // get transaction hash...
+  console.log('Waiting for transaction...');
+  let userOpsReceipt = null;
+  const timeout = Date.now() + 60000; // 1 minute timeout
+  while (userOpsReceipt == null && Date.now() < timeout) {
+    await sleep(2);
+    userOpsReceipt = await primeSdk.getUserOpReceipt(uoHash);
+  }
+  console.log('\x1b[33m%s\x1b[0m', `Transaction Receipt: `, userOpsReceipt);
+}
+
+main()
+  .catch(console.error)
+  .finally(() => process.exit());