shortenAddress util (#2995)

Author: gregfromstl

.changeset/sixty-forks-repeat.md

@@ -0,0 +1,5 @@
+---
+"thirdweb": minor
+---
+
+Adds shortenAddress util

packages/thirdweb/src/exports/utils.ts

@@ -124,6 +124,7 @@ export {
   checksumAddress,
   getAddress,
   isAddress,
+  shortenAddress,
   type Address,
   type AddressInput,
 } from "../utils/address.js";

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

@@ -1,6 +1,11 @@
 import { describe, expect, test } from "vitest";
 
-import { checksumAddress, getAddress, isAddress } from "./address.js";
+import {
+  checksumAddress,
+  getAddress,
+  isAddress,
+  shortenAddress,
+} from "./address.js";
 
 describe("getAddress", () => {
   test("checksums address", () => {
@@ -81,3 +86,11 @@ describe("checksumAddress", () => {
     ).toMatchInlineSnapshot('"0x15d34AAf54267DB7D7c367839AAf71A00a2C6A65"');
   });
 });
+
+describe("shortenAddress", () => {
+  test("shortens address", () => {
+    expect(
+      shortenAddress("0xa0cf798816d4b9b9866b5330eea46a18382f251e"),
+    ).toMatchInlineSnapshot('"0xA0...251e"');
+  });
+});

packages/thirdweb/src/utils/address.ts

@@ -95,3 +95,22 @@ export function getAddress(address: string): Address {
   }
   return checksumAddress(address);
 }
+
+/**
+ * Checksums and formats an address if valid. Note this function does not check if the provided address is an ENS.
+ * @param address - The address to shorten.
+ * @param length - The number of characters to keep from the start and end of the address.
+ * @returns The shortened address.
+ * @example
+ * ```ts
+ * import { shortenAddress } from 'thirdweb/utils';
+ *
+ * shortenAddress('0x5aAeb6053F3E94C9b9A09f33669435E7Ef1BeAed');
+ * //=> '0x5aAe...Ef1BeAed'
+ * ```
+ * @utils
+ */
+export function shortenAddress(address: Address, length = 4) {
+  const _address = getAddress(address);
+  return `${_address.slice(0, length)}...${_address.slice(-length)}`;
+}