anchor/ts/src/workspace.ts

import camelCase from "camelcase";
import * as toml from "toml";
import { PublicKey } from "@solana/web3.js";
import { Program } from "./program";
import { Idl } from "./idl";

let _populatedWorkspace = false;

/**
 * The `workspace` namespace provides a convenience API to automatically
 * search for and deserialize [[Program]] objects defined by compiled IDLs
 * in an Anchor workspace.
 *
 * This API is for Node only.
 */
const workspace = new Proxy({} as any, {
  get(workspaceCache: { [key: string]: Program }, programName: string) {
    const fs = require("fs");
    const process = require("process");

    if (
      typeof window !== "undefined" &&
      !window.process?.hasOwnProperty("type")
    ) {
      // Workspaces are available in electron, but not in the browser, yet.
      return undefined;
    }

    if (!_populatedWorkspace) {
      const path = require("path");

      let projectRoot = process.cwd();
      while (!fs.existsSync(path.join(projectRoot, "Anchor.toml"))) {
        const parentDir = path.dirname(projectRoot);
        if (parentDir === projectRoot) {
          projectRoot = undefined;
        }
        projectRoot = parentDir;
      }

      if (projectRoot === undefined) {
        throw new Error("Could not find workspace root.");
      }

      const idlFolder = `${projectRoot}/target/idl`;
      if (!fs.existsSync(idlFolder)) {
        throw new Error(`${idlFolder} doesn't exist. Did you use "anchor build"?`);
      }

      const idlMap = new Map<string, Idl>();
      fs.readdirSync(idlFolder).forEach(file => {
        const filePath = `${idlFolder}/${file}`;
        const idlStr = fs.readFileSync(filePath);
        const idl = JSON.parse(idlStr);
        idlMap.set(idl.name, idl);
        const name = camelCase(idl.name, {pascalCase: true});
        if (idl.metadata && idl.metadata.address) {
          workspaceCache[name] = new Program(
            idl,
            new PublicKey(idl.metadata.address)
          );
        }
      });

      // Override the workspace programs if the user put them in the config.
      const anchorToml = toml.parse(
        fs.readFileSync(path.join(projectRoot, "Anchor.toml"), "utf-8")
      );
      const clusterId = anchorToml.provider.cluster;
      if (anchorToml.clusters && anchorToml.clusters[clusterId]) {
        attachWorkspaceOverride(
          workspaceCache,
          anchorToml.clusters[clusterId],
          idlMap
        );
      }

      _populatedWorkspace = true;
    }

    return workspaceCache[programName];
  },
});

function attachWorkspaceOverride(
  workspaceCache: { [key: string]: Program },
  overrideConfig: { [key: string]: string },
  idlMap: Map<string, Idl>
) {
  Object.keys(overrideConfig).forEach((programName) => {
    const wsProgramName = camelCase(programName, { pascalCase: true });
    const overrideAddress = new PublicKey(overrideConfig[programName]);
    workspaceCache[wsProgramName] = new Program(
      idlMap.get(programName),
      overrideAddress
    );
  });
}

export default workspace;