Feat/refactor, fix build, lint issues and tests.

.github/workflows/coverage.yml

@@ -40,4 +40,4 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           verbose: true
-          slug: bcnmy/sdk
+          slug: bcnmy/sdk

.github/workflows/playground.yml

@@ -26,4 +26,4 @@ jobs:
           PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
           BUNDLER_URL: ${{ secrets.BUNDLER_URL }}
           CHAIN_ID: 84532
-          CI: true
+          CI: true

CHANGELOG.md

@@ -1,3 +1,3 @@
 # @biconomy/sdk
 
-## 0.0.0
+## 0.0.0

package.json

@@ -125,6 +125,7 @@
     "commit-msg": "npx --no -- commitlint --edit ${1}"
   },
   "dependencies": {
+    "@rhinestone/module-sdk": "^0.1.17",
     "merkletreejs": "^0.3.11"
   }
 }

scripts/send:userOp.ts

@@ -44,7 +44,7 @@ if ([chain, privateKey, bundlerUrl].every(Boolean) !== true)
 const account = privateKeyToAccount(`0x${privateKey}`)
 const recipient = "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" // vitalik.eth
 const nexusClient = await createNexusClient({
-  holder: account,
+  signer: account,
   chain,
   transport: http(),
   bundlerTransport: http(bundlerUrl),

scripts/viem:bundler.ts

@@ -66,7 +66,7 @@ const publicClient = createPublicClient({
 
 const main = async () => {
   const nexusAccount = await toNexusAccount({
-    holder: account,
+    signer: account,
     chain,
     transport: http(),
     k1ValidatorAddress,

src/sdk/account/toNexusAccount.test.ts

@@ -78,7 +78,7 @@ describe("nexus.account", async () => {
     })
 
     nexusClient = await createNexusClient({
-      holder: account,
+      signer: account,
       chain,
       transport: http(),
       bundlerTransport: http(bundlerUrl)

src/sdk/account/toNexusAccount.ts

@@ -60,28 +60,28 @@ import {
   packUserOp,
   typeToString
 } from "./utils/Utils"
-import { type UnknownHolder, toHolder } from "./utils/toHolder"
+import { type UnknownSigner, toSigner } from "./utils/toSigner"
 
 /**
  * Parameters for creating a Nexus Smart Account
  */
-export type ToNexusSmartAccountParameters = Prettify<
-  {
-    /** The blockchain network */
-    chain: Chain
-    /** The transport configuration */
-    transport: ClientConfig["transport"]
-    /** The holder account or address */
-    holder: UnknownHolder
-    /** Optional index for the account */
-    index?: bigint | undefined
-    /** Optional active validation module */
-    activeModule?: BaseValidationModule
-    /** Optional factory address */
-    factoryAddress?: Address
-    /** Optional K1 validator address */
-    k1ValidatorAddress?: Address
-  } & Pick<
+export type ToNexusSmartAccountParameters = {
+  /** The blockchain network */
+  chain: Chain
+  /** The transport configuration */
+  transport: ClientConfig["transport"]
+  /** The signer account or address */
+  signer: UnknownSigner
+  /** Optional index for the account */
+  index?: bigint | undefined
+  /** Optional active validation module */
+  activeValidationModule?: BaseValidationModule
+  /** Optional factory address */
+  factoryAddress?: Address
+  /** Optional K1 validator address */
+  k1ValidatorAddress?: Address
+} & Prettify<
+  Pick<
     ClientConfig<Transport, Chain, Account, RpcSchema>,
     | "account"
     | "cacheTime"
@@ -113,6 +113,8 @@ export type NexusSmartAccountImplementation = SmartAccountImplementation<
     encodeExecute: (call: Call) => Promise<Hex>
     encodeExecuteBatch: (calls: readonly Call[]) => Promise<Hex>
     getUserOpHash: (userOp: Partial<UserOperationStruct>) => Promise<Hex>
+    setActiveValidationModule: (validationModule: BaseValidationModule) => void
+    getActiveValidationModule: () => BaseValidationModule
     factoryData: Hex
     factoryAddress: Address
   }
@@ -132,7 +134,7 @@ export type NexusSmartAccountImplementation = SmartAccountImplementation<
  * const account = await toNexusAccount({
  *   chain: mainnet,
  *   transport: http(),
- *   holder: '0x...',
+ *   signer: '0x...',
  * })
  */
 export const toNexusAccount = async (
@@ -141,19 +143,19 @@ export const toNexusAccount = async (
   const {
     chain,
     transport,
-    holder: holder_,
+    signer: _signer,
     index = 0n,
-    activeModule,
+    activeValidationModule,
     factoryAddress = contracts.k1ValidatorFactory.address,
     k1ValidatorAddress = contracts.k1Validator.address,
     key = "nexus account",
     name = "Nexus Account"
   } = parameters
 
-  const holder = await toHolder({ holder: holder_ })
+  const signer = await toSigner({ signer: _signer })
 
   const masterClient = createWalletClient({
-    account: holder,
+    account: signer,
     chain,
     transport,
     key,
@@ -178,16 +180,16 @@ export const toNexusAccount = async (
     args: [signerAddress, index, [], 0]
   })
 
-  const defaultedActiveModule =
-    activeModule ??
+  let defaultedActiveModule =
+    activeValidationModule ??
     new K1ValidatorModule(
       {
         address: k1ValidatorAddress,
         type: "validator",
-        context: signerAddress,
+        data: signerAddress,
         additionalContext: "0x"
       },
-      holder
+      signer
     )
 
   let _accountAddress: Address
@@ -344,6 +346,17 @@ export const toNexusAccount = async (
     }
   }
 
+  /**
+   * @description Changes the active module for the account
+   * @param newModule - The new module to set as active
+   * @returns void
+   */
+  const setActiveValidationModule = (
+    validationModule: BaseValidationModule
+  ): void => {
+    defaultedActiveModule = validationModule
+  }
+
   /**
    * @description Signs a message
    * @param params - The parameters for signing
@@ -354,7 +367,7 @@ export const toNexusAccount = async (
     message
   }: { message: SignableMessage }): Promise<Hex> => {
     const tempSignature = await defaultedActiveModule
-      .getHolder()
+      .getSigner()
       .signMessage({ message })
 
     const signature = encodePacked(
@@ -509,6 +522,8 @@ export const toNexusAccount = async (
       encodeExecute,
       encodeExecuteBatch,
       getUserOpHash,
+      setActiveValidationModule,
+      getActiveValidationModule: () => defaultedActiveModule,
       factoryData,
       factoryAddress
     }

src/sdk/account/utils/index.ts

@@ -3,4 +3,4 @@ export * from "./Utils.js"
 export * from "./Constants.js"
 export * from "./getChain.js"
 export * from "./Logger.js"
-export * from "./toHolder.js"
+export * from "./toSigner.js"

src/sdk/account/utils/toSigner.ts

@@ -0,0 +1,86 @@
+import {
+  type Account,
+  type Address,
+  type Chain,
+  type EIP1193Provider,
+  type EIP1193RequestFn,
+  type EIP1474Methods,
+  type LocalAccount,
+  type OneOf,
+  type Transport,
+  type WalletClient,
+  createWalletClient,
+  custom
+} from "viem"
+import { toAccount } from "viem/accounts"
+
+import { signTypedData } from "viem/actions"
+import { getAction } from "viem/utils"
+
+export type Signer = LocalAccount
+export type UnknownSigner = OneOf<
+  | EIP1193Provider
+  | WalletClient<Transport, Chain | undefined, Account>
+  | LocalAccount
+  | Account
+>
+export async function toSigner({
+  signer,
+  address
+}: {
+  signer: UnknownSigner
+  address?: Address
+}): Promise<LocalAccount> {
+  if ("type" in signer && signer.type === "local") {
+    return signer as LocalAccount
+  }
+
+  let walletClient:
+    | WalletClient<Transport, Chain | undefined, Account>
+    | undefined = undefined
+
+  if ("request" in signer) {
+    if (!address) {
+      try {
+        ;[address] = await (signer.request as EIP1193RequestFn<EIP1474Methods>)(
+          {
+            method: "eth_requestAccounts"
+          }
+        )
+      } catch {
+        ;[address] = await (signer.request as EIP1193RequestFn<EIP1474Methods>)(
+          {
+            method: "eth_accounts"
+          }
+        )
+      }
+    }
+    if (!address) throw new Error("address required")
+
+    walletClient = createWalletClient({
+      account: address,
+      transport: custom(signer as EIP1193Provider)
+    })
+  }
+
+  if (!walletClient) {
+    walletClient = signer as WalletClient<Transport, Chain | undefined, Account>
+  }
+
+  return toAccount({
+    address: walletClient.account.address,
+    async signMessage({ message }) {
+      return walletClient.signMessage({ message })
+    },
+    async signTypedData(typedData) {
+      return getAction(
+        walletClient,
+        signTypedData,
+        "signTypedData"
+      )(typedData as any)
+    },
+    async signTransaction(_) {
+      throw new Error("Not supported")
+    }
+  })
+}

src/sdk/clients/createBicoBundlerClient.test.ts

@@ -34,7 +34,7 @@ describe("bico.bundler", async () => {
     testClient = toTestClient(chain, getTestAccount(5))
 
     nexusAccount = await toNexusAccount({
-      holder: account,
+      signer: account,
       chain,
       transport: http()
     })

src/sdk/clients/createNexusClient.test.ts

@@ -1,14 +1,8 @@
-import { AbiCoder, ParamType } from "ethers/abi"
-import { JsonRpcProvider } from "ethers/providers"
-import { Wallet } from "ethers/wallet"
 import {
   http,
-  type AbiParameter,
   type Account,
   type Address,
   type Chain,
-  type Hex,
-  encodeAbiParameters,
   encodeFunctionData,
   parseEther
 } from "viem"
@@ -24,7 +18,6 @@ import {
   topUp
 } from "../../test/testUtils"
 import type { MasterClient, NetworkConfig } from "../../test/testUtils"
-import { pKey } from "../../test/testUtils"
 import { addresses } from "../__contracts/addresses"
 import { ERROR_MESSAGES } from "../account/utils/Constants"
 import { makeInstallDataAndHash } from "../account/utils/Utils"
@@ -56,7 +49,7 @@ describe("nexus.client", async () => {
     testClient = toTestClient(chain, getTestAccount(5))
 
     nexusClient = await createNexusClient({
-      holder: account,
+      signer: account,
       chain,
       transport: http(),
       bundlerTransport: http(bundlerUrl)
@@ -157,19 +150,19 @@ describe("nexus.client", async () => {
     expect(result).toBeTruthy()
   }, 30000)
 
-  test.skip("should create a nexusAccount from an ethers signer", async () => {
-    const ethersProvider = new JsonRpcProvider(chain.rpcUrls.default.http[0])
-    const ethersSigner = new Wallet(pKey, ethersProvider)
+  // test.skip("should create a nexusAccount from an ethers signer", async () => {
+  //   const ethersProvider = new JsonRpcProvider(chain.rpcUrls.default.http[0])
+  //   const ethersSigner = new Wallet(pKey, ethersProvider)
 
-    const ethOwnerNexusClient = await createNexusClient({
-      chain,
-      owner: (await ethersSigner.getAddress()) as Hex,
-      bundlerTransport: http(bundlerUrl),
-      transport: http(chain.rpcUrls.default.http[0])
-    })
+  //   const ethOwnerNexusClient = await createNexusClient({
+  //     chain,
+  //     owner: (await ethersSigner.getAddress()) as Hex,
+  //     bundlerTransport: http(bundlerUrl),
+  //     transport: http(chain.rpcUrls.default.http[0])
+  //   })
 
-    expect(await ethOwnerNexusClient.account.getAddress()).toBeTruthy()
-  })
+  //   expect(await ethOwnerNexusClient.account.getAddress()).toBeTruthy()
+  // })
 
   test("should read estimated user op gas values", async () => {
     const userOp = await nexusClient.prepareUserOperation({
@@ -234,7 +227,7 @@ describe("nexus.client", async () => {
         module: {
           type: "validator",
           address: addresses.K1Validator,
-          context: "0x"
+          data: "0x"
         }
       }),
       nexusClient.supportsExecutionMode({
@@ -259,17 +252,4 @@ describe("nexus.client", async () => {
     expect(status).toBe("success")
     expect(balanceAfter - balanceBefore).toBe(2n)
   })
-
-  // Not working
-  test.skip("should uninstall modules", async () => {
-    const result = await nexusClient.uninstallModules({
-      modules: [
-        {
-          type: "validator",
-          address: addresses.K1Validator,
-          context: "0x"
-        }
-      ]
-    })
-  })
 })