feat(contracts): npm package publication scripts, goerli cleanup, README population script

Author: jaybuidl

contracts/.npmignore

@@ -1,2 +1,6 @@
-# NOP, just force npm to disregard .gitignore
-# https://docs.npmjs.com/cli/v9/using-npm/developers#keeping-files-out-of-your-package
+.env*
+scripts
+deploy
+tsconfig.json
+test
+hardhat.config.*

contracts/README.md

@@ -2,26 +2,44 @@
 
 Smart contracts for Vea.
 
-## Deployed Addresses
+---
+
+- **[Deployed Addresses](#deployed-addresses)**
+  - **[Sepolia](#sepolia)**
+  - **[Arbitrum Sepolia](#arbitrum-sepolia)**
+  - **[Chiado](#chiado)**
+- **[Getting Started](#getting-started)**
+  - **[Install the Dependencies](#install-the-dependencies)**
+  - **[Run Tests](#run-tests)**
+  - **[Compile the Contracts](#compile-the-contracts)**
+  - **[Run Linter on Files](#run-linter-on-files)**
+  - **[Deployment](#deployment)**
 
-Refresh the list of deployed contracts by running `./scripts/generateDeploymentsMarkdown.sh`.
+---
+
+## Deployed Addresses
 
-### Current version
+Refresh the list of deployed contracts by running `./scripts/populateReadme.sh`.
 
-#### Sepolia
+### Sepolia
 
+- [RouterArbToGnosisDevnet](https://sepolia.etherscan.io/address/0xA699e7246D7AF936752789408A071805CC8c99c3)
+- [RouterArbToGnosisTestnet](https://sepolia.etherscan.io/address/0x22d70804d4Ef5BB206C6B39e3267DFe8a0f97d27)
 - [VeaOutboxArbToEthDevnet](https://sepolia.etherscan.io/address/0xb8BF3B6bd3E1a0Cc9E2dB77dd492503310514674)
+- [VeaOutboxArbToEthTestnet](https://sepolia.etherscan.io/address/0x209BFdC6B7c66b63A8382196Ba3d06619d0F12c9)
 
-#### Arbitrum Sepolia
+### Arbitrum Sepolia
 
 - [VeaInboxArbToEthDevnet](https://sepolia.arbiscan.io/address/0x0B5851fE2a931F619F73E739E5435C43976f1D68)
+- [VeaInboxArbToEthTestnet](https://sepolia.arbiscan.io/address/0xE12daFE59Bc3A996362d54b37DFd2BA9279cAd06)
+- [VeaInboxArbToGnosisDevnet](https://sepolia.arbiscan.io/address/0x496df82A2fE2f4aa6903C8bdcE759a94505E7D0c)
+- [VeaInboxArbToGnosisTestnet](https://sepolia.arbiscan.io/address/0x854374483572FFcD4d0225290346279d0718240b)
 
-#### Chiado
+### Chiado
 
 - [VeaInboxGnosisToArbDevnet](https://blockscout.com/gnosis/chiado/address/0xc0804E4FcEEfD958050356A429DAaaA71aA39385)
-- [VeaInboxGnosisToArbTestnet](https://blockscout.com/gnosis/chiado/address/0xC21c20a719fAc23c54c336FA0E16a0CFdC4baA00)
-- [VeaOutboxArbToGnosisDevnet](https://blockscout.com/gnosis/chiado/address/0x9481b3A49ac67d03D9022E6200eFD81850BADDB4)
-- [VeaOutboxArbToGnosisTestnet](https://blockscout.com/gnosis/chiado/address/0x931FA807020231bCE1340Be8E1e5054207BbAFEd)
+- [VeaOutboxArbToGnosisDevnet](https://blockscout.com/gnosis/chiado/address/0xAebcedf346f168E5CEaB7Cd367118d2176486ad7)
+- [VeaOutboxArbToGnosisTestnet](https://blockscout.com/gnosis/chiado/address/0x2f1788F7B74e01c4C85578748290467A5f063B0b)
 
 ## Getting Started
 
@@ -74,7 +92,7 @@ The ones below are optional:
 
 #### 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.
+If some of the constructor parameters needs to change, you need to update the files in the `deploy/` directory.
 
 #### 2. Deploy to a Local Network
 
@@ -111,13 +129,13 @@ yarn deploy --network arbitrum --tags ArbToGnosisInbox
 The deployed addresses should be output to the screen after the deployment is complete.
 If you miss that, you can always go to the `deployments/<network>` directory and look for the respective file.
 
-#### Running Test Fixtures
+#### 4. Running Test Fixtures
 
 ```bash
 yarn test
 ```
 
-#### 4. Verify the Source Code
+#### 5. Verify the Source Code
 
 This must be done for each network separately.
 

contracts/README.md.template

@@ -0,0 +1,119 @@
+# @kleros/vea-contracts
+
+Smart contracts for Vea.
+
+---
+$toc
+---
+
+## Deployed Addresses
+
+Refresh the list of deployed contracts by running `./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 check
+```
+
+### Deployment
+
+**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**.
+
+#### 1. Update the Constructor Parameters (optional)
+
+If some of the constructor parameters needs to change, you need to update the files in the `deploy/` directory.
+
+#### 2. Deploy to a Local Network
+
+```bash
+yarn start-local
+```
+
+#### 3. Deploy to Public Networks
+
+##### Testnets
+
+```bash
+# arbitrumSepolia -> Sepolia
+yarn deploy --network sepolia --tags ArbSepoliaToSepoliaOutbox
+yarn deploy --network arbitrumSepolia --tags ArbSepoliaToSepoliaInbox
+
+# arbitrumSepolia -> Chiado
+yarn deploy --network chiado --tags ArbSepoliaToChiadoOutbox
+yarn deploy --network arbitrumSepolia --tags ArbSepoliaToChiadoInbox
+```
+
+##### Mainnets
+
+```bash
+# Arbitrum -> Ethereum
+yarn deploy --network mainnet --tags ArbToEthOutbox
+yarn deploy --network arbitrum --tags ArbToEthInbox
+
+# Arbitrum -> Gnosis chain
+yarn deploy --network gnosischain --tags ArbToGnosisOutbox
+yarn deploy --network arbitrum --tags ArbToGnosisInbox
+```
+
+The deployed addresses should be output to the screen after the deployment is complete.
+If you miss that, you can always go to the `deployments/<network>` directory and look for the respective file.
+
+#### 4. Running Test Fixtures
+
+```bash
+yarn test
+```
+
+#### 5. Verify the Source Code
+
+This must be done for each network separately.
+
+```bash
+# explorer
+yarn etherscan-verify --network <arbitrumSepolia|arbitrum|sepolia|mainnet|chiado|gnosischain>
+
+# sourcify
+yarn sourcify --network <arbitrumSepolia|arbitrum|sepolia|mainnet|chiado|gnosischain>
+```

contracts/deploy/01-outbox/01-arb-sepolia-to-chiado-outbox.ts

@@ -1,7 +1,7 @@
 import { parseEther } from "ethers";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
-import getContractAddress from "../../deploy-helpers/getContractAddress";
+import getContractAddress from "../utils/getContractAddress";
 import { ethers } from "hardhat";
 
 enum ReceiverChains {

contracts/deploy/01-outbox/01-arb-sepolia-to-sepolia-outbox.ts

@@ -1,7 +1,7 @@
 import { parseEther } from "ethers";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
-import getContractAddress from "../../deploy-helpers/getContractAddress";
+import getContractAddress from "../utils/getContractAddress";
 import { ethers } from "hardhat";
 
 enum ReceiverChains {

contracts/deploy/01-outbox/01-arb-to-eth-outbox.ts

@@ -1,7 +1,7 @@
 import { parseEther } from "ethers";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
-import getContractAddress from "../../deploy-helpers/getContractAddress";
+import getContractAddress from "../utils/getContractAddress";
 import { ethers } from "hardhat";
 
 enum ReceiverChains {

contracts/deploy/01-outbox/01-arb-to-gnosis-outbox.ts

@@ -1,7 +1,7 @@
 import { parseEther } from "ethers";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
-import getContractAddress from "../../deploy-helpers/getContractAddress";
+import getContractAddress from "../utils/getContractAddress";
 import { ethers } from "hardhat";
 
 enum ReceiverChains {

contracts/deploy/01-outbox/01-chiado-to-arb-sepolia-outbox.ts

@@ -1,7 +1,7 @@
 import { parseEther } from "ethers";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
-import getContractAddress from "../../deploy-helpers/getContractAddress";
+import getContractAddress from "../utils/getContractAddress";
 import { ethers } from "hardhat";
 
 enum ReceiverChains {

contracts/deploy/01-outbox/01-gnosis-to-arb-outbox.ts

@@ -1,7 +1,7 @@
 import { parseEther } from "ethers";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
-import getContractAddress from "../../deploy-helpers/getContractAddress";
+import getContractAddress from "../utils/getContractAddress";
 
 enum ReceiverChains {
   ARBITRUM_SEPOLIA = 421614,

contracts/deploy/02-inbox/02-arb-to-gnosis-inbox.ts

@@ -1,6 +1,6 @@
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { DeployFunction } from "hardhat-deploy/types";
-import getContractAddress from "../../deploy-helpers/getContractAddress";
+import getContractAddress from "../utils/getContractAddress";
 
 enum SenderChains {
   ARBITRUM = 42161,