Add support for SessionKeys Module

CHANGELOG.md

@@ -1,4 +1,8 @@
 # Changelog
+## [1.1.2] - 2024-07-10
+### New
+- Added `SessionKeyValidator` module for ERC20 SessionKeyValidator.
+- Added `enableSessionKey`, `rotateSessionKey`, `disableSessionKey`, and `getAssociatedSessionKeys` functions to `SessionKeyValidator`.
 
 ## [1.1.1] - 2024-07-08
 ### Feature Enhancement

examples/13-enable-sessionkey-module.ts

@@ -0,0 +1,65 @@
+import { EtherspotBundler, ModularSdk, SessionKeyValidator } from '../src';
+import * as dotenv from 'dotenv';
+import { sleep } from '../src/sdk/common';
+import { KeyStore } from '../src/sdk/SessionKeyValidator';
+
+dotenv.config();
+
+async function main() {
+  const bundlerApiKey = 'eyJvcmciOiI2NTIzZjY5MzUwOTBmNzAwMDFiYjJkZWIiLCJpZCI6IjMxMDZiOGY2NTRhZTRhZTM4MGVjYjJiN2Q2NDMzMjM4IiwiaCI6Im11cm11cjEyOCJ9';
+
+  // initializating sdk...
+  const modularSdk = new ModularSdk({ privateKey: process.env.WALLET_PRIVATE_KEY },
+    {
+      chainId: Number(process.env.CHAIN_ID),
+      bundlerProvider: new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey)
+    })
+
+  console.log('address: ', modularSdk.state.EOAAddress);
+
+  // get address of EtherspotWallet
+  const address: string = await modularSdk.getCounterFactualAddress();
+
+  console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet address: ${address}`);
+
+  const token = '0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238';
+  const functionSelector = '0xa9059cbb';
+  const spendingLimit = '100000';
+  const validAfter = new Date().getTime();
+  const validUntil = new Date().getTime() + 24 * 60 * 60 * 1000;
+
+  // get instance  of SessionKeyValidator
+  const sessionKeyModule = new SessionKeyValidator(
+    modularSdk,
+    new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey)
+  )
+
+  const response = await sessionKeyModule.enableSessionKey(
+    token,
+    functionSelector,
+    spendingLimit,
+    validAfter,
+    validUntil,
+    KeyStore.AWS
+  );
+
+  console.log('\x1b[33m%s\x1b[0m', `UserOpHash: `, response.userOpHash);
+  console.log('\x1b[33m%s\x1b[0m', `SessionKey: `, response.sessionKey);
+
+  // 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 modularSdk.getUserOpReceipt(response.userOpHash);
+  }
+  console.log('\x1b[33m%s\x1b[0m', `Transaction Receipt: `, userOpsReceipt);
+
+  const sessionKeys = await sessionKeyModule.getAssociatedSessionKeys();
+  console.log('\x1b[33m%s\x1b[0m', `AssociatedSessionKeys: `, sessionKeys);
+}
+
+main()
+  .catch(console.error)
+  .finally(() => process.exit());

examples/14-rotate-sessionkey-module.ts

@@ -0,0 +1,65 @@
+import { EtherspotBundler, ModularSdk, SessionKeyValidator } from '../src';
+import * as dotenv from 'dotenv';
+import { sleep } from '../src/sdk/common';
+import { KeyStore } from '../src/sdk/SessionKeyValidator';
+
+dotenv.config();
+
+async function main() {
+  const bundlerApiKey = 'eyJvcmciOiI2NTIzZjY5MzUwOTBmNzAwMDFiYjJkZWIiLCJpZCI6IjMxMDZiOGY2NTRhZTRhZTM4MGVjYjJiN2Q2NDMzMjM4IiwiaCI6Im11cm11cjEyOCJ9';
+
+  // initializating sdk...
+  const modularSdk = new ModularSdk({ privateKey: process.env.WALLET_PRIVATE_KEY },
+    {
+      chainId: Number(process.env.CHAIN_ID),
+      bundlerProvider: new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey)
+    })
+
+  console.log('address: ', modularSdk.state.EOAAddress);
+
+  // get address of EtherspotWallet
+  const address: string = await modularSdk.getCounterFactualAddress();
+
+  console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet address: ${address}`);
+
+  const token = '0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238';
+  const functionSelector = '0xa9059cbb';
+  const spendingLimit = '100000';
+  const validAfter = new Date().getTime();
+  const validUntil = new Date().getTime() + 24 * 60 * 60 * 1000;
+
+  // get instance  of SessionKeyValidator
+  const sessionKeyModule = new SessionKeyValidator(
+    modularSdk,
+    new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey)
+  )
+
+  const response = await sessionKeyModule.rotateSessionKey(
+    token,
+    functionSelector,
+    spendingLimit,
+    validAfter,
+    validUntil,
+    KeyStore.AWS
+  );
+
+  console.log('\x1b[33m%s\x1b[0m', `UserOpHash: `, response.userOpHash);
+  console.log('\x1b[33m%s\x1b[0m', `SessionKey: `, response.sessionKey);
+
+  // 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 modularSdk.getUserOpReceipt(response.userOpHash);
+  }
+  console.log('\x1b[33m%s\x1b[0m', `Transaction Receipt: `, userOpsReceipt);
+
+  const sessionKeys = await sessionKeyModule.getAssociatedSessionKeys();
+  console.log('\x1b[33m%s\x1b[0m', `AssociatedSessionKeys: `, sessionKeys);
+}
+
+main()
+  .catch(console.error)
+  .finally(() => process.exit());

examples/15-disable-sessionkey-module.ts

@@ -0,0 +1,51 @@
+import { EtherspotBundler, ModularSdk, SessionKeyValidator } from '../src';
+import * as dotenv from 'dotenv';
+import { sleep } from '../src/sdk/common';
+
+dotenv.config();
+
+async function main() {
+  const bundlerApiKey = 'eyJvcmciOiI2NTIzZjY5MzUwOTBmNzAwMDFiYjJkZWIiLCJpZCI6IjMxMDZiOGY2NTRhZTRhZTM4MGVjYjJiN2Q2NDMzMjM4IiwiaCI6Im11cm11cjEyOCJ9';
+
+  // initializating sdk...
+  const modularSdk = new ModularSdk({ privateKey: process.env.WALLET_PRIVATE_KEY },
+    {
+      chainId: Number(process.env.CHAIN_ID),
+      bundlerProvider: new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey)
+    })
+
+  console.log('address: ', modularSdk.state.EOAAddress);
+
+  // get address of EtherspotWallet
+  const address: string = await modularSdk.getCounterFactualAddress();
+
+  console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet address: ${address}`);
+
+  // get instance  of SessionKeyValidator
+  const sessionKeyModule = new SessionKeyValidator(
+    modularSdk,
+    new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey)
+  )
+
+  const response = await sessionKeyModule.disableSessionKey();
+
+  console.log('\x1b[33m%s\x1b[0m', `UserOpHash: `, response.userOpHash);
+  console.log('\x1b[33m%s\x1b[0m', `SessionKey: `, response.sessionKey);
+
+  // 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 modularSdk.getUserOpReceipt(response.userOpHash);
+  }
+  console.log('\x1b[33m%s\x1b[0m', `Transaction Receipt: `, userOpsReceipt);
+
+  const sessionKeys = await sessionKeyModule.getAssociatedSessionKeys();
+  console.log('\x1b[33m%s\x1b[0m', `AssociatedSessionKeys: `, sessionKeys);
+}
+
+main()
+  .catch(console.error)
+  .finally(() => process.exit());

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherspot/modular-sdk",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Etherspot Modular SDK - build with ERC-7579 smart accounts modules",
   "keywords": [
     "ether",
@@ -31,13 +31,14 @@
     "04-transfer-nft": "./node_modules/.bin/ts-node ./examples/04-transfer-nft",
     "05-add-guardians": "./node_modules/.bin/ts-node ./examples/05-add-guardians",
     "06-paymaster": "./node_modules/.bin/ts-node ./examples/06-paymaster",
-    "07-paymaster-arka": "./node_modules/.bin/ts-node ./examples/07-paymaster-arka",
-    "08-paymaster-validUntil-validAfter": "./node_modules/.bin/ts-node ./examples/08-paymaster-validUntil-validAfter",
-    "09-callGasLimit": "./node_modules/.bin/ts-node ./examples/09-callGasLimit",
-    "10-get-multiple-accounts": "./node_modules/.bin/ts-node ./examples/10-get-multiple-accounts",
-    "11-concurrent-userops": "./node_modules/.bin/ts-node ./examples/11-concurrent-userops",
-    "14-install-module": "./node_modules/.bin/ts-node ./examples/14-install-module",
-    "15-uninstall-module": "./node_modules/.bin/ts-node ./examples/15-uninstall-module",
+    "07-callGasLimit": "./node_modules/.bin/ts-node ./examples/07-callGasLimit",
+    "08-get-multiple-accounts": "./node_modules/.bin/ts-node ./examples/08-get-multiple-accounts",
+    "09-concurrent-userops": "./node_modules/.bin/ts-node ./examples/09-concurrent-userops",
+    "11-install-module": "./node_modules/.bin/ts-node ./examples/11-install-module",
+    "12-uninstall-module": "./node_modules/.bin/ts-node ./examples/12-uninstall-module",
+    "13-enable-sessionkey-module": "./node_modules/.bin/ts-node ./examples/13-enable-sessionkey-module",
+    "14-rotate-sessionkey-module": "./node_modules/.bin/ts-node ./examples/14-rotate-sessionkey-module",
+    "15-disable-sessionkey-module": "./node_modules/.bin/ts-node ./examples/15-disable-sessionkey-module",
     "format": "prettier --write \"{src,test,examples}/**/*.ts\"",
     "lint": "eslint \"{src,test,examples}/**/*.ts\"",
     "lint-fix": "npm run lint -- --fix",