Custom gas settings for any evm deployments (#2678)

Co-authored-by: Jonas Daniels <jonas.daniels@outlook.com>

Author: kumaryash90

.changeset/green-fireants-compete.md

@@ -0,0 +1,6 @@
+---
+"@thirdweb-dev/sdk": patch
+"thirdweb": patch
+---
+
+Custom gas settings for any evm deployments

legacy_packages/sdk/src/evm/common/any-evm-constants.ts

@@ -19,6 +19,26 @@ export const ERROR_SUBSTRINGS_COMPOSITE = [
   ["wrong", "chainid"],
 ];
 
+export const CUSTOM_GAS_BINS = [
+  1,
+  1 * 10 ** 9,
+  100 * 10 ** 9,
+  500 * 10 ** 9,
+  1000 * 10 ** 9,
+  2500 * 10 ** 9,
+  5000 * 10 ** 9,
+  7500 * 10 ** 9,
+  10_000 * 10 ** 9,
+  25_000 * 10 ** 9,
+  50_000 * 10 ** 9,
+  75_000 * 10 ** 9,
+  100_000 * 10 ** 9,
+  250_000 * 10 ** 9,
+  500_000 * 10 ** 9,
+  750_000 * 10 ** 9,
+  1_000_000 * 10 ** 9,
+];
+
 /* eslint-disable no-useless-computed-key */
 export const CUSTOM_GAS_FOR_CHAIN: Record<number, CustomChain> = {
   [5001]: {

legacy_packages/sdk/src/evm/common/any-evm-utils/deployCreate2Factory.ts

@@ -1,11 +1,7 @@
-import { BigNumber, Signer } from "ethers";
+import { Signer } from "ethers";
 import invariant from "tiny-invariant";
 import type { DeployOptions } from "../../types/deploy/deploy-options";
-import { CUSTOM_GAS_FOR_CHAIN } from "../any-evm-constants";
-import { COMMON_FACTORY } from "./constants";
-import { isContractDeployed } from "./isContractDeployed";
-import { isEIP155Enforced } from "./isEIP155Enforced";
-import { getCreate2FactoryDeploymentInfo } from "./getCreate2FactoryDeploymentInfo";
+import { computeCreate2FactoryTransaction } from "./getCreate2FactoryAddress";
 
 /**
  * Deploy Nick's Create2 factory on a given network.
@@ -21,52 +17,19 @@ export async function deployCreate2Factory(
   options?: DeployOptions,
 ): Promise<string> {
   invariant(signer.provider, "No provider");
-  const commonFactoryExists = await isContractDeployed(
-    COMMON_FACTORY,
+  const deploymentInfo = await computeCreate2FactoryTransaction(
     signer.provider,
   );
-  if (commonFactoryExists) {
-    return COMMON_FACTORY;
-  }
-
-  const enforceEip155 = await isEIP155Enforced(signer.provider);
-  const networkId = (await signer.provider.getNetwork()).chainId;
-  const chainId = enforceEip155 ? networkId : 0;
-  console.debug(`ChainId ${networkId} enforces EIP155: ${enforceEip155}`);
-  const deploymentInfo = CUSTOM_GAS_FOR_CHAIN[networkId]
-    ? getCreate2FactoryDeploymentInfo(chainId, {
-        gasPrice: CUSTOM_GAS_FOR_CHAIN[networkId].gasPrice,
-        gasLimit: CUSTOM_GAS_FOR_CHAIN[networkId].gasLimit,
-      })
-    : getCreate2FactoryDeploymentInfo(chainId, {});
-
-  const factoryExists = await isContractDeployed(
-    deploymentInfo.deployment,
-    signer.provider,
-  );
-
-  // deploy community factory if not already deployed
-  if (!factoryExists) {
-    const gasPrice = CUSTOM_GAS_FOR_CHAIN[networkId]?.gasPrice
-      ? CUSTOM_GAS_FOR_CHAIN[networkId].gasPrice
-      : 100 * 10 ** 9;
-    const gasLimit = CUSTOM_GAS_FOR_CHAIN[networkId]?.gasLimit
-      ? CUSTOM_GAS_FOR_CHAIN[networkId].gasLimit
-      : 100000;
-
-    invariant(gasLimit, "gasLimit undefined for create2 factory deploy");
-    invariant(gasPrice, "gasPrice undefined for create2 factory deploy");
 
+  if (deploymentInfo.transaction.length > 0) {
     // send balance to the keyless signer
-    const valueToSend = BigNumber.from(gasPrice).mul(gasLimit);
-
     if (
-      (await signer.provider.getBalance(deploymentInfo.signer)).lt(valueToSend)
+      (await signer.provider.getBalance(deploymentInfo.signer)).lt(deploymentInfo.valueToSend)
     ) {
       await (
         await signer.sendTransaction({
           to: deploymentInfo.signer,
-          value: valueToSend,
+          value: deploymentInfo.valueToSend,
         })
       ).wait();
     }

legacy_packages/sdk/src/evm/common/any-evm-utils/getCreate2FactoryAddress.ts

@@ -1,9 +1,10 @@
-import { providers } from "ethers";
-import { CUSTOM_GAS_FOR_CHAIN } from "../any-evm-constants";
+import { BigNumber, providers } from "ethers";
+import { CUSTOM_GAS_BINS, CUSTOM_GAS_FOR_CHAIN } from "../any-evm-constants";
 import { COMMON_FACTORY } from "./constants";
 import { isContractDeployed } from "./isContractDeployed";
 import { isEIP155Enforced } from "./isEIP155Enforced";
 import { getCreate2FactoryDeploymentInfo } from "./getCreate2FactoryDeploymentInfo";
+import { KeylessDeploymentInfo } from "../../types/any-evm/deploy-data";
 
 /**
  * Get the CREATE2 Factory address for a network
@@ -16,23 +17,78 @@ import { getCreate2FactoryDeploymentInfo } from "./getCreate2FactoryDeploymentIn
 export async function getCreate2FactoryAddress(
   provider: providers.Provider,
 ): Promise<string> {
-  const commonFactoryExists = await isContractDeployed(
-    COMMON_FACTORY,
-    provider,
+  const deploymentInfo = await computeCreate2FactoryTransaction(provider);
+  return deploymentInfo.deployment;
+}
+
+/**
+ * @internal
+ */
+export async function computeCreate2FactoryTransaction(
+  provider: providers.Provider,
+): Promise<KeylessDeploymentInfo> {
+  const networkId = (await provider.getNetwork()).chainId;
+
+  // special handling for chains with hardcoded gasPrice and gasLimit
+  if (CUSTOM_GAS_FOR_CHAIN[networkId]) {
+    const enforceEip155 = await isEIP155Enforced(provider);
+    const chainId = enforceEip155 ? networkId : 0;
+    const gasPrice = CUSTOM_GAS_FOR_CHAIN[networkId]?.gasPrice;
+    const gasLimit = CUSTOM_GAS_FOR_CHAIN[networkId]?.gasLimit;
+
+    const deploymentInfo = getCreate2FactoryDeploymentInfo(chainId, {
+      gasPrice: gasPrice ? BigNumber.from(gasPrice) : undefined,
+      gasLimit: gasLimit ? BigNumber.from(gasLimit) : undefined,
+    });
+
+    if (await isContractDeployed(deploymentInfo.deployment, provider)) {
+      deploymentInfo.transaction = "";
+    }
+
+    return deploymentInfo;
+  }
+
+  // default flow
+  const allBinsInfo = [
+    ...CUSTOM_GAS_BINS.map((b) =>
+      // to generate EIP-155 transaction
+      getCreate2FactoryDeploymentInfo(networkId, { gasPrice: BigNumber.from(b) }),
+    ),
+    // to generate pre-EIP-155 transaction, hence chainId 0
+    ...CUSTOM_GAS_BINS.map((b) =>
+      getCreate2FactoryDeploymentInfo(0, { gasPrice: BigNumber.from(b) }),
+    ),
+  ];
+
+  const allFactories = await Promise.all(
+    allBinsInfo.map((b) => isContractDeployed(b.deployment, provider)),
   );
-  if (commonFactoryExists) {
-    return COMMON_FACTORY;
+
+  const indexOfCommonFactory = allBinsInfo.findIndex(
+    (b) => b.deployment === COMMON_FACTORY,
+  );
+  if (indexOfCommonFactory && allFactories[indexOfCommonFactory]) {
+    return { ...allBinsInfo[indexOfCommonFactory], transaction: "" };
   }
 
-  const enforceEip155 = await isEIP155Enforced(provider);
-  const networkId = (await provider.getNetwork()).chainId;
+  const indexOfExistingDeployment = allFactories.findIndex((b) => b);
+  if (indexOfExistingDeployment && allBinsInfo[indexOfExistingDeployment]) {
+    return { ...allBinsInfo[indexOfExistingDeployment], transaction: "" };
+  }
+
+  const [enforceEip155, gasPriceFetched] = await Promise.all([
+    isEIP155Enforced(provider),
+    provider.getGasPrice(),
+  ]);
   const chainId = enforceEip155 ? networkId : 0;
-  const deploymentInfo = CUSTOM_GAS_FOR_CHAIN[networkId]
-    ? getCreate2FactoryDeploymentInfo(chainId, {
-        gasPrice: CUSTOM_GAS_FOR_CHAIN[networkId].gasPrice,
-        gasLimit: CUSTOM_GAS_FOR_CHAIN[networkId].gasLimit,
-      })
-    : getCreate2FactoryDeploymentInfo(chainId, {});
+  const bin = _getNearestGasPriceBin(gasPriceFetched);
 
-  return deploymentInfo.deployment;
+  return getCreate2FactoryDeploymentInfo(chainId, {
+    gasPrice: bin,
+  });
+}
+
+function _getNearestGasPriceBin(gasPrice: BigNumber): BigNumber {
+  const bin = CUSTOM_GAS_BINS.find((e) => BigNumber.from(e).gte(gasPrice));
+  return bin ? BigNumber.from(bin) : gasPrice;
 }

legacy_packages/sdk/src/evm/common/any-evm-utils/getCreate2FactoryDeploymentInfo.ts

@@ -1,4 +1,4 @@
-import { utils } from "ethers";
+import { BigNumber, utils } from "ethers";
 import { KeylessDeploymentInfo } from "../../types/any-evm/deploy-data";
 import { SIGNATURE, CREATE2_FACTORY_BYTECODE } from "./constants";
 import { getKeylessTxn } from "./getKeylessTxn";
@@ -11,13 +11,19 @@ import { getKeylessTxn } from "./getKeylessTxn";
  */
 export function getCreate2FactoryDeploymentInfo(
   chainId: number,
-  gasOptions: { gasPrice?: number; gasLimit?: number },
+  gasOptions: { gasPrice?: BigNumber; gasLimit?: BigNumber },
 ): KeylessDeploymentInfo {
   const signature = utils.joinSignature(SIGNATURE);
+  
+  // 100000 is default deployment gas limit and 100 gwei is default gas price for create2 factory deployment
+  // (See: https://github.com/Arachnid/deterministic-deployment-proxy?tab=readme-ov-file#deployment-gas-limit)
+  const gasPrice = gasOptions.gasPrice ? gasOptions.gasPrice : 100 * 10 ** 9;
+  const gasLimit = gasOptions.gasLimit ? gasOptions.gasLimit : 100000;
+
   const deploymentTransaction = getKeylessTxn(
     {
-      gasPrice: gasOptions.gasPrice ? gasOptions.gasPrice : 100 * 10 ** 9,
-      gasLimit: gasOptions.gasLimit ? gasOptions.gasLimit : 100000,
+      gasPrice,
+      gasLimit,
       nonce: 0,
       data: CREATE2_FACTORY_BYTECODE,
       chainId: chainId,
@@ -32,5 +38,6 @@ export function getCreate2FactoryDeploymentInfo(
   return {
     ...deploymentTransaction,
     deployment: create2FactoryAddress,
+    valueToSend: BigNumber.from(gasPrice).mul(gasLimit),
   };
 }

legacy_packages/sdk/src/evm/types/any-evm/deploy-data.ts

@@ -1,4 +1,4 @@
-import { BytesLike } from "ethers";
+import { BigNumber, BytesLike } from "ethers";
 import { PreDeployMetadataFetched } from "../../schema/contracts/custom";
 import { AddressOrEns } from "../../schema/shared/AddressOrEnsSchema";
 
@@ -24,6 +24,7 @@ export type KeylessDeploymentInfo = {
   signer: string;
   transaction: string;
   deployment: string;
+  valueToSend: BigNumber;
 };
 
 export type DeployedContractType =

legacy_packages/sdk/test/evm/any-evm-keyless.test.ts

@@ -26,9 +26,30 @@ import {
   englishAuctionsBytecode,
   englishAuctionsCompilerMetadata,
 } from "./mock/englishAuctionsMetadata";
+import { getCreate2FactoryAddress } from "../../src/evm/common/any-evm-utils/getCreate2FactoryAddress";
 
 const itIf = (condition: boolean) => (condition ? it : it.skip);
 
+describe("Create2 factory addresses", async () => {
+  it("should compute correct addresses for create2 factory", async () => {
+    // pre eip155
+    sdk.updateSignerOrProvider(1);
+    expect(await getCreate2FactoryAddress(sdk.getProvider())).to.equal("0x4e59b44847b379578588920cA78FbF26c0B4956C");
+
+    // eip155
+    sdk.updateSignerOrProvider(923018);
+    expect(await getCreate2FactoryAddress(sdk.getProvider())).to.equal("0x52329130FCBD4e15B0aC7C4505fBFB530b960AE8");
+
+    // eip155 with hardcoded custom gas
+    sdk.updateSignerOrProvider(47);
+    expect(await getCreate2FactoryAddress(sdk.getProvider())).to.equal("0x4F656d8f2e13D4980149940f4C962EC4f8aF31c5");
+
+    // eip155 with custom gas bin
+    sdk.updateSignerOrProvider(2710);
+    expect(await getCreate2FactoryAddress(sdk.getProvider())).to.equal("0x5Ffe7DeB88759a70B42bc12ABe16f72ce81F0459");
+  })
+})
+
 describe("Any EVM Keyless Deploy", async () => {
   let contract: SmartContract;
   let adminWallet: SignerWithAddress;