Skip to content

Commit b43fb66

Browse files
committed
docs: updated readme and md generator
1 parent 10d4679 commit b43fb66

File tree

2 files changed

+25
-81
lines changed

2 files changed

+25
-81
lines changed

contracts/README.md

+21-69
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,31 @@
1-
# @kleros/kleros-v2-contracts
1+
# @kleros/vea-contracts
22

3-
Smart contracts for Kleros v2
3+
Smart contracts for Vea.
44

55
## Deployed Addresses
66

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

9-
### v2-prealpha-3
9+
### Current version
1010

1111
#### Goerli
1212

13-
- [PNK](https://goerli.etherscan.io/token/0xA3B02bA6E10F55fb177637917B1b472da0110CcC)
14-
- [ArbitrableExample](https://goerli.etherscan.io/address/0x04Fb43F2Ce076867b5ba38750Ecb2cc6BDe78D61)
1513
- [FastBridgeReceiverOnEthereum](https://goerli.etherscan.io/address/0x87142b7E9C7D026776499120D902AF8896C07894)
1614
- [ForeignGatewayOnEthereum](https://goerli.etherscan.io/address/0xf08273e2B35E78509B027f6FAa32485844EA7cCA)
1715

18-
#### Arbitrum Goerli (Nitro)
19-
20-
- [PNK](https://goerli-rollup-explorer.arbitrum.io/token/0x4DEeeFD054434bf6721eF39Aa18EfB3fd0D12610/token-transfers)
21-
- [DisputeKitClassic](https://goerli-rollup-explorer.arbitrum.io/address/0x8F1a2B8F9b04320375856580Fc6B1669Cb12a9EE)
22-
- [DisputeResolver](https://goerli-rollup-explorer.arbitrum.io/address/0x04Fb43F2Ce076867b5ba38750Ecb2cc6BDe78D61)
23-
- [FastBridgeSender](https://goerli-rollup-explorer.arbitrum.io/address/0xcFc0b84419583ff7b32fD5139B789cE858517d4C)
24-
- [HomeGatewayToEthereum](https://goerli-rollup-explorer.arbitrum.io/address/0xc7e3BF90299f6BD9FA7c3703837A9CAbB5743636)
25-
- [IncrementalNG](https://goerli-rollup-explorer.arbitrum.io/address/0x99c1f883f0f5de1737099F1BCB268d1f8D450f8b)
26-
- [KlerosCore](https://goerli-rollup-explorer.arbitrum.io/address/0x87142b7E9C7D026776499120D902AF8896C07894)
27-
- [PolicyRegistry](https://goerli-rollup-explorer.arbitrum.io/address/0xf637A0a4415CCFB97407846486b6be663d3C33ef)
28-
- [SortitionSumTreeFactory](https://goerli-rollup-explorer.arbitrum.io/address/0x26858D60FE92b50b34e236B46874e02724344275)
29-
30-
#### Rinkeby
31-
32-
- [PNK](https://rinkeby.etherscan.io/token/0x14aba1fa8a31a8649e8098ad067b739cc5708f30)
33-
- [ArbitrableExample](https://rinkeby.etherscan.io/address/0xc0fcc96BFd78e36550FCaB434A9EE1210B57225b)
34-
- [FastBridgeReceiverOnEthereum](https://rinkeby.etherscan.io/address/0x545C731e84c0034d58e57E476A3b7C3929d070CC)
35-
- [ForeignGatewayOnEthereum](https://rinkeby.etherscan.io/address/0x8681CE0CA5706Cf4732d9060e8eC9f865F7d546a)
36-
37-
#### Arbitrum Rinkeby
38-
39-
- [PNK](https://testnet.arbiscan.io/token/0x364530164a2338cdba211f72c1438eb811b5c639)
40-
- [DisputeKitClassic](https://testnet.arbiscan.io/address/0xA2c538AA05BBCc44c213441f6f3777223D2BF9e5)
41-
- [DisputeResolver](https://testnet.arbiscan.io/address/0x67e8191F61466c57A17542A52F9f39f336A242fD)
42-
- [FastBridgeSender](https://testnet.arbiscan.io/address/0xf8A4a85e7153374A1b9BDA763a84252eC286843b)
43-
- [HomeGatewayToEthereum](https://testnet.arbiscan.io/address/0x4e894c2B60214beC53B60D09F39544518296C07B)
44-
- [IncrementalNG](https://testnet.arbiscan.io/address/0x078dAd05373d19d7fd6829735b765F12242a4300)
45-
- [KlerosCore](https://testnet.arbiscan.io/address/0x815d709EFCF5E69e2e9E2F8d3815d762496a2f0F)
46-
- [PNK](https://testnet.arbiscan.io/address/0x364530164a2338cdba211f72c1438eb811b5c639)
47-
- [PolicyRegistry](https://testnet.arbiscan.io/address/0x76262035D1b280cC0b08024177b837893bcAd3DA)
48-
- [SortitionSumTreeFactory](https://testnet.arbiscan.io/address/0x48ce286978C74c288eA6Bc9a536BcC899DF8D177)
16+
#### Arbitrum Goerli
17+
18+
- [FastBridgeSender](https://goerli.arbiscan.io/address/0x6b575B3af80aDca9E5ABE1764Ae9dE439e85DEb7)
19+
- [HomeGatewayToEthereum](https://goerli.arbiscan.io/address/0xc7e3BF90299f6BD9FA7c3703837A9CAbB5743636)
20+
- [SenderGatewayToEthereum](https://goerli.arbiscan.io/address/0x6B43B4DA9ad839dc806e696A248731A65F61f5d9)
21+
- [SenderGatewayToGnosis](https://goerli.arbiscan.io/address/0x42319536AA7eD5E0A6CBCAF3FaaDb5243d482C7A)
22+
23+
#### Chiado
24+
25+
- [FastBridgeReceiverOnEthereum](https://blockscout.chiadochain.net/address/0xa1711e979d7F9ae5f4c5Fe57D5fF7d6F5Ae3d418)
26+
- [FastBridgeReceiverOnGnosis](https://blockscout.chiadochain.net/address/0x730Ec040763bf5C4Abac1d66d7c757f6033a3A20)
27+
- [ReceiverGatewayOnEthereum](https://blockscout.chiadochain.net/address/0xD986380c607350762D802646AAad4eea809219Df)
28+
- [ReceiverGatewayOnGnosis](https://blockscout.chiadochain.net/address/0xA1EcD2e86E9C674762aC68de90edfdb171c8e302)
4929

5030
## Getting Started
5131

@@ -108,6 +88,7 @@ If some of the constructor parameters (such as the Meta Evidence) needs to chang
10888

10989
#### 2. Deploy to a Local Network
11090

91+
:warning: TODO: OUTDATED, FIX ME
11192
The complete deployment is multi-chain, so a deployment to the local network can only simulate either the Home chain or the Foreign chain.
11293

11394
**Shell 1: the node**
@@ -124,6 +105,8 @@ yarn hardhat deploy --network localhost --tags HomeChain
124105

125106
#### 3. Deploy to Public Testnets
126107

108+
:warning: TODO: OUTDATED, FIX ME
109+
127110
```bash
128111
# Goerli
129112
yarn hardhat deploy --network arbitrumGoerli --tags Arbitration
@@ -141,6 +124,8 @@ If you miss that, you can always go to the `deployments/<network>` directory and
141124

142125
#### Running Test Fixtures
143126

127+
:warning: TODO: OUTDATED, FIX ME
128+
144129
**Shell 1: the node**
145130

146131
```bash
@@ -160,36 +145,3 @@ This must be done for each network separately.
160145
```bash
161146
yarn hardhat --network <arbitrumGoerli|arbitrumRinkeby|arbitrum|goerli|rinkeby|mainnet> etherscan-verify
162147
```
163-
164-
## Ad-hoc procedures
165-
166-
### Populating the policy registry and courts
167-
168-
#### 1/ Export the registry data from V1
169-
170-
```bash
171-
yarn hardhat run scripts/getPoliciesV1.ts --network mainnet | tee policies.v1.json
172-
yarn hardhat run scripts/getCourtsV1.ts --network mainnet | tee courts.v1.json
173-
```
174-
175-
#### 2/ Import the data to V2 - Local Network
176-
177-
Shell 1:
178-
179-
```bash
180-
yarn hardhat node --tags Arbitration
181-
```
182-
183-
Shell 2:
184-
185-
```bash
186-
yarn hardhat run scripts/populatePolicyRegistry.ts --network localhost
187-
yarn hardhat run scripts/populateCourts.ts --network localhost
188-
```
189-
190-
#### 3/ Import the data to V2 - Public Testnet
191-
192-
```bash
193-
yarn hardhat run scripts/populatePolicyRegistry.ts --network arbitrumRinkeby
194-
yarn hardhat run scripts/populateCourts.ts --network arbitrumRinkeby
195-
```

contracts/scripts/generateDeploymentsMarkdown.sh

+4-12
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,13 @@ function generate() { #deploymentDir #explorerUrl
1414

1515
echo "#### Goerli"
1616
echo
17-
echo "- [PNK](https://goerli.etherscan.io/token/0xA3B02bA6E10F55fb177637917B1b472da0110CcC)"
1817
generate "$SCRIPT_DIR/../deployments/goerli" "https://goerli.etherscan.io/address/"
1918
echo
20-
echo "#### Arbitrum Goerli (Nitro)"
19+
echo "#### Arbitrum Goerli"
2120
echo
22-
echo "- [PNK](https://goerli-rollup-explorer.arbitrum.io/token/0x4DEeeFD054434bf6721eF39Aa18EfB3fd0D12610/token-transfers)"
23-
generate "$SCRIPT_DIR/../deployments/arbitrumGoerli" "https://goerli-rollup-explorer.arbitrum.io/address/"
21+
generate "$SCRIPT_DIR/../deployments/arbitrumGoerli" "https://goerli.arbiscan.io/address/"
2422
echo
23+
echo "#### Chiado"
2524
echo
26-
echo "#### Rinkeby - DEPRECATED"
25+
generate "$SCRIPT_DIR/../deployments/chiado" "https://blockscout.chiadochain.net/address/"
2726
echo
28-
echo "- [PNK](https://rinkeby.etherscan.io/token/0x14aba1fa8a31a8649e8098ad067b739cc5708f30)"
29-
generate "$SCRIPT_DIR/../deployments/rinkeby" "https://rinkeby.etherscan.io/address/"
30-
echo
31-
echo "#### Arbitrum Rinkeby (Classic) - DEPRECATED"
32-
echo
33-
echo "- [PNK](https://testnet.arbiscan.io/token/0x364530164a2338cdba211f72c1438eb811b5c639)"
34-
generate "$SCRIPT_DIR/../deployments/arbitrumRinkeby" "https://testnet.arbiscan.io/address/"

0 commit comments

Comments
 (0)