Merge pull request #120 from kleros/dev

Release to Beta

Author: jaybuidl

contracts/README.md

@@ -19,8 +19,10 @@ Refresh the list of deployed contracts by running `./scripts/generateDeployments
 ### Devnet
 #### Arbitrum Sepolia
 
+- [EscrowCustomBuyer](https://sepolia.arbiscan.io/address/0xA01e6B988aeDae1fD4a748D6bfBcB8A438601DeE)
 - [EscrowUniversal](https://sepolia.arbiscan.io/address/0x5ef185810BCe41c03c9E5ca271B8C91F1024F953)
 - [EscrowView](https://sepolia.arbiscan.io/address/0x6451046caB9291a919FCba045bf6Bb8E0Bb71467)
+- [EscrowViewCustomBuyer](https://sepolia.arbiscan.io/address/0xe0892815E8958f0ad6Dab876995987c4F439954D)
 
 ## Getting Started
 
@@ -91,7 +93,8 @@ yarn hardhat node --tags nothing
 **Shell 2: the deploy script**
 
 ```bash
-yarn deploy --network localhost --tags Escrow>
+yarn deploy --network localhost --tags EscrowUniversal
+yarn deploy --network localhost --tags EscrowCustomBuyer
 ```
 
 #### 2. Deploy to a Public Network Fork
@@ -115,7 +118,8 @@ yarn deploy-testnet-fork
 #### 3. Deploy to Public Testnets
 
 ```bash
-yarn deploy --network arbitrumSepolia --tags Escrow
+yarn deploy --network arbitrumSepolia --tags EscrowUniversal
+yarn deploy --network arbitrumSepolia --tags EscrowCustomBuyer
 ```
 
 The deployed addresses should be displayed to the screen after the deployment is complete. If you missed them, you can always go to the `deployments/<network>` directory and look for the respective file.
@@ -129,7 +133,7 @@ Same steps as above but append `Devnet` to the `--network` parameter.
 **Shell 1: the node**
 
 ```bash
-yarn hardhat node --tags Escrow
+yarn hardhat node --tags EscrowUniversal
 ```
 
 **Shell 2: the test scripts**

contracts/README.md.template

@@ -77,7 +77,8 @@ yarn hardhat node --tags nothing
 **Shell 2: the deploy script**
 
 ```bash
-yarn deploy --network localhost --tags Escrow>
+yarn deploy --network localhost --tags EscrowUniversal
+yarn deploy --network localhost --tags EscrowCustomBuyer
 ```
 
 #### 2. Deploy to a Public Network Fork
@@ -101,7 +102,8 @@ yarn deploy-testnet-fork
 #### 3. Deploy to Public Testnets
 
 ```bash
-yarn deploy --network arbitrumSepolia --tags Escrow
+yarn deploy --network arbitrumSepolia --tags EscrowUniversal
+yarn deploy --network arbitrumSepolia --tags EscrowCustomBuyer
 ```
 
 The deployed addresses should be displayed to the screen after the deployment is complete. If you missed them, you can always go to the `deployments/<network>` directory and look for the respective file.
@@ -115,7 +117,7 @@ Same steps as above but append `Devnet` to the `--network` parameter.
 **Shell 1: the node**
 
 ```bash
-yarn hardhat node --tags Escrow
+yarn hardhat node --tags EscrowUniversal
 ```
 
 **Shell 2: the test scripts**

contracts/deploy/00-escrow-custom-buyer.ts

@@ -0,0 +1,15 @@
+import { HardhatRuntimeEnvironment } from "hardhat/types";
+import { DeployFunction } from "hardhat-deploy/types";
+import { HomeChains, isSkipped } from "./utils";
+import deployEscrow from "./shared";
+
+const deploy: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
+  await deployEscrow(hre, "customBuyer");
+};
+
+deploy.tags = ["EscrowCustomBuyer"];
+deploy.skip = async ({ network }) => {
+  return isSkipped(network, !HomeChains[network.config.chainId ?? 0]);
+};
+
+export default deploy;

contracts/deploy/00-escrow-universal.ts

@@ -0,0 +1,15 @@
+import { HardhatRuntimeEnvironment } from "hardhat/types";
+import { DeployFunction } from "hardhat-deploy/types";
+import { HomeChains, isSkipped } from "./utils";
+import deployEscrow from "./shared";
+
+const deploy: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
+  await deployEscrow(hre, "universal");
+};
+
+deploy.tags = ["EscrowUniversal"];
+deploy.skip = async ({ network }) => {
+  return isSkipped(network, !HomeChains[network.config.chainId ?? 0]);
+};
+
+export default deploy;

contracts/deploy/00-escrow.ts renamed to contracts/deploy/shared.ts

@@ -1,25 +1,54 @@
 import { HardhatRuntimeEnvironment } from "hardhat/types";
-import { DeployFunction } from "hardhat-deploy/types";
-import { HomeChains, isSkipped } from "./utils";
+import { HomeChains } from "./utils";
 import { EscrowUniversal } from "../typechain-types";
 import { getArbitratorContracts } from "./utils/getContracts";
 
-const config = {
+export type EscrowDeployment = {
+  escrow: string;
+  view: string;
+};
+
+export type EscrowDeployments = {
+  universal: EscrowDeployment;
+  customBuyer?: EscrowDeployment;
+};
+
+export const config = {
   arbitrumSepoliaDevnet: {
     feeTimeout: 600, // 10 minutes
     settlementTimeout: 600, // 10 minutes
     jurors: 1,
     courtId: 1,
+    escrowDeployments: {
+      universal: {
+        escrow: "EscrowUniversal",
+        view: "EscrowView",
+      },
+      customBuyer: {
+        escrow: "EscrowCustomBuyer",
+        view: "EscrowViewCustomBuyer",
+      },
+    } satisfies EscrowDeployments,
   },
   arbitrum: {
     feeTimeout: 302400, // 84 hours
     settlementTimeout: 172800, // 48 hours
     jurors: 3,
     courtId: 1,
+    escrowDeployments: {
+      universal: {
+        escrow: "EscrowUniversal",
+        view: "EscrowView",
+      },
+      customBuyer: undefined,
+    } satisfies EscrowDeployments,
   },
 };
 
-const deploy: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
+const deployEscrow = async (
+  hre: HardhatRuntimeEnvironment,
+  escrowDeployment: keyof EscrowDeployments
+) => {
   const { deployments, getNamedAccounts, getChainId, ethers, network } = hre;
   const { deploy } = deployments;
 
@@ -29,10 +58,10 @@ const deploy: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   console.log("deploying to %s with deployer %s", HomeChains[chainId], deployer);
 
   const { disputeTemplateRegistry, klerosCore } = await getArbitratorContracts(hre);
-  const { feeTimeout, settlementTimeout, jurors, courtId } = config[network.name];
+  const { feeTimeout, settlementTimeout, jurors, courtId, escrowDeployments } = config[network.name];
   const extraData = ethers.AbiCoder.defaultAbiCoder().encode(["uint96", "uint96"], [courtId, jurors]);
 
-  await deploy("EscrowUniversal", {
+  await deploy(escrowDeployments[escrowDeployment].escrow, {
     from: deployer,
     args: [
       klerosCore.target,
@@ -47,30 +76,38 @@ const deploy: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   });
 
   // Set the value cap to about USD 1000
-  const escrow = (await ethers.getContract("EscrowUniversal")) as EscrowUniversal;
+  const escrow = (await ethers.getContract(escrowDeployments[escrowDeployment].escrow)) as EscrowUniversal;
   const WETH = await deployments.get("WETH");
   const DAI = await deployments.get("DAI");
+  const PNK = await deployments.getOrNull("PNK");
+  const USDC = await deployments.getOrNull("USDC");
+  const USDCe = await deployments.getOrNull("USDCe"); // USDC.e (Bridged USDC)
   const caps = {
     [ethers.ZeroAddress]: ethers.parseUnits("0.3"),
     [WETH.address]: ethers.parseUnits("0.3"),
     [DAI.address]: ethers.parseUnits("1000"),
   };
+  if (PNK) {
+    caps[PNK.address] = ethers.parseUnits("100000"); // 100,000 PNK
+  }
+  if (USDC) {
+    caps[USDC.address] = ethers.parseUnits("1000", 6);
+  }
+  if (USDCe) {
+    caps[USDCe.address] = ethers.parseUnits("1000", 6);
+  }
   for (const [token, cap] of Object.entries(caps)) {
     console.log("Setting cap for", token, cap);
     await escrow.changeAmountCap(token, cap);
   }
 
-  await deploy("EscrowView", {
+  await deploy(escrowDeployments[escrowDeployment].view, {
+    contract: "EscrowView",
     from: deployer,
     args: [escrow.target],
-    gasLimit: 50000000,
+    gasLimit: 30000000,
     log: true,
   });
 };
 
-deploy.tags = ["Escrow"];
-deploy.skip = async ({ network }) => {
-  return isSkipped(network, !HomeChains[network.config.chainId ?? 0]);
-};
-
-export default deploy;
+export default deployEscrow;

contracts/deploy/utils/getContracts.ts

@@ -1,6 +1,6 @@
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeploymentName, getContractsEthers as _getArbitratorContracts } from "@kleros/kleros-v2-contracts";
-import { EscrowView, EscrowUniversal } from "../../typechain-types";
+import { EscrowView, EscrowUniversal, EscrowCustomBuyer } from "../../typechain-types";
 
 const NETWORK_TO_DEPLOYMENT: Record<string, DeploymentName> = {
   arbitrumSepoliaDevnet: "devnet",
@@ -24,5 +24,7 @@ export const getContracts = async (hre: HardhatRuntimeEnvironment) => {
   const { klerosCore, disputeTemplateRegistry } = await getArbitratorContracts(hre);
   const escrow = await ethers.getContract<EscrowUniversal>("EscrowUniversal");
   const view = await ethers.getContract<EscrowView>("EscrowView");
-  return { escrow, view, disputeTemplateRegistry, klerosCore };
+  const escrowCustomBuyer = await ethers.getContract<EscrowCustomBuyer>("EscrowCustomBuyer");
+  const customBuyerView = await ethers.getContract<EscrowView>("EscrowViewCustomBuyer");
+  return { escrow, view, escrowCustomBuyer, customBuyerView, disputeTemplateRegistry, klerosCore };
 };