artifact.ts

import ethers from "ethers";
import { Artifact } from "hardhat/types";
import _ from "lodash";

// Stringify an ABI to JSON or human-readable format.
// The ABI can be anything that is accepted by ethers.utils.Interface.
export async function stringifyAbi(abi: any, json = true): Promise<any> {
  const iface = new hre.ethers.utils.Interface(abi);

  // See all FormatTypes: https://github.com/ethers-io/ethers.js/blob/v5.7/packages/abi/src.ts/fragments.ts#L235
  const formats = hre.ethers.utils.FormatTypes;

  if (json) {
    return iface.format(formats.json);
  }

  const out: Array<[string, string]> = [];
  for (const f of iface.fragments) {
    const decl = f.format(formats.full);
    let hash;
    switch (f.type) {
      case "function":
        hash = iface.getSighash(f);
        out.push([decl, hash]);
        break;
      case "event":
        hash = iface.getEventTopic(f as ethers.utils.EventFragment);
        out.push([decl, hash]);
        break;
      case "error":
      case "constructor":
        out.push([decl, ""]);
        break;
    }
  }

  const padLen = _.max(out.map(([decl, _hash]) => decl.length)) ?? 0; // longest length of 'decl'
  const padded = _.map(out, ([decl, hash]) => _.padEnd(decl, padLen) + " // " + hash);
  return _.join(padded, '\n');
}

export async function getArtifact(name: string): Promise<Artifact>{
  try {
    // Covers compiled contract name ("Token") and compiled FQname ("contracts/Token.sol:Token")
    return await hre.artifacts.readArtifact(name);
  } catch {
    // Covers saved deployments by contract name ("Token")
    return await hre.deployments.getArtifact(name);
  }
}

export async function getArtifactNames(): Promise<string[]> {
  const compiledNames = await hre.artifacts.getAllFullyQualifiedNames();
  const deployedNames = _.keys(await hre.deployments.all());
  return _.uniq(_.concat(compiledNames, deployedNames));
}

// Make HTTP POST data to upload ABIs to https://www.4byte.directory/
// Docs: https://www.4byte.directory/docs/
export const URL_4bytes = "https://www.4byte.directory/api/v1/import-abi/";
export function make4bytesPostData(abis: any[]): any {
  return { contract_abi: JSON.stringify(abis) };
}

// Make HTTP POST data to upload ABIs to https://openchain.xyz/signatures
// Docs: https://docs.openchain.xyz/
export const URL_sigdb = "https://api.openchain.xyz/signature-database/v1/import";
export function makeSigdbPostData(abis: any[]): any {
  const formatType = hre.ethers.utils.FormatTypes.sighash;

  const functions: string[] = [];
  const events: string[] = [];
  for (const frag of abis) {
    if (frag.type == 'function') {
      const ffrag = hre.ethers.utils.FunctionFragment.fromObject(frag);
      functions.push(ffrag.format(formatType));
    }
    if (frag.type == 'event') {
      const efrag = hre.ethers.utils.EventFragment.fromObject(frag);
      events.push(efrag.format(formatType));
    }
  }

  return {
    'function': _.uniq(functions),
    'event': _.uniq(events)
  };
}