thirdweb-dev · adam-maj · Aug 5, 2022 · Aug 4, 2022 · Aug 5, 2022 · joaquim-verges
diff --git a/docs/sdk.gascostestimator.gaslimitof.md b/docs/sdk.gascostestimator.gaslimitof.md
@@ -0,0 +1,45 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [GasCostEstimator](./sdk.gascostestimator.md) &gt; [gasLimitOf](./sdk.gascostestimator.gaslimitof.md)
+
+## GasCostEstimator.gasLimitOf() method
+
+Estimates the gas limit of a transaction Pass in the same parameters as the contract's function.
+
+<b>Signature:</b>
+
+```typescript
+gasLimitOf(fn: keyof TContract["functions"] | (string & {}), args: Parameters<TContract["functions"][typeof fn]> | any[]): Promise<BigNumber>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  fn | keyof TContract\["functions"\] \| (string &amp; {}) |  |
+|  args | Parameters&lt;TContract\["functions"\]\[typeof fn\]&gt; \| any\[\] |  |
+
+<b>Returns:</b>
+
+Promise&lt;BigNumber&gt;
+
+the estimated gas limit of the transaction
+
+## Remarks
+
+Estimates the gas limit of a transaction
+
+## Example
+
+
+```javascript
+const gasLimitOfClaim = await nftDrop?.estimator.gasLimitOf("claim", [
+  "0x...", // receiver
+  1, // quantity
+  "0x...", // currency
+  1, // price per token
+  [], // proofs
+  1, // proof max quantity per transaction
+]);
+```
+
diff --git a/docs/sdk.gascostestimator.md b/docs/sdk.gascostestimator.md
@@ -24,4 +24,5 @@ export declare class GasCostEstimator<TContract extends BaseContract>
 |  --- | --- | --- |
 |  [currentGasPriceInGwei()](./sdk.gascostestimator.currentgaspriceingwei.md) |  | Returns the current gas price in gwei |
 |  [gasCostOf(fn, args)](./sdk.gascostestimator.gascostof.md) |  | Estimates the cost of gas in native token of the current chain Pass in the same parameters as the contract's function. |
+|  [gasLimitOf(fn, args)](./sdk.gascostestimator.gaslimitof.md) |  | Estimates the gas limit of a transaction Pass in the same parameters as the contract's function. |
 
diff --git a/docs/snippets.json b/docs/snippets.json
@@ -659,6 +659,15 @@
           "javascript": "const costOfClaim = await nftDrop?.estimator.gasCostOf(\"claim\", [\n  \"0x...\", // receiver\n  1, // quantity\n  \"0x...\", // currency\n  1, // price per token\n  [], // proofs\n  1, // proof max quantity per transaction\n]);"
         },
         "reference": "https://docs.thirdweb.com/typescript/sdk.GasCostEstimator.gasCostOf"
+      },
+      {
+        "name": "gasLimitOf",
+        "summary": "Estimates the gas limit of a transaction Pass in the same parameters as the contract's function.\n\n",
+        "remarks": "\n\nEstimates the gas limit of a transaction\n\n",
+        "examples": {
+          "javascript": "const gasLimitOfClaim = await nftDrop?.estimator.gasLimitOf(\"claim\", [\n  \"0x...\", // receiver\n  1, // quantity\n  \"0x...\", // currency\n  1, // price per token\n  [], // proofs\n  1, // proof max quantity per transaction\n]);"
+        },
+        "reference": "https://docs.thirdweb.com/typescript/sdk.GasCostEstimator.gasLimitOf"
       }
     ],
     "properties": [],

diff --git a/etc/sdk.api.md b/etc/sdk.api.md
@@ -2955,6 +2955,7 @@ export class GasCostEstimator<TContract extends BaseContract> {
     constructor(contractWrapper: ContractWrapper<TContract>);
     currentGasPriceInGwei(): Promise<string>;
     gasCostOf(fn: keyof TContract["functions"] | (string & {}), args: Parameters<TContract["functions"][typeof fn]> | any[]): Promise<string>;
+    gasLimitOf(fn: keyof TContract["functions"] | (string & {}), args: Parameters<TContract["functions"][typeof fn]> | any[]): Promise<BigNumber>;
 }
 
 // @public

diff --git a/src/core/classes/gas-cost-estimator.ts b/src/core/classes/gas-cost-estimator.ts
@@ -1,5 +1,5 @@
 import { ContractWrapper } from "./contract-wrapper";
-import { BaseContract, ethers } from "ethers";
+import { BaseContract, BigNumber, ethers } from "ethers";
 
 /**
  * Estimates the gas cost of Contract calls
@@ -39,6 +39,31 @@ export class GasCostEstimator<TContract extends BaseContract> {
     return ethers.utils.formatEther(gasUnits.mul(price));
   }
 
+  /**
+   * Estimates the gas limit of a transaction
+   * Pass in the same parameters as the contract's function.
+   * @remarks Estimates the gas limit of a transaction
+   * @example
+   * ```javascript
+   * const gasLimitOfClaim = await nftDrop?.estimator.gasLimitOf("claim", [
+   *   "0x...", // receiver
+   *   1, // quantity
+   *   "0x...", // currency
+   *   1, // price per token
+   *   [], // proofs
+   *   1, // proof max quantity per transaction
+   * ]);
+   * ```
+   * @returns the estimated gas limit of the transaction
+   * @public
+   */
+  public async gasLimitOf(
+    fn: keyof TContract["functions"] | (string & {}),
+    args: Parameters<TContract["functions"][typeof fn]> | any[],
+  ): Promise<BigNumber> {
+    return this.contractWrapper.estimateGas(fn, args);
+  }
+
   /**
    * Returns the current gas price in gwei
    * @remarks Get the current gas price in gwei

diff --git a/test/edition.test.ts b/test/edition.test.ts
@@ -47,6 +47,16 @@ describe("Edition Contract", async () => {
     expect(parseFloat(cost)).gt(0);
   });
 
+  it("gas limit", async () => {
+    const limit = await bundleContract.estimator.gasLimitOf("mintTo", [
+      adminWallet.address,
+      ethers.constants.MaxUint256,
+      "mock://12398172398172389/0",
+      1,
+    ]);
+    expect(limit.toNumber()).gt(0);
+  });
+
   it("should respect pagination", async () => {
     const nfts = [];
     for (let i = 0; i < 100; i++) {