feat: simulate user op tests + ts doc

src/account/BiconomySmartAccountV2.ts

@@ -1527,6 +1527,8 @@ export class BiconomySmartAccountV2 extends BaseSmartContractAccount {
   /**
    * Builds a user operation
    *
+   * This method will also simulate the validation and execution of the user operation, telling the user if the user operation will be successful or not.
+   *
    * - Docs: https://docs.biconomy.io/Account/transactions/userpaid#build-useroperation
    *
    * @param transactions Array of {@link Transaction} to be sent.

tests/account/read.test.ts

@@ -807,4 +807,76 @@ describe("Account:Read", () => {
 
     expect(isVerified).toBeTruthy()
   })
+
+  test.concurrent(
+    "should simulate a user operation execution, expecting to fail",
+    async () => {
+      const smartAccount = await createSmartAccountClient({
+        signer: walletClient,
+        bundlerUrl
+      })
+
+      console.log(smartAccountAddress, "smartAccountAdderss")
+
+      const balances = await smartAccount.getBalances()
+      expect(balances[0].amount).toBeGreaterThan(0n)
+
+      const encodedCall = encodeFunctionData({
+        abi: parseAbi(["function deposit()"]),
+        functionName: "deposit"
+      })
+
+      const amoyTestContract = "0x59Dbe91FBa486CA10E4ad589688Fe547a48bd62A"
+
+      // fail if value is not bigger than 1
+      // the contract call requires a deposit of at least 1 wei
+      const tx1 = {
+        to: amoyTestContract as Hex,
+        data: encodedCall,
+        value: 0
+      }
+      const tx2 = {
+        to: amoyTestContract as Hex,
+        data: encodedCall,
+        value: 2
+      }
+
+      await expect(smartAccount.buildUserOp([tx1, tx2])).rejects.toThrow()
+    }
+  )
+
+  test.concurrent(
+    "should simulate a user operation execution, expecting to pass execution",
+    async () => {
+      const smartAccount = await createSmartAccountClient({
+        signer: walletClient,
+        bundlerUrl
+      })
+
+      const balances = await smartAccount.getBalances()
+      expect(balances[0].amount).toBeGreaterThan(0n)
+
+      const encodedCall = encodeFunctionData({
+        abi: parseAbi(["function deposit()"]),
+        functionName: "deposit"
+      })
+
+      const amoyTestContract = "0x59Dbe91FBa486CA10E4ad589688Fe547a48bd62A"
+
+      // fail if value is not bigger than 1
+      // the contract call requires a deposit of at least 1 wei
+      const tx1 = {
+        to: amoyTestContract as Hex,
+        data: encodedCall,
+        value: 2
+      }
+      const tx2 = {
+        to: amoyTestContract as Hex,
+        data: encodedCall,
+        value: 2
+      }
+
+      await expect(smartAccount.buildUserOp([tx1, tx2])).resolves.toBeTruthy()
+    }
+  )
 })