README.md

@kleros/kleros-v2-contracts

Smart contracts for Kleros v2

Deployed Addresses

Refresh the list of deployed contracts by running ./scripts/generateDeploymentsMarkdown.sh.

Rinkeby

• PNK
• ArbitrableExample
• FastBridgeReceiver
• ForeignGateway

Arbitrum Rinkeby

• PNK
• ConstantNG
• DisputeKitClassic
• FastBridgeSender
• HomeGateway
• IncrementalNG
• KlerosCore
• SafeBridgeArbitrum
• SortitionSumTreeFactory

Contributing

Install the Dependencies

yarn install

Run Tests

yarn test

Compile the Contracts

yarn build

Run Linter on Files

yarn lint

Fix Linter Issues on Files

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.

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 (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

yarn hardhat node --tags nothing

Shell 2: the deploy script

yarn hardhat deploy --network localhost --tags HomeChain

3. Deploy to Public Testnets

# To deploy on L2 only
yarn hardhat deploy --network arbitrumRinkeby --tags HomeChain

# To deploy on L1 only
yarn hardhat deploy --network rinkeby --tags ForeignChain

# To deploy both L1 and L2
yarn deploy:staging

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

Shell 1: the node

yarn hardhat node --tags Arbitration,ForeignGateway,HomeGateway

Shell 2: the test script

yarn hardhat test --network localhost test/pre-alpha1/index.ts

4. Verify the Source Code for Contracts

This must be done for each network separately.

yarn hardhat --network <arbitrumRinkeby|arbitrum|rinkeby|mainnet> etherscan-verify