Merge branch 'develop' into DEVX-441/increase-test-coverage

.github/workflows/docs.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches:
       - develop
-      - v4
+      - fix/SMA-682_docs-fix
 
 permissions:
   contents: write

packages/account/src/BiconomySmartAccountV2.ts

@@ -81,8 +81,19 @@ export class BiconomySmartAccountV2 extends BaseSmartContractAccount {
 
   bundler?: IBundler;
 
+  /**
+   * @class
+   * @ignore
+   */
   private accountContract?: GetContractReturnType<typeof BiconomyAccountAbi, PublicClient>;
 
+  /**
+   * @class
+   * @ignore
+   */
+  // @ts-ignore
+  protected entryPoint: BaseSmartContractAccount["entryPoint"];
+
   private defaultFallbackHandlerAddress: Hex;
 
   private implementationAddress: Hex;
@@ -313,6 +324,10 @@ export class BiconomySmartAccountV2 extends BaseSmartContractAccount {
     }
   }
 
+  /**
+   * @class
+   * @ignore
+   */
   async _getAccountContract(): Promise<GetContractReturnType<typeof BiconomyAccountAbi, PublicClient>> {
     if (this.accountContract == null) {
       this.accountContract = getContract({

packages/account/src/index.ts

@@ -36,6 +36,11 @@ export {
   DEFAULT_SESSION_KEY_MANAGER_MODULE,
   DEFAULT_MULTICHAIN_MODULE,
   DEFAULT_BATCHED_SESSION_ROUTER_MODULE,
+  type ECDSAOwnershipValidationModuleConfig,
+  type BatchedSessionRouterModuleConfig,
+  type SessionKeyManagerModuleConfig,
+  type MultiChainValidationModuleConfig,
+  type SessionValidationModuleConfig,
 } from "@biconomy/modules";
 
 export const createSmartAccountClient = BiconomySmartAccountV2.create;

packages/account/src/utils/Types.ts

@@ -20,7 +20,7 @@ export type BiconomyFactoriesByVersion = Record<string, string>;
 export type BiconomyImplementationsByVersion = Record<string, string>;
 
 export type SmartAccountConfig = {
-  /** entryPointAddress: address of the smart account factory */
+  /** entryPointAddress: address of the entry point */
   entryPointAddress: string;
   /** factoryAddress: address of the smart account factory */
   bundler?: IBundler;

packages/bundler/CHANGELOG.md

@@ -6,6 +6,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 ## 4.0.0 (2023-07-02)
 
 Export createBundler alias for static Bundler.create call
+Abstract away chainId: [0fefb35](https://github.com/bcnmy/biconomy-client-sdk/pull/375/commits/0fefb358e3927d7b026774a785d3711e80f1049a)
 
 ## 3.1.3 (2023-12-28)
 

packages/modules/src/BatchedSessionRouterModule.ts

@@ -62,7 +62,6 @@ export class BatchedSessionRouterModule extends BaseValidationModule {
       const sessionModule = await SessionKeyManagerModule.create({
         moduleAddress: instance.sessionManagerModuleAddress,
         smartAccountAddress: moduleConfig.smartAccountAddress,
-        nodeClientUrl: moduleConfig.nodeClientUrl,
         storageType: moduleConfig.storageType,
       });
 

packages/modules/src/utils/Types.ts

@@ -1,44 +1,56 @@
 import { Chain, Hex } from "viem";
-import { UserOperationStruct, SmartAccountSigner } from "@alchemy/aa-core";
+import { SmartAccountSigner, UserOperationStruct } from "@alchemy/aa-core";
 import { SessionKeyManagerModule } from "../SessionKeyManagerModule";
 import { ISessionStorage } from "../interfaces/ISessionStorage.js";
 import { SupportedSigner } from "@biconomy/common";
 export type ModuleVersion = "V1_0_0"; // | 'V1_0_1'
 
 export interface BaseValidationModuleConfig {
+  /** entryPointAddress: address of the entry point */
   entryPointAddress?: Hex;
 }
 
 export interface ECDSAOwnershipValidationModuleConfig extends BaseValidationModuleConfig {
+  /** Address of the module */
   moduleAddress?: Hex;
+  /** Version of the module */
   version?: ModuleVersion;
+  /** Signer: viemWallet or ethers signer. Ingested when passed into smartAccount */
   signer: SupportedSigner;
 }
 
 export interface ECDSAOwnershipValidationModuleConfigConstructorProps extends BaseValidationModuleConfig {
+  /** Address of the module */
   moduleAddress?: Hex;
+  /** Version of the module */
   version?: ModuleVersion;
+  /** Signer: Converted from viemWallet or ethers signer to SmartAccountSigner */
   signer: SmartAccountSigner;
 }
 
 export interface SessionKeyManagerModuleConfig extends BaseValidationModuleConfig {
+  /** Address of the module */
   moduleAddress?: Hex;
+  /** Version of the module */
   version?: ModuleVersion;
-  nodeClientUrl?: string;
+  /** SmartAccount address */
   smartAccountAddress: string;
   storageType?: StorageType;
   sessionStorageClient?: ISessionStorage;
 }
 
 export interface BatchedSessionRouterModuleConfig extends BaseValidationModuleConfig {
+  /** Address of the module */
   moduleAddress?: Hex;
+  /** Version of the module */
   version?: ModuleVersion;
-
-  sessionKeyManagerModule?: SessionKeyManagerModule; // could be BaseValidationModule
-
+  /** Session Key Manager module: Could be BaseValidationModule */
+  sessionKeyManagerModule?: SessionKeyManagerModule;
+  /** Session Key Manager module address */
   sessionManagerModuleAddress?: Hex;
-  nodeClientUrl?: string;
+  /** Address of the associated smart account */
   smartAccountAddress: string;
+  /** Storage type, e.g. local storage */
   storageType?: StorageType;
 }
 
@@ -47,31 +59,42 @@ export enum StorageType {
 }
 
 export type SessionParams = {
+  /** Redundant now as we've favoured uuid() */
   sessionID?: string;
+  /** Session Signer: viemWallet or ethers signer. Ingested when passed into smartAccount */
   sessionSigner: SupportedSigner;
+  /** The session validation module is a sub-module smart-contract which works with session key manager validation module. It validates the userop calldata against the defined session permissions (session key data) within the contract. */
   sessionValidationModule?: Hex;
+  /** Additional info if needed to be appended in signature */
   additionalSessionData?: string;
 };
 
 export type ModuleInfo = {
   // Could be a full object of below params and that way it can be an array too!
   // sessionParams?: SessionParams[] // where SessionParams is below four
   sessionID?: string;
+  /** Session Signer: viemWallet or ethers signer. Ingested when passed into smartAccount */
   sessionSigner?: SupportedSigner;
+  /** The session validation module is a sub-module smart-contract which works with session key manager validation module. It validates the userop calldata against the defined session permissions (session key data) within the contract. */
   sessionValidationModule?: Hex;
+  /** Additional info if needed to be appended in signature */
   additionalSessionData?: string;
   batchSessionParams?: SessionParams[];
 };
 
 export interface SendUserOpParams extends ModuleInfo {
+  /** "validation_and_execution" is recommended during development for improved debugging & devEx, but will add some additional latency to calls. "validation" can be used in production ro remove this latency once flows have been tested. */
   simulationType?: SimulationType;
 }
 
 export type SimulationType = "validation" | "validation_and_execution";
 
 export type SignerData = {
+  /** Public key */
   pbKey: string;
+  /** Private key */
   pvKey: `0x${string}`;
+  /** Network Id */
   chainId?: Chain;
 };
 
@@ -81,27 +104,38 @@ export type CreateSessionDataResponse = {
 };
 
 export interface CreateSessionDataParams {
+  /** window end for the session key */
   validUntil: number;
+  /** window start for the session key */
   validAfter: number;
   sessionValidationModule: Hex;
   sessionPublicKey: Hex;
   sessionKeyData: Hex;
+  /** we generate uuid based sessionId. but if you prefer to track it on your side and attach custom session identifier this can be passed */
   preferredSessionId?: string;
 }
 
 export interface MultiChainValidationModuleConfig extends BaseValidationModuleConfig {
+  /** Address of the module */
   moduleAddress?: Hex;
+  /** Version of the module */
   version?: ModuleVersion;
+  /** Signer: viemWallet or ethers signer. Ingested when passed into smartAccount */
   signer: SupportedSigner;
 }
 export interface MultiChainValidationModuleConfigConstructorProps extends BaseValidationModuleConfig {
+  /** Address of the module */
   moduleAddress?: Hex;
+  /** Version of the module */
   version?: ModuleVersion;
+  /** Signer: viemWallet or ethers signer. Ingested when passed into smartAccount */
   signer: SmartAccountSigner;
 }
 
 export type MultiChainUserOpDto = {
+  /** window end timestamp */
   validUntil?: number;
+  /** window start timestamp */
   validAfter?: number;
   chainId: number;
   userOp: Partial<UserOperationStruct>;
@@ -112,11 +146,15 @@ export interface BaseSessionKeyData {
 }
 
 export interface ERC20SessionKeyData extends BaseSessionKeyData {
+  /** ERC20 token address */
   token: Hex;
+  /** Recipient address */
   recipient: Hex;
+  /** ERC20 amount (Bigint) */
   maxAmount: bigint;
 }
 
 export interface SessionValidationModuleConfig {
+  /** Address of the module */
   moduleAddress: string;
 }

packages/modules/tests/ecdsaValidationModule.e2e.spec.ts

@@ -0,0 +1,63 @@
+import { PaymasterMode } from "@biconomy/paymaster";
+import { TestData } from "../../../tests";
+import { createSmartAccountClient } from "../../account/src/index";
+import { Hex, encodeFunctionData, parseAbi } from "viem";
+import { DEFAULT_MULTICHAIN_MODULE, createECDSAOwnershipValidationModule } from "@biconomy/modules";
+
+describe("Account with ECDSAOwnershipValidationModule Module Tests", () => {
+  let mumbai: TestData;
+  let baseSepolia: TestData;
+
+  beforeEach(() => {
+    // @ts-ignore: Comes from setup-e2e-tests
+    [mumbai, baseSepolia] = testDataPerChain;
+  });
+
+  it("should create a ECDSAOwnershipValidationModule with signer", async () => {
+    const {
+      bundlerUrl,
+      whale: { viemWallet: signer },
+    } = mumbai;
+
+    const defaultValidationModule = await createECDSAOwnershipValidationModule({ signer });
+    // Should not require a signer or chainId
+    const smartAccount = await createSmartAccountClient({
+      bundlerUrl,
+      defaultValidationModule,
+      signer,
+    });
+    const address = await smartAccount.getAccountAddress();
+    expect(address).toBeTruthy();
+    expect(smartAccount.activeValidationModule).toEqual(defaultValidationModule);
+  });
+
+  it("should create a ECDSAOwnershipValidationModule without signer", async () => {
+    const {
+      bundlerUrl,
+      whale: { viemWallet: signer },
+    } = mumbai;
+
+    const defaultValidationModule = await createECDSAOwnershipValidationModule({ signer });
+    // Should not require a signer or chainId
+    const smartAccount = await createSmartAccountClient({
+      bundlerUrl,
+      defaultValidationModule,
+    });
+    const address = await smartAccount.getAccountAddress();
+    expect(address).toBeTruthy();
+    expect(smartAccount.activeValidationModule).toEqual(defaultValidationModule);
+  });
+
+  it("should create a ECDSAOwnershipValidationModule by default, without explicitly setting it on the smart account", async () => {
+    const {
+      bundlerUrl,
+      whale: { viemWallet: signer },
+    } = mumbai;
+    const defaultValidationModule = await createECDSAOwnershipValidationModule({ signer });
+    const smartAccount = await createSmartAccountClient({ bundlerUrl, signer });
+    const address = await smartAccount.getAccountAddress();
+    expect(address).toBeTruthy();
+    const smartAccountValidationModuleAddress = await smartAccount.activeValidationModule.getAddress();
+    expect(smartAccountValidationModuleAddress).toEqual(defaultValidationModule.moduleAddress);
+  });
+});

yarn.lock

@@ -1767,9 +1767,9 @@
     uuid "^8.3.2"
 
 "@particle-network/chains@*":
-  version "1.3.18"
-  resolved "https://registry.yarnpkg.com/@particle-network/chains/-/chains-1.3.18.tgz#ce763a845f88ff118c27148579de6934ff376298"
-  integrity sha512-R38ddazbt5Xt8noVA4Fproc89Mm7UmaRvc7Xkl0XP0sp+HaUJjEwFpL4zTCATYb2sUx3cJgV46fVOuD7/2QWIA==
+  version "1.3.19"
+  resolved "https://registry.yarnpkg.com/@particle-network/chains/-/chains-1.3.19.tgz#63013cbbebf36c37e970f83406ef955f08309499"
+  integrity sha512-cQOGS0dH6LMDyJ7bkaLj6FShYSyz8OZ2hBvtBPdTtuMCsTlQPFcXKR6QI2CpJZBbb6m1fIXZEXlFYFZzY/t6ng==
 
 "@particle-network/crypto@^1.0.1":
   version "1.0.1"