otterscan/src/use4Bytes.ts

import { useState, useEffect, useContext } from "react";
import { RuntimeContext } from "./useRuntime";
import { fourBytesURL } from "./url";

const cache = new Map<string, string | null>();

export type FourBytesEntry = {
  name: string;
  signatureWithoutParamNames: string | undefined;
  signatures: string[] | undefined;
};

const simpleTransfer: FourBytesEntry = {
  name: "Transfer",
  signatureWithoutParamNames: undefined,
  signatures: undefined,
};

const fullCache = new Map<string, FourBytesEntry | null>();

// TODO: deprecate and remove
export const use4Bytes = (rawFourBytes: string) => {
  const runtime = useContext(RuntimeContext);
  const assetsURLPrefix = runtime.config?.assetsURLPrefix;

  const [name, setName] = useState<string>();
  const [fourBytes, setFourBytes] = useState<string>();
  useEffect(() => {
    if (assetsURLPrefix === undefined || fourBytes === undefined) {
      return;
    }

    const signatureURL = fourBytesURL(assetsURLPrefix, fourBytes);
    fetch(signatureURL)
      .then(async (res) => {
        if (!res.ok) {
          console.error(`Signature does not exist in 4bytes DB: ${fourBytes}`);

          // Use the default 4 bytes as name
          setName(rawFourBytes);
          cache.set(fourBytes, null);
          return;
        }

        const sig = await res.text();
        const cut = sig.indexOf("(");
        let method = sig.slice(0, cut);
        method = method.charAt(0).toUpperCase() + method.slice(1);
        setName(method);
        cache.set(fourBytes, method);
        return;
      })
      .catch((err) => {
        console.error(`Couldn't fetch signature URL ${signatureURL}`, err);

        // Use the default 4 bytes as name
        setName(rawFourBytes);
      });
  }, [rawFourBytes, assetsURLPrefix, fourBytes]);

  if (rawFourBytes === "0x") {
    return "Transfer";
  }
  if (assetsURLPrefix === undefined) {
    return rawFourBytes;
  }

  // Try to resolve 4bytes name
  const entry = cache.get(rawFourBytes.slice(2));
  if (entry === null) {
    return rawFourBytes;
  }
  if (entry !== undefined) {
    // Simulates LRU
    cache.delete(entry);
    cache.set(rawFourBytes.slice(2), entry);
    return entry;
  }
  if (name === undefined && fourBytes === undefined) {
    setFourBytes(rawFourBytes.slice(2));
    return "";
  }

  return name;
};

export const rawInputTo4Bytes = (rawInput: string) => rawInput.slice(0, 10);

/**
 * Extract 4bytes DB info
 *
 * @param rawFourBytes an hex string containing the 4bytes signature in the "0xXXXXXXXX" format.
 */
export const use4BytesFull = (
  rawFourBytes: string
): FourBytesEntry | null | undefined => {
  if (rawFourBytes !== "0x") {
    if (rawFourBytes.length !== 10 || !rawFourBytes.startsWith("0x")) {
      throw new Error(
        `rawFourBytes must contain a 4 bytes hex method signature starting with 0x; received value: "${rawFourBytes}"`
      );
    }
  }

  const runtime = useContext(RuntimeContext);
  const assetsURLPrefix = runtime.config?.assetsURLPrefix;

  const fourBytes = rawFourBytes.slice(2);
  const [entry, setEntry] = useState<FourBytesEntry | null | undefined>(
    fullCache.get(fourBytes)
  );
  useEffect(() => {
    if (assetsURLPrefix === undefined) {
      return;
    }
    if (fourBytes === "") {
      return;
    }

    const signatureURL = fourBytesURL(assetsURLPrefix, fourBytes);
    fetch(signatureURL)
      .then(async (res) => {
        if (!res.ok) {
          console.error(`Signature does not exist in 4bytes DB: ${fourBytes}`);
          fullCache.set(fourBytes, null);
          setEntry(null);
          return;
        }

        const sig = await res.text();
        const cut = sig.indexOf("(");
        let method = sig.slice(0, cut);
        method = method.charAt(0).toUpperCase() + method.slice(1);

        const entry: FourBytesEntry = {
          name: method,
          signatureWithoutParamNames: sig,
          signatures: undefined,
        };
        setEntry(entry);
        fullCache.set(fourBytes, entry);
      })
      .catch((err) => {
        console.error(`Couldn't fetch signature URL ${signatureURL}`, err);
        setEntry(null);
        fullCache.set(fourBytes, null);
      });
  }, [fourBytes, assetsURLPrefix]);

  if (rawFourBytes === "0x") {
    return simpleTransfer;
  }
  if (assetsURLPrefix === undefined) {
    return undefined;
  }

  // Try to resolve 4bytes name
  if (entry === null || entry === undefined) {
    return entry;
  }

  // Simulates LRU
  // TODO: implement LRU purging
  fullCache.delete(fourBytes);
  fullCache.set(fourBytes, entry);
  return entry;
};