Release of v2-testnet-3.0.3

contracts/.env.example

@@ -1,13 +1,26 @@
 PRIVATE_KEY=0xabc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1
-REPORT_GAS=true
+
 INFURA_API_KEY=ABC123ABC123ABC123ABC123ABC123ABC1
 
+# Testing
+REPORT_GAS=true
+
 # There seems to be a bug with hardhat-deploy's implementation of etherscan-verify
 # If ETHERSCAN_API_KEY is set, it overrides any hardhat configuration.
 ETHERSCAN_API_KEY_FIX=ABC123ABC123ABC123ABC123ABC123ABC1
 ARBISCAN_API_KEY=ABC123ABC123ABC123ABC123ABC123ABC1
 GNOSISSCAN_API_KEY=ABC123ABC123ABC123ABC123ABC123ABC1
 
+# For the bots
+LOG_LEVEL=debug
+SUBGRAPH_URL=https://api.studio.thegraph.com/query/61738/kleros-v2-core-devnet/version/latest
+LOGTAIL_TOKEN_KEEPER_BOT=cqPqBofVC8nmA8EZdZGqqvUV
+LOGTAIL_TOKEN_RELAYER_BOT=41h8q5Z4gnz5yDx215eqcQ4r
+LOGTAIL_TOKEN_DISPUTOR_BOT=mSryyvYubviaMqKDWfBKAGsi
+HEARTBEAT_URL_KEEPER_BOT=https://uptime.betterstack.com/api/v1/heartbeat/jc23S8ZZzpf8KbzwxL1hoBp9
+HEARTBEAT_URL_RELAYER_BOT=https://uptime.betterstack.com/api/v1/heartbeat/eT6Trk6CddJV6fFBbqZNzyqC
+DISPUTES_TO_SKIP=
+
 # Optionally for debugging
 # TENDERLY_USERNAME=your_username
 # TENDERLY_PROJECT=your_project

contracts/.npmignore

@@ -1,2 +1,7 @@
 # NOP, just force npm to disregard .gitignore
 # https://docs.npmjs.com/cli/v9/using-npm/developers#keeping-files-out-of-your-package
+
+.env*
+.flaskenv*
+!.env.project
+!.env.vault

contracts/README.md

@@ -4,7 +4,7 @@ Smart contracts for Kleros v2
 
 ## Deployments
 
-Refresh the list of deployed contracts by running `./scripts/generateDeploymentsMarkdown.sh`.
+Refresh the list of deployed contracts by running `./scripts/generateDeploymentsMarkdown.sh` or `./scripts/populateReadme.sh`.
 
 ### Official Testnet
 
@@ -57,7 +57,7 @@ Refresh the list of deployed contracts by running `./scripts/generateDeployments
 - [DisputeKitClassic: proxy](https://sepolia.arbiscan.io/address/0x9426F127116C3652A262AE1eA48391AC8F44D35b), [implementation](https://sepolia.arbiscan.io/address/0x692CC78F2570181FFB99297965FeAA8352ab12E8)
 - [DisputeResolver](https://sepolia.arbiscan.io/address/0xB8B36CC43f852f9F0484f53Eb38CaBBA28a81bF6)
 - [DisputeTemplateRegistry: proxy](https://sepolia.arbiscan.io/address/0x596D3B09E684D62217682216e9b7a0De75933391), [implementation](https://sepolia.arbiscan.io/address/0xc53b813ed94AaEb6F5518D60bf6a8109954bE3f6)
-- [Escrow](https://sepolia.arbiscan.io/address/0xdaf749DABE7be6C6894950AE69af35c20a00ABd9)
+- [Escrow](https://sepolia.arbiscan.io/address/0x10f7A6f42Af606553883415bc8862643A6e63fdA)
 - [EvidenceModule: proxy](https://sepolia.arbiscan.io/address/0x57fd453FB0d16f8ca174E7386102D7170E17Be09), [implementation](https://sepolia.arbiscan.io/address/0x05AD81f245209b7f91885fd96e57c9da90554824)
 - [KlerosCore: proxy](https://sepolia.arbiscan.io/address/0xA54e7A16d7460e38a8F324eF46782FB520d58CE8), [implementation](https://sepolia.arbiscan.io/address/0x91a373BBdE0532F86410682F362e2Cf685e95085)
 - [PNKFaucet](https://sepolia.arbiscan.io/address/0x7EFE468003Ad6A858b5350CDE0A67bBED58739dD)
@@ -214,6 +214,8 @@ yarn sourcify --network <arbitrumSepolia|arbitrum|chiado|gnosischain|sepolia|mai
 
 ### Populating the policy registry and courts
 
+The policy registry and courts configuration can be found in `config/policies.*.json` and `config/courts.*.json`.
+
 #### 1/ Export the registry data from V1
 
 ```bash
@@ -226,10 +228,6 @@ done
 
 #### 2/ Import the data to V2 - Local Network
 
-:warning: By default this script populates from `*.mainnet.json`. To populate from `*.gnosischain.json`, set the variable `USE_GNOSIS` to true inside [scripts/populateCourts.ts](scripts/populateCourts.ts).
-
-:warning: It is possible to switch to testnet-friendly court parameters by setting the variable `TESTING_PARAMETERS` to true inside [scripts/populateCourts.ts](scripts/populateCourts.ts).
-
 Shell 1:
 
 ```bash

contracts/README.md.template

@@ -0,0 +1,197 @@
+# @kleros/kleros-v2-contracts
+
+Smart contracts for Kleros v2
+
+## Deployments
+
+Refresh the list of deployed contracts by running `./scripts/generateDeploymentsMarkdown.sh` or `./scripts/populateReadme.sh`.
+
+$deployments
+
+## Getting Started
+
+### Install the Dependencies
+
+```bash
+yarn install
+```
+
+### Run Tests
+
+```bash
+yarn test
+```
+
+### Compile the Contracts
+
+```bash
+yarn build
+```
+
+### Run Linter on Files
+
+```bash
+yarn lint
+```
+
+### Fix Linter Issues on Files
+
+```bash
+yarn fix
+```
+
+### Deploy Instructions
+
+**NOTICE:** the commands below work only if you are inside the `contracts/` directory.
+
+#### 0. Set the Environment Variables
+
+Copy `.env.example` file as `.env` and edit it accordingly.
+
+```bash
+cp .env.example .env
+```
+
+The following env vars are required:
+
+- `PRIVATE_KEY`: the private key of the deployer account used for the testnets.
+- `MAINNET_PRIVATE_KEY`: the private key of the deployer account used for Mainnet.
+- `INFURA_API_KEY`: the API key for infura.
+
+The ones below are optional:
+
+- `ETHERSCAN_API_KEY`: to verify the source of the newly deployed contracts on **Etherscan**.
+- `ARBISCAN_API_KEY`: to verify the source of the newly deployed contracts on **Arbitrum**.
+- `GNOSISSCAN_API_KEY`: to verify the source of the newly deployed contracts on **Gnosis chain**.
+
+#### 1. Update the Constructor Parameters (optional)
+
+If some of the constructor parameters (such as the Meta Evidence) needs to change, you need to update the files in the `deploy/` directory.
+
+#### 2. Deploy to a Local Network
+
+The complete deployment is multi-chain, so a deployment to the local network can only simulate either the Home chain or the Foreign chain.
+
+**Shell 1: the node**
+
+```bash
+yarn hardhat node --tags nothing
+```
+
+**Shell 2: the deploy script**
+
+```bash
+yarn deploy --network localhost --tags <Arbitration|VeaMock|ForeignGatewayOnEthereum|HomeGateway>
+```
+
+#### 3. Deploy to Public Testnets
+
+```bash
+# ArbitrumSepolia to Chiado
+yarn deploy --network arbitrumSepolia --tags Arbitration
+yarn deploy --network arbitrumSepolia --tags HomeArbitrable
+yarn deploy --network chiado --tags ForeignGatewayOnGnosis
+yarn deploy --network chiado --tags KlerosLiquidOnGnosis
+yarn deploy --network chiado --tags ForeignArbitrable
+yarn deploy --network arbitrumSepolia --tags HomeGatewayToGnosis
+
+# Sepolia
+yarn deploy --network sepolia --tags ForeignGatewayOnEthereum
+yarn deploy --network sepolia --tags ForeignArbitrable
+yarn deploy --network arbitrumSepolia --tags HomeGatewayToEthereum
+```
+
+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.
+
+#### 4. Deploy a Devnet on Public Testnets
+
+Same steps as above but append `Devnet` to the `--network` parameter.
+
+#### Running Test Fixtures
+
+**Shell 1: the node**
+
+```bash
+yarn hardhat node --tags Arbitration,VeaMock
+```
+
+**Shell 2: the test scripts**
+
+```bash
+yarn test --network localhost
+```
+
+#### 4. Verify the Source Code
+
+This must be done for each network separately.
+
+```bash
+# explorer
+yarn etherscan-verify --network <arbitrumSepolia|arbitrum|chiado|gnosischain|sepolia|mainnet>
+yarn etherscan-verify-proxies
+
+# sourcify
+yarn sourcify --network <arbitrumSepolia|arbitrum|chiado|gnosischain|sepolia|mainnet>
+
+```
+
+## Ad-hoc procedures
+
+### Populating the policy registry and courts
+
+The policy registry and courts configuration can be found in `config/policies.*.json` and `config/courts.*.json`.
+
+#### 1/ Export the registry data from V1
+
+```bash
+for network in mainnet gnosischain
+do
+  yarn hardhat run scripts/getPoliciesV1.ts  --network $network | tee config/policies.v1.$network.json
+  yarn hardhat run scripts/getCourtsV1.ts --network $network | tee config/courts.v1.$network.json
+done
+```
+
+#### 2/ Import the data to V2 - Local Network
+
+Shell 1:
+
+```bash
+yarn hardhat node --tags Arbitration
+```
+
+Shell 2:
+
+```bash
+yarn hardhat run scripts/populateCourts.ts --network localhost
+yarn hardhat run scripts/populatePolicyRegistry.ts --network localhost
+```
+
+#### 3/ Import the data to V2 - Public Testnet
+
+```bash
+yarn hardhat run scripts/populateCourts.ts --network arbitrumSepolia
+yarn hardhat run scripts/populatePolicyRegistry.ts --network arbitrumSepolia
+```
+
+### Generate deployment artifacts for existing contracts
+
+#### Usage
+
+```bash
+scripts/generateDeploymentArtifact.sh <network> <address>
+```
+
+#### Example: WETH on Gnosis chain
+
+```bash
+scripts/generateDeploymentArtifact.sh gnosischain 0xf8d1677c8a0c961938bf2f9adc3f3cfda759a9d9 > deployments/gnosischain/WETH.json
+```
+
+### Push the contracts to a Tenderly project
+
+Ensure that your `$TENDERLY_PROJECT` and `$TENDERLY_USERNAME` is set correctly in `.env`.
+
+```bash
+yarn tenderly-verify --network sepolia
+yarn tenderly-verify --network arbitrumSepolia
+```