[SDK] fromGwei helper function (#2736)

Author: gregfromstl

.changeset/fast-hairs-accept.md

@@ -0,0 +1,5 @@
+---
+"thirdweb": minor
+---
+
+Adds fromGwei unit converter

packages/thirdweb/src/exports/thirdweb.ts

@@ -147,7 +147,7 @@ export type { NFT } from "../utils/nft/parseNft.js";
 /**
  * UNITS
  */
-export { toEther, toTokens, toUnits, toWei } from "../utils/units.js";
+export { toEther, toTokens, toUnits, toWei, fromGwei } from "../utils/units.js";
 
 export {
   getBuyWithCryptoQuote,

packages/thirdweb/src/exports/utils.ts

@@ -7,7 +7,7 @@ export { ensureBytecodePrefix } from "../utils/bytecode/prefix.js";
 export { resolveImplementation } from "../utils/bytecode/resolveImplementation.js";
 
 // units
-export { toEther, toTokens, toUnits, toWei } from "../utils/units.js";
+export { toEther, toTokens, toUnits, toWei, fromGwei } from "../utils/units.js";
 
 // any-evm utils
 export {

packages/thirdweb/src/utils/units.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "vitest";
-import { toEther, toTokens, toUnits, toWei } from "./units.js";
+import { fromGwei, toEther, toTokens, toUnits, toWei } from "./units.js";
 
 describe("toTokens", () => {
   it("converts value to number", () => {
@@ -268,3 +268,46 @@ describe("toWei", () => {
     );
   });
 });
+
+describe("fromGwei", () => {
+  it("converts gwei to wei correctly", () => {
+    expect(fromGwei("1")).toMatchInlineSnapshot("1000000000n");
+    expect(fromGwei("10")).toMatchInlineSnapshot("10000000000n");
+    expect(fromGwei("100")).toMatchInlineSnapshot("100000000000n");
+    expect(fromGwei("1000")).toMatchInlineSnapshot("1000000000000n");
+    expect(fromGwei("12345")).toMatchInlineSnapshot("12345000000000n");
+    expect(fromGwei("0")).toMatchInlineSnapshot("0n");
+    expect(fromGwei("-1")).toMatchInlineSnapshot("-1000000000n");
+    expect(fromGwei("-10")).toMatchInlineSnapshot("-10000000000n");
+    expect(fromGwei("-100")).toMatchInlineSnapshot("-100000000000n");
+    expect(fromGwei("-1000")).toMatchInlineSnapshot("-1000000000000n");
+    expect(fromGwei("-12345")).toMatchInlineSnapshot("-12345000000000n");
+  });
+
+  it("handles fractional gwei inputs", () => {
+    expect(fromGwei("1.2345")).toMatchInlineSnapshot("1234500000n");
+    expect(fromGwei("10.6789")).toMatchInlineSnapshot("10678900000n");
+    expect(fromGwei("0.0001")).toMatchInlineSnapshot("100000n");
+    expect(fromGwei("0.9999")).toMatchInlineSnapshot("999900000n");
+    expect(fromGwei("-1.2345")).toMatchInlineSnapshot("-1234500000n");
+    expect(fromGwei("-10.6789")).toMatchInlineSnapshot("-10678900000n");
+    expect(fromGwei("-0.0001")).toMatchInlineSnapshot("-100000n");
+    expect(fromGwei("-0.9999")).toMatchInlineSnapshot("-999900000n");
+  });
+
+  // I'm not sure there is any case that gwei would be fractional, but just in case someone tries it
+  it("rounds fractional gwei inputs correctly and trims excessive decimals", () => {
+    expect(fromGwei("1.000000000000008")).toMatchInlineSnapshot("1000000000n");
+    expect(fromGwei("1.000000000000004")).toMatchInlineSnapshot("1000000000n");
+    expect(fromGwei("0.0000000000000001")).toMatchInlineSnapshot("0n");
+    expect(fromGwei("0.0000000000000009")).toMatchInlineSnapshot("0n");
+    expect(fromGwei("-1.000000000000008")).toMatchInlineSnapshot(
+      "-1000000000n",
+    );
+    expect(fromGwei("-1.000000000000004")).toMatchInlineSnapshot(
+      "-1000000000n",
+    );
+    expect(fromGwei("-0.0000000000000001")).toMatchInlineSnapshot("0n");
+    expect(fromGwei("-0.0000000000000009")).toMatchInlineSnapshot("0n");
+  });
+});

packages/thirdweb/src/utils/units.ts

@@ -130,3 +130,19 @@ export function toUnits(tokens: string, decimals: number): bigint {
 export function toWei(tokens: string) {
   return toUnits(tokens, 18);
 }
+
+/**
+ * Converts the specified number from gwei to wei.
+ * @param gwei The number of gwei to convert.
+ * @returns The converted value in wei.
+ * @example
+ * ```ts
+ * import { fromGwei } from "thirdweb/utils";
+ * fromGwei('1')
+ * // 1000000000n
+ * ```
+ * @utils
+ */
+export function fromGwei(gwei: string) {
+  return toUnits(gwei, 9);
+}