[SDK] bytes32 salt for deterministic deployment (#6274)

Author: kumaryash90

.changeset/popular-ligers-taste.md

@@ -0,0 +1,5 @@
+---
+"thirdweb": patch
+---
+
+bytes32 salt for deterministic deployment

packages/thirdweb/src/contract/deployment/deploy-deterministic.test.ts

@@ -7,6 +7,8 @@ import {
 import { TEST_CLIENT } from "../../../test/src/test-clients.js";
 import { TEST_ACCOUNT_A } from "../../../test/src/test-wallets.js";
 import { simulateTransaction } from "../../transaction/actions/simulate.js";
+import { computePublishedContractAddress } from "../../utils/any-evm/compute-published-contract-address.js";
+import { keccakId } from "../../utils/any-evm/keccak-id.js";
 import { ENTRYPOINT_ADDRESS_v0_6 } from "../../wallets/smart/lib/constants.js";
 import { prepareDeterministicDeployTransaction } from "./deploy-deterministic.js";
 
@@ -51,6 +53,16 @@ describe.runIf(process.env.TW_SECRET_KEY)("deployFromMetadata", () => {
       salt: "some-salt",
     });
     const tx2 = prepareDeterministicDeployTransaction({
+      chain: FORKED_ETHEREUM_CHAIN,
+      client: TEST_CLIENT,
+      contractId: "AccountFactory",
+      constructorParams: {
+        defaultAdmin: TEST_ACCOUNT_A.address,
+        entrypoint: ENTRYPOINT_ADDRESS_v0_6,
+      },
+      salt: keccakId("some-salt"),
+    });
+    const tx3 = prepareDeterministicDeployTransaction({
       chain: FORKED_OPTIMISM_CHAIN,
       client: TEST_CLIENT,
       contractId: "AccountFactory",
@@ -59,11 +71,42 @@ describe.runIf(process.env.TW_SECRET_KEY)("deployFromMetadata", () => {
         entrypoint: ENTRYPOINT_ADDRESS_v0_6,
       },
     });
-    const [tx1Result, tx2Result] = await Promise.all([
+    const [tx1Result, tx2Result, tx3Result] = await Promise.all([
       simulateTransaction({ transaction: tx1 }),
       simulateTransaction({ transaction: tx2 }),
+      simulateTransaction({ transaction: tx3 }),
+    ]);
+    expect(tx1Result === tx2Result).toBe(true);
+    expect(tx1Result !== tx3Result).toBe(true);
+  });
+
+  it("computed address and deployed address should match", async () => {
+    const computedPromise = computePublishedContractAddress({
+      chain: FORKED_ETHEREUM_CHAIN,
+      client: TEST_CLIENT,
+      contractId: "AccountFactory",
+      constructorParams: {
+        defaultAdmin: TEST_ACCOUNT_A.address,
+        entrypoint: ENTRYPOINT_ADDRESS_v0_6,
+      },
+      salt: keccakId("some-salt"),
+    });
+    const tx = prepareDeterministicDeployTransaction({
+      chain: FORKED_ETHEREUM_CHAIN,
+      client: TEST_CLIENT,
+      contractId: "AccountFactory",
+      constructorParams: {
+        defaultAdmin: TEST_ACCOUNT_A.address,
+        entrypoint: ENTRYPOINT_ADDRESS_v0_6,
+      },
+      salt: keccakId("some-salt"),
+    });
+
+    const [computed, txResult] = await Promise.all([
+      computedPromise,
+      simulateTransaction({ transaction: tx }),
     ]);
-    expect(tx1Result !== tx2Result).toBe(true);
+    expect(computed === txResult).toBe(true);
   });
   // TODO: Replace these tests' live contracts with mocks
   it("should deploy a published contract with no constructor", async () => {

packages/thirdweb/src/contract/deployment/zksync/zkDeployDeterministic.ts

@@ -13,7 +13,11 @@ import {
 } from "../../../utils/any-evm/zksync/constants.js";
 import { isContractDeployed } from "../../../utils/bytecode/is-contract-deployed.js";
 import { ensureBytecodePrefix } from "../../../utils/bytecode/prefix.js";
-import { type Hex, uint8ArrayToHex } from "../../../utils/encoding/hex.js";
+import {
+  type Hex,
+  isHex,
+  uint8ArrayToHex,
+} from "../../../utils/encoding/hex.js";
 import type { ClientAndChainAndAccount } from "../../../utils/types.js";
 import { getContract } from "../../contract.js";
 import { zkDeployContract } from "./zkDeployContract.js";
@@ -89,7 +93,11 @@ export async function zkDeployContractDeterministic(
       abi: parseAbi(singletonFactoryAbi),
     });
 
-    const salt = options?.salt ? keccakId(options.salt) : keccakId("thirdweb");
+    const salt = options?.salt
+      ? isHex(options.salt) && options.salt.length === 66
+        ? options.salt
+        : keccakId(options.salt)
+      : keccakId("thirdweb");
 
     await sendAndConfirmTransaction({
       account: options.account,

packages/thirdweb/src/utils/any-evm/compute-deployment-address.ts

@@ -1,6 +1,7 @@
 import { type Hex, encodePacked } from "viem";
 import { getAddress } from "../address.js";
 import { ensureBytecodePrefix } from "../bytecode/prefix.js";
+import { isHex } from "../encoding/hex.js";
 import { keccak256 } from "../hashing/keccak256.js";
 import { getSaltHash } from "./get-salt-hash.js";
 import { keccakId } from "./keccak-id.js";
@@ -33,7 +34,9 @@ export function computeDeploymentAddress(
 ) {
   const bytecode = ensureBytecodePrefix(options.bytecode);
   const saltHash = options.salt
-    ? keccakId(options.salt)
+    ? isHex(options.salt) && options.salt.length === 66
+      ? options.salt
+      : keccakId(options.salt)
     : getSaltHash(bytecode);
 
   // 1. create init bytecode hash with contract's bytecode and encoded args

packages/thirdweb/src/utils/any-evm/compute-published-contract-deploy-info.ts

@@ -96,5 +96,6 @@ export async function computeDeploymentInfoFromBytecode(args: {
     initBytecodeWithsalt,
     encodedArgs,
     create2FactoryAddress,
+    salt,
   };
 }

packages/thirdweb/src/utils/any-evm/get-init-bytecode-with-salt.ts

@@ -1,6 +1,6 @@
 import { encodePacked } from "viem/utils";
 import { ensureBytecodePrefix } from "../bytecode/prefix.js";
-import { type Hex, uint8ArrayToHex } from "../encoding/hex.js";
+import { type Hex, isHex, uint8ArrayToHex } from "../encoding/hex.js";
 import { getSaltHash } from "./get-salt-hash.js";
 import { keccakId } from "./keccak-id.js";
 
@@ -29,8 +29,11 @@ export function getInitBytecodeWithSalt(
   options: GetInitiBytecodeWithSaltOptions,
 ): Hex {
   const bytecode = ensureBytecodePrefix(options.bytecode);
+
   const saltHash = options.salt
-    ? keccakId(options.salt)
+    ? isHex(options.salt) && options.salt.length === 66
+      ? options.salt
+      : keccakId(options.salt)
     : getSaltHash(bytecode);
 
   const encodedArgs =

packages/thirdweb/src/utils/any-evm/zksync/computeDeploymentAddress.ts

@@ -1,5 +1,5 @@
 import type { Address } from "../../address.js";
-import type { Hex } from "../../encoding/hex.js";
+import { type Hex, isHex } from "../../encoding/hex.js";
 import { keccakId } from "../keccak-id.js";
 import { create2Address } from "./create2Address.js";
 
@@ -13,7 +13,11 @@ type ComputeDeploymentAddressOptions = {
 export function computeDeploymentAddress(
   options: ComputeDeploymentAddressOptions,
 ) {
-  const saltHash = options.salt ? keccakId(options.salt) : keccakId("thirdweb");
+  const saltHash = options.salt
+    ? isHex(options.salt) && options.salt.length === 66
+      ? options.salt
+      : keccakId(options.salt)
+    : keccakId("thirdweb");
 
   return create2Address({
     sender: options.create2FactoryAddress,