feat: packaging to both CJS and ESM

jaybuidl · jaybuidl · commit c1323032add3 · 2025-04-17T16:41:46.000+01:00
diff --git a/contracts/deployments/contractsViem.ts b/contracts/deployments/contractsViem.ts
@@ -1,65 +1,107 @@
 import { arbitrum, arbitrumSepolia } from "viem/chains";
-import { disputeTemplateRegistryConfig as devnetDtrConfig, klerosCoreConfig as devnetCoreConfig } from "./devnet.viem";
 import {
-  disputeTemplateRegistryConfig as mainnetDtrConfig,
-  klerosCoreNeoConfig as mainnetCoreConfig,
-} from "./mainnet.viem";
-import { type PublicClient, type WalletClient } from "viem";
+  klerosCoreConfig as devnetCoreConfig,
+  sortitionModuleConfig as devnetSortitionConfig,
+  disputeKitClassicConfig as devnetDkcConfig,
+  disputeResolverConfig as devnetDrConfig,
+  disputeTemplateRegistryConfig as devnetDtrConfig,
+  evidenceModuleConfig as devnetEvidenceConfig,
+  policyRegistryConfig as devnetPolicyRegistryConfig,
+  transactionBatcherConfig as devnetBatcherConfig,
+  chainlinkRngConfig as devnetChainlinkRngConfig,
+  blockHashRngConfig as devnetBlockHashRngConfig,
+  pnkConfig as devnetPnkConfig,
+  klerosCoreSnapshotProxyConfig as devnetSnapshotProxyConfig,
+  klerosCoreUniversityConfig as devnetCoreUniversityConfig,
+  sortitionModuleUniversityConfig as devnetSortitionUniversityConfig,
+  disputeKitClassicUniversityConfig as devnetDkcUniversityConfig,
+  disputeResolverUniversityConfig as devnetDrUniversityConfig,
+  klerosCoreUniversityProxyConfig as devnetCoreUniversityProxyConfig,
+} from "./devnet.viem";
+import { type PublicClient, type WalletClient, getContract } from "viem";
 
-export const Cores = {
-  BASE: "BASE",
-  NEO: "NEO",
-  UNIVERSITY: "UNIVERSITY",
+const deployments = {
+  devnet: {
+    chainId: arbitrumSepolia.id,
+  },
+  university: {
+    chainId: arbitrumSepolia.id,
+  },
+  testnet: {
+    chainId: arbitrumSepolia.id,
+  },
+  mainnetNeo: {
+    chainId: arbitrum.id,
+  },
 } as const;
 
-export type Core = (typeof Cores)[keyof typeof Cores];
+type DeploymentName = keyof typeof deployments;
+
+type ContractConfig = {
+  address: Record<number, `0x${string}`>;
+  abi: readonly any[];
+};
+
+type ContractConfigs = {
+  klerosCore?: {
+    address: `0x${string}`;
+    abi: readonly any[];
+  };
+};
+
+function getAddress(config: ContractConfig, chainId: number): `0x${string}` {
+  const address = config.address[chainId];
+  if (!address) throw new Error(`No address found for chainId ${chainId}`);
+  return address;
+}
+
+export const getConfigs = ({ deployment }: { deployment: DeploymentName }): ContractConfigs => {
+  const { chainId } = deployments[deployment];
+  let contractConfigs: ContractConfigs = {};
+  switch (deployment) {
+    case "devnet":
+      contractConfigs = {
+        klerosCore: {
+          address: getAddress(devnetCoreConfig, chainId),
+          abi: devnetCoreConfig.abi,
+        },
+      };
+      break;
+    default:
+      throw new Error(`Unsupported deployment: ${deployment}`);
+  }
+  return contractConfigs;
+};
 
 export const getContracts = ({
   publicClient,
   walletClient,
-  chainId,
-  coreType,
+  deployment,
 }: {
   publicClient: PublicClient;
   walletClient?: WalletClient;
-  chainId: number;
-  coreType: Core;
+  deployment: DeploymentName;
 }) => {
-  throw new Error("Not implemented");
-  switch (chainId) {
-    case arbitrum.id:
-      return {
-        disputeTemplateRegistry: {
-          address: mainnetDtrConfig.address[chainId],
-          publicClient,
-          walletClient,
-          abi: mainnetDtrConfig.abi,
-        },
-        klerosCore: {
-          address: mainnetCoreConfig.address[chainId],
-          publicClient,
-          walletClient,
-          abi: mainnetCoreConfig.abi,
-        },
-      };
-    case arbitrumSepolia.id:
-      return {
-        disputeTemplateRegistry: {
-          address: devnetDtrConfig.address[chainId],
-          publicClient,
-          walletClient,
-          abi: devnetDtrConfig.abi,
-        },
-        klerosCore: {
-          address: devnetCoreConfig.address[chainId],
-          publicClient,
-          walletClient,
-          abi: devnetCoreConfig.abi,
-        },
-      };
+  const clientConfig = {
+    client: {
+      public: publicClient,
+      wallet: walletClient,
+    },
+  };
+  let klerosCore;
+  switch (deployment) {
+    case "devnet":
+      const contractConfigs = getConfigs({ deployment });
+      if (!contractConfigs.klerosCore) throw new Error("KlerosCore config not found");
+      klerosCore = getContract({
+        ...contractConfigs.klerosCore,
+        ...clientConfig,
+      });
+      break;
     default:
-      throw new Error(`Unsupported chainId: ${chainId}`);
+      throw new Error(`Unsupported deployment: ${deployment}`);
   }
+  return {
+    klerosCore,
+  };
 };
-
-// TODO: do the same for Viem ?
diff --git a/contracts/deployments/index.ts b/contracts/deployments/index.ts
@@ -8,5 +8,9 @@ export * as devnetViem from "./devnet.viem";
 export * as mainnetViem from "./mainnet.viem";
 export * as testnetViem from "./testnet.viem";
 
+// Typechain-types
+export * from "../typechain-types";
+
+// Contracts getters
 export { getContracts as getContractsEthers } from "./contractsEthers";
 export { getContracts as getContractsViem } from "./contractsViem";
diff --git a/contracts/package.json b/contracts/package.json
@@ -2,7 +2,33 @@
   "name": "@kleros/kleros-v2-contracts",
   "version": "0.8.1",
   "description": "Smart contracts for Kleros version 2",
-  "main": "typechain-types/index.ts",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "default": "./dist/esm/index.js"
+    }
+  },
+  "files": [
+    "types",
+    "esm",
+    "cjs",
+    "arbitration",
+    "gateway",
+    "kleros-v1",
+    "libraries",
+    "proxy",
+    "rng",
+    "token",
+    "utils",
+    "typechain-types",
+    "deployments",
+    "index.ts"
+  ],
   "repository": "git@github.com:kleros/kleros-v2.git",
   "homepage": "https://github.com/kleros/kleros-v2/tree/master/contracts#readme",
   "author": "Kleros",
@@ -64,10 +90,10 @@
     "release:minor": "scripts/publish.sh minor",
     "release:major": "scripts/publish.sh major",
     "tenderly-verify": "hardhat tenderly:verify",
-    "build:all": "yarn rimraf ./dist && yarn build:cjs && yarn build:esm && yarn build:types",
-    "build:cjs": "tsc --project tsconfig.json --module commonjs --outDir ./dist/cjs && echo '{\"type\": \"commonjs\"}' > ./dist/cjs/package.json",
-    "build:esm": "tsc --project tsconfig.json --module es2020 --outDir ./dist/esm && echo '{\"type\": \"module\"}' > ./dist/esm/package.json",
-    "build:types": "tsc --project tsconfig.json --module esnext --declarationDir ./dist/types --emitDeclarationOnly --declaration --declarationMap"
+    "build:all": "rm -rf ./dist && yarn build:cjs && yarn build:esm && yarn build:types",
+    "build:cjs": "tsc --project tsconfig-release.json --module CommonJS --moduleResolution Node --outDir ./dist/cjs && echo '{\"type\": \"commonjs\"}' > ./dist/cjs/package.json",
+    "build:esm": "tsc --project tsconfig-release.json --module NodeNext --moduleResolution NodeNext --outDir ./dist/esm && echo '{\"type\": \"module\"}' > ./dist/esm/package.json",
+    "build:types": "tsc --project tsconfig-release.json --declarationDir ./dist/types --emitDeclarationOnly --declaration --declarationMap"
   },
   "devDependencies": {
     "@defi-wonderland/natspec-smells": "^1.1.5",
diff --git a/contracts/scripts/publish.sh b/contracts/scripts/publish.sh
@@ -1,4 +1,6 @@
-#!/bin/bash
+#!/usr/bin/env bash
+
+shopt -s extglob
 
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 
@@ -20,31 +22,57 @@ trap _finally EXIT
 
 #--------------------------------------
 
-yarn version $1
+if [[ "$PWD" != */contracts ]]; then
+    echo "Error: This script must be run from the contracts directory"
+    exit 1
+fi
+
+# Recompile the contracts
+yarn clean
+yarn build
+
+# Rebuild the typechain without mocks
+rm -rf artifacts/src/**/*[mM]ock*
+find artifacts/src -name "*.dbg.json" -type f -delete
+rm -rf typechain-types
+yarn typechain --out-dir typechain-types --glob 'artifacts/src/**/*.json' --target ethers-v6
 
+# Generate the viem artifacts
 yarn viem:generate-devnet
 yarn viem:generate-testnet
 yarn viem:generate-mainnet
+
+# Generate the Hardhat artifacts
 yarn export:devnet
 yarn export:testnet
 yarn export:mainnet
 
+# Build the dist
 rm -rf dist
 mkdir dist
+yarn build:all
 
-yarn tsc --project tsconfig-release.json --outDir ./dist
+# Copy the README and contracts
 cp -pr README.md src/ dist/ 
+
+# Remove unwanted files
 rm -rf dist/config
 rm -rf dist/deploy
 rm -rf dist/scripts
 rm -rf dist/test
+rm -rf dist/**/mock
+rm -rf dist/**/*Mock*
 rm -rf dist/hardhat.config*
 rm -rf dist/deployments/**/solcInputs
 rm -rf dist/deployments/localhost
 rm -rf dist/deployments/hardhat
 rm -rf dist/deployments/hardhat.viem.ts
 jq 'del(.scripts.prepare)' package.json > dist/package.json
 
+# Bump the version
+yarn version $1
+
+# Publish the package
 cd dist
-npm publish
+npm publish --dry-run
 cd -
diff --git a/contracts/tsconfig-release.json b/contracts/tsconfig-release.json
@@ -4,7 +4,6 @@
     "declaration": true
   },
   "include": [
-    "./src",
     "./typechain-types",
     "./deployments"
   ],
diff --git a/contracts/wagmi.config.devnet.ts b/contracts/wagmi.config.devnet.ts
@@ -1,5 +1,5 @@
 import { Config, defineConfig } from "@wagmi/cli";
-import IHomeGateway from "@kleros/kleros-v2-contracts/artifacts/src/gateway/interfaces/IHomeGateway.sol/IHomeGateway.json" assert { type: "json" };
+import IHomeGateway from "./artifacts/src/gateway/interfaces/IHomeGateway.sol/IHomeGateway.json" assert { type: "json" };
 import { getAbi, readArtifacts, merge } from "./scripts/wagmiHelpers";
 
 const getConfig = async (): Promise<Config> => {
diff --git a/contracts/wagmi.config.mainnet.ts b/contracts/wagmi.config.mainnet.ts
@@ -1,5 +1,5 @@
 import { Config, defineConfig } from "@wagmi/cli";
-import IHomeGateway from "@kleros/kleros-v2-contracts/artifacts/src/gateway/interfaces/IHomeGateway.sol/IHomeGateway.json" assert { type: "json" };
+import IHomeGateway from "./artifacts/src/gateway/interfaces/IHomeGateway.sol/IHomeGateway.json" assert { type: "json" };
 import { getAbi, readArtifacts, merge } from "./scripts/wagmiHelpers";
 
 const getConfig = async (): Promise<Config> => {
diff --git a/contracts/wagmi.config.testnet.ts b/contracts/wagmi.config.testnet.ts
@@ -1,5 +1,5 @@
 import { Config, defineConfig } from "@wagmi/cli";
-import IHomeGateway from "@kleros/kleros-v2-contracts/artifacts/src/gateway/interfaces/IHomeGateway.sol/IHomeGateway.json" assert { type: "json" };
+import IHomeGateway from "./artifacts/src/gateway/interfaces/IHomeGateway.sol/IHomeGateway.json" assert { type: "json" };
 import { getAbi, readArtifacts, merge } from "./scripts/wagmiHelpers";
 
 const getConfig = async (): Promise<Config> => {
