improve: define Solana block explorer formatting (#1191)

Signed-off-by: bennett <bennett@umaproject.org>
Co-authored-by: Faisal Usmani <faisal.of.usmani@gmail.com>

Author: bmzig

src/utils/BlockExplorerUtils.ts

@@ -1,7 +1,9 @@
 import { ethers } from "ethers";
 import { PUBLIC_NETWORKS } from "../constants";
-import { createShortHexString } from "./FormattingUtils";
+import { createShortenedString } from "./FormattingUtils";
+import { chainIsEvm } from "./NetworkUtils";
 import { isDefined } from "./TypeGuards";
+import bs58 from "bs58";
 
 /**
  * Creates a block explorer link for a transaction or address on a given network.
@@ -49,32 +51,37 @@ function constructURL(domain: string, parts: string[]): string {
  * @param chainId The chainId to link to.
  * @returns A formatted markdown block explorer link to the given transaction hash or address on the given chainId.
  */
-function _createBlockExplorerLinkMarkdown(hex: string, chainId = 1): string | null {
+function _createBlockExplorerLinkMarkdown(addr: string, chainId = 1): string | null {
   // Attempt to resolve the block explorer domain for the given chainId.
   const explorerDomain = resolveBlockExplorerDomain(chainId);
   // If the chainId is not supported, return an unsupported link.
   if (!isDefined(explorerDomain)) {
-    return `<unsupported chain/hash ${chainId}:${hex}>}`;
+    return `<unsupported chain/hash ${chainId}:${addr}>}`;
   }
   // Ensure that the first two characters are "0x". If they are not, append them.
-  if (hex.substring(0, 2) !== "0x") {
-    hex = `0x${hex}`;
-  }
-  // Ensure that the hex string is a valid hexadecimal string.
-  if (!ethers.utils.isHexString(hex)) {
-    return null;
+  if (addr.substring(0, 2) !== "0x" && chainIsEvm(chainId)) {
+    addr = `0x${addr}`;
+    if (!ethers.utils.isHexString(addr)) {
+      return null;
+    }
   }
   // Resolve the short URL string.
-  const shortURLString = createShortHexString(hex);
-  // Iterate over the two possible hex lengths.
-  for (const [length, route] of [
-    [66, "tx"],
-    [42, "address"],
-  ] as [number, string][]) {
-    // If the hex string is the correct length, return the link.
-    if (hex.length === length) {
-      return `<${constructURL(explorerDomain, [route, hex])} | ${shortURLString}>`;
+  const shortURLString = createShortenedString(addr);
+  if (chainIsEvm(chainId)) {
+    // Iterate over the two possible addr lengths.
+    for (const [length, route] of [
+      [66, "tx"],
+      [42, "address"],
+    ] as [number, string][]) {
+      // If the hex string is the correct length, return the link.
+      if (addr.length === length) {
+        return `<${constructURL(explorerDomain, [route, addr])} | ${shortURLString}>`;
+      }
     }
+  } else {
+    const addrLength = bs58.decode(addr).length;
+    const route = addrLength === 32 ? "account" : "tx";
+    return `<${constructURL(explorerDomain, [route, addr])} | ${shortURLString}>`;
   }
   return null;
 }

src/utils/FormattingUtils.ts

@@ -62,9 +62,9 @@ export const formatFeePct = (relayerFeePct: BN): string => {
  * @param maxLength The maximum length of the shortened string. Defaults to 8.
  * @param delimiter The delimiter to use in the middle of the shortened string. Defaults to "...".
  * @returns The shortened hexadecimal string.
- * @example createShortHexString("0x772871a444c6e4e9903d8533a5a13101b74037158123e6709470f0afbf6e7d94") -> "0x7787...7d94"
+ * @example createShortenedString("0x772871a444c6e4e9903d8533a5a13101b74037158123e6709470f0afbf6e7d94") -> "0x7787...7d94"
  */
-export function createShortHexString(hex: string, maxLength = 8, delimiter = ".."): string {
+export function createShortenedString(hex: string, maxLength = 8, delimiter = ".."): string {
   // If we have more maxLength then the hex size, we can simply
   // return the hex directly.
   if (hex.length <= maxLength) {
@@ -134,10 +134,10 @@ export function formatGwei(weiVal: string): string {
  * Shortens a list of addresses to a shorter version with only the first 10 characters.
  * @param addresses A list of addresses to shorten.
  * @returns A list of shortened addresses.
- * @see createShortHexString
+ * @see createShortenedString
  */
 export function shortenHexStrings(addresses: string[]): string[] {
-  return addresses.map((h) => createShortHexString(h));
+  return addresses.map((h) => createShortenedString(h));
 }
 
 // formatWei converts a string or BN instance from Wei to Ether, e.g., 1e19 -> 10.