fix: package entry points and other small improvements

Author: jaybuidl

contracts/deployments/contractsEthers.ts

@@ -1,5 +1,4 @@
 import { ethers } from "ethers";
-import { arbitrum, arbitrumSepolia } from "viem/chains";
 import {
   klerosCoreConfig as devnetCoreConfig,
   sortitionModuleConfig as devnetSortitionConfig,
@@ -83,34 +82,7 @@ import {
   SortitionModuleNeo,
   SortitionModuleNeo__factory,
 } from "../typechain-types";
-
-const deployments = {
-  devnet: {
-    chainId: arbitrumSepolia.id,
-  },
-  university: {
-    chainId: arbitrumSepolia.id,
-  },
-  testnet: {
-    chainId: arbitrumSepolia.id,
-  },
-  mainnetNeo: {
-    chainId: arbitrum.id,
-  },
-} as const;
-
-type DeploymentName = keyof typeof deployments;
-
-type ContractConfig = {
-  address: Record<number, `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;
-}
+import { type ContractConfig, type DeploymentName, deployments, getAddress } from "./utils";
 
 type CommonFactoriesConfigs = {
   dkcConfig: ContractConfig;

contracts/deployments/contractsViem.ts

@@ -1,4 +1,5 @@
-import { arbitrum, arbitrumSepolia } from "viem/chains";
+import { type PublicClient, type WalletClient, getContract } from "viem";
+import { type ContractConfig, type DeploymentName, deployments, getAddress } from "./utils";
 import {
   klerosCoreConfig as devnetCoreConfig,
   sortitionModuleConfig as devnetSortitionConfig,
@@ -46,35 +47,19 @@ import {
   pnkConfig as mainnetPnkConfig,
   klerosCoreSnapshotProxyConfig as mainnetSnapshotProxyConfig,
 } from "./mainnet.viem";
-import { type PublicClient, type WalletClient, getContract } from "viem";
-
-const deployments = {
-  devnet: {
-    chainId: arbitrumSepolia.id,
-  },
-  university: {
-    chainId: arbitrumSepolia.id,
-  },
-  testnet: {
-    chainId: arbitrumSepolia.id,
-  },
-  mainnetNeo: {
-    chainId: arbitrum.id,
-  },
-} as const;
-
-type DeploymentName = keyof typeof deployments;
-
-type ContractConfig = {
-  address: Record<number, `0x${string}`>;
-  abi: readonly any[];
-};
 
 type ContractInstance = {
   address: `0x${string}`;
   abi: readonly any[];
 };
 
+function getContractConfig({ config, chainId }: { config: ContractConfig; chainId: number }): ContractInstance {
+  return {
+    address: getAddress(config, chainId),
+    abi: config.abi,
+  };
+}
+
 type ContractInstances = {
   klerosCore: ContractInstance;
   sortition: ContractInstance;
@@ -91,19 +76,6 @@ type ContractInstances = {
   klerosCoreSnapshotProxy: ContractInstance;
 };
 
-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;
-}
-
-function getContractConfig({ config, chainId }: { config: ContractConfig; chainId: number }): ContractInstance {
-  return {
-    address: getAddress(config, chainId),
-    abi: config.abi,
-  };
-}
-
 function getCommonConfigs({
   chainId,
   configs,

contracts/deployments/index.ts

@@ -11,6 +11,9 @@ export * as testnetViem from "./testnet.viem";
 // Typechain-types
 export * from "../typechain-types";
 
+// Common utils
+export * from "./utils";
+
 // Contracts getters
 export { getContracts as getContractsEthers } from "./contractsEthers";
 export { getContracts as getContractsViem } from "./contractsViem";

contracts/deployments/utils.ts

@@ -0,0 +1,29 @@
+import { arbitrum, arbitrumSepolia } from "viem/chains";
+
+export const deployments = {
+  devnet: {
+    chainId: arbitrumSepolia.id,
+  },
+  university: {
+    chainId: arbitrumSepolia.id,
+  },
+  testnet: {
+    chainId: arbitrumSepolia.id,
+  },
+  mainnetNeo: {
+    chainId: arbitrum.id,
+  },
+} as const;
+
+export type DeploymentName = keyof typeof deployments;
+
+export type ContractConfig = {
+  address: Record<number, `0x${string}`>;
+  abi: readonly any[];
+};
+
+export 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;
+}

contracts/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@kleros/kleros-v2-contracts",
-  "version": "0.8.1",
+  "version": "0.9.2",
   "description": "Smart contracts for Kleros version 2",
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/types/index.d.ts",
+  "main": "./cjs/deployments/index.js",
+  "module": "./esm/deployments/index.js",
+  "types": "./types/deployments/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"
+      "types": "./types/deployments/index.d.ts",
+      "import": "./esm/deployments/index.js",
+      "require": "./cjs/deployments/index.js",
+      "default": "./esm/deployments/index.js"
     }
   },
   "files": [

contracts/scripts/publish.sh

@@ -2,7 +2,7 @@
 
 shopt -s extglob
 
-SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null 2>&1 && pwd)"
 
 #--------------------------------------
 # Error handling
@@ -11,7 +11,7 @@ SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 set -Ee
 function _catch {
     # Don't propagate to outer shell
-    exit 0 
+    exit 0
 }
 function _finally {
     # TODO: rollback version bump
@@ -27,6 +27,9 @@ if [[ "$PWD" != */contracts ]]; then
     exit 1
 fi
 
+# Bump the version
+yarn version $1
+
 # Recompile the contracts
 yarn clean
 yarn build
@@ -53,7 +56,7 @@ mkdir dist
 yarn build:all
 
 # Copy the README and contracts
-cp -pr README.md src/ dist/ 
+cp -pr README.md src/ dist/
 
 # Remove unwanted files
 rm -rf dist/config
@@ -67,12 +70,9 @@ 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
+jq 'del(.scripts.prepare)' package.json >dist/package.json
 
 # Publish the package
 cd dist
-npm publish --dry-run
+npm publish
 cd -

contracts/test/integration/getContractsEthers.test.ts

@@ -87,7 +87,7 @@ const neoContractMapping: ContractMapping = {
   klerosCoreSnapshotProxy: { name: "KlerosCoreSnapshotProxy" },
 };
 
-describe("getContracts", () => {
+describe("getContractsEthers", () => {
   // Use real providers for each network
   const arbitrumSepoliaProvider = new ethers.JsonRpcProvider("https://sepolia-rollup.arbitrum.io/rpc");
   const arbitrumProvider = new ethers.JsonRpcProvider("https://arb1.arbitrum.io/rpc");

contracts/test/integration/getContractsViem.test.ts

@@ -1,5 +1,5 @@
 import { expect } from "chai";
-import { createPublicClient, createWalletClient, http, Address } from "viem";
+import { createPublicClient, http } from "viem";
 import { arbitrum, arbitrumSepolia } from "viem/chains";
 import { getContracts } from "../../deployments/contractsViem";
 import { getActualAddress } from "../utils/getActualAddress";
@@ -68,7 +68,7 @@ const neoContractMapping: ContractMapping = {
   klerosCoreSnapshotProxy: { name: "KlerosCoreSnapshotProxy" },
 };
 
-describe("getContracts", () => {
+describe("getContractsViem", () => {
   // Create Viem clients for testing
   const arbitrumSepoliaClient = createPublicClient({
     chain: arbitrumSepolia,