refactor: optimize encode with async params (#2636)

Author: joaquim-verges

.changeset/hot-forks-live.md

@@ -0,0 +1,5 @@
+---
+"thirdweb": patch
+---
+
+Optimie encode by caching asyncParams

packages/thirdweb/package.json

@@ -227,7 +227,7 @@
     "test:watch": "vitest -c ./test/vitest.config.ts dev",
     "test": "vitest run -c ./test/vitest.config.ts --coverage --bail=1",
     "test:cov": "vitest dev -c ./test/vitest.config.ts --coverage",
-    "test:dev": "vitest dev -c ./test/vitest.config.ts",
+    "test:dev": "vitest run -c ./test/vitest.config.ts",
     "typedoc": "node scripts/typedoc.mjs",
     "update-version": "node scripts/version.mjs"
   },

packages/thirdweb/src/extensions/erc4337/account/permissions.test.ts

@@ -17,14 +17,13 @@ import { simulateTransaction } from "../../../transaction/actions/simulate.js";
 import { addAdmin } from "./addAdmin.js";
 import { getAllAdmins } from "../__generated__/IAccountPermissions/read/getAllAdmins.js";
 import { removeAdmin } from "./removeAdmin.js";
-import { getAllSigners } from "../__generated__/IAccountPermissions/read/getAllSigners.js";
 import { addSessionKey } from "./addSessionKey.js";
 import { parseEventLogs } from "../../../event/actions/parse-logs.js";
 import { adminUpdatedEvent } from "../__generated__/IAccountPermissions/events/AdminUpdated.js";
 import { signerPermissionsUpdatedEvent } from "../__generated__/IAccountPermissions/events/SignerPermissionsUpdated.js";
 import { ADDRESS_ZERO } from "../../../constants/addresses.js";
 
-describe.todo("Account Permissions", () => {
+describe("Account Permissions", () => {
   let accountFactoryContract: ThirdwebContract;
   let accountContract: ThirdwebContract;
 
@@ -57,74 +56,55 @@ describe.todo("Account Permissions", () => {
     });
   });
 
-  it("should fetch the correct inital state", async () => {
-    const admins = await getAllAdmins({
+  it("should allow adding admins", async () => {
+    let admins = await getAllAdmins({
       contract: accountContract,
     });
     expect(admins).toEqual([TEST_ACCOUNT_A.address]);
-  });
-
-  it("should allow adding admins", async () => {
-    const receipt = await sendAndConfirmTransaction({
+    let receipt = await sendAndConfirmTransaction({
       transaction: addAdmin({
         account: TEST_ACCOUNT_A,
         contract: accountContract,
         adminAddress: TEST_ACCOUNT_B.address,
       }),
       account: TEST_ACCOUNT_A,
     });
-    const logs = parseEventLogs({
+    let logs = parseEventLogs({
       events: [adminUpdatedEvent()],
       logs: receipt.logs,
     });
     expect(logs.length).toBe(1);
     expect(logs[0]?.args.signer).toBe(TEST_ACCOUNT_B.address);
     expect(logs[0]?.args.isAdmin).toBe(true);
-  });
-
-  it("should fetch the correct state after adding", async () => {
-    const admins = await getAllAdmins({
+    admins = await getAllAdmins({
       contract: accountContract,
     });
     expect(admins.length).toBe(2);
     expect(admins).toStrictEqual([
       TEST_ACCOUNT_A.address,
       TEST_ACCOUNT_B.address,
     ]);
-  });
-
-  it("should allow removing admins", async () => {
-    const receipt = await sendAndConfirmTransaction({
+    receipt = await sendAndConfirmTransaction({
       transaction: removeAdmin({
         account: TEST_ACCOUNT_B,
         contract: accountContract,
         adminAddress: TEST_ACCOUNT_A.address,
       }),
       account: TEST_ACCOUNT_B,
     });
-    const logs = parseEventLogs({
+    logs = parseEventLogs({
       events: [adminUpdatedEvent()],
       logs: receipt.logs,
     });
     expect(logs[0]?.args.signer).toBe(TEST_ACCOUNT_A.address);
     expect(logs[0]?.args.isAdmin).toBe(false);
-  });
-
-  it("should fetch the correct state after removing", async () => {
-    const admins = await getAllAdmins({
+    admins = await getAllAdmins({
       contract: accountContract,
     });
     expect(admins.length).toBe(1);
     expect(admins).toStrictEqual([TEST_ACCOUNT_B.address]);
   });
 
-  it("should fetch the correct before adding a session key", async () => {
-    const signers = await getAllSigners({
-      contract: accountContract,
-    });
-    expect(signers).toEqual([]);
-  });
-
   it("should allow adding session keys", async () => {
     const receipt = await sendAndConfirmTransaction({
       transaction: addSessionKey({
@@ -143,6 +123,8 @@ describe.todo("Account Permissions", () => {
     });
     expect(logs[0]?.args.authorizingSigner).toBe(TEST_ACCOUNT_B.address);
     expect(logs[0]?.args.targetSigner).toBe(TEST_ACCOUNT_A.address);
-    expect(logs[0]?.args.permissions.approvedTargets).toBe([ADDRESS_ZERO]);
+    expect(logs[0]?.args.permissions.approvedTargets).toStrictEqual([
+      ADDRESS_ZERO,
+    ]);
   });
 });

packages/thirdweb/src/transaction/actions/encode.ts

@@ -2,6 +2,11 @@ import type { Hex } from "../../utils/encoding/hex.js";
 import type { PreparedTransaction } from "../prepare-transaction.js";
 import type { Abi, AbiFunction } from "abitype";
 
+const encodeWeakMap = new WeakMap<
+  PreparedTransaction<Abi, AbiFunction>,
+  Promise<Hex>
+>();
+
 /**
  * Encodes a transaction object into a hexadecimal string representation of the encoded data.
  * @param transaction - The transaction object to encode.
@@ -16,15 +21,23 @@ import type { Abi, AbiFunction } from "abitype";
 export async function encode<abi extends Abi, abiFn extends AbiFunction>(
   transaction: PreparedTransaction<abi, abiFn>,
 ): Promise<Hex> {
-  if (transaction.data === undefined) {
-    return "0x";
+  if (encodeWeakMap.has(transaction)) {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    return encodeWeakMap.get(transaction)!;
   }
-  if (typeof transaction.data === "function") {
-    const data = await transaction.data();
-    if (!data) {
+  const promise = (async () => {
+    if (transaction.data === undefined) {
       return "0x";
     }
-    return data;
-  }
-  return transaction.data;
+    if (typeof transaction.data === "function") {
+      const data = await transaction.data();
+      if (!data) {
+        return "0x";
+      }
+      return data;
+    }
+    return transaction.data;
+  })();
+  encodeWeakMap.set(transaction, promise);
+  return promise;
 }

packages/thirdweb/test/vitest.config.ts

@@ -16,7 +16,7 @@ export default defineConfig({
       all: true,
       provider: "v8",
       reporter: process.env.CI ? ["lcov"] : ["text", "json", "html"],
-      exclude: ["**/*.test.ts", "**/test/**"],
+      exclude: ["**/*.test.ts", "**/test/**", "**/__generated__/**"],
       include: ["src/**"],
     },
     environment: "node",