Skip to content

Commit 1593f97

Browse files
JuArceJuArce
committed
docs: update deploy and multisig guides
1 parent 5c6ca4f commit 1593f97

File tree

3 files changed

+79
-22
lines changed

3 files changed

+79
-22
lines changed

‎contracts/script/deploy/config/sepolia/batcher-payment-service.sepolia.config.json‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,10 @@
33
"batcherWallet": "<batcher_wallet_address>",
44
"alignedLayerServiceManager": "<aligned_layer_service_manager_address>"
55
},
6-
"amounts": {
7-
"gasForAggregator": "300000",
8-
"gasPerProof": "21000"
9-
},
106
"permissions": {
117
"owner": "<owner_address>"
128
},
139
"eip712": {
14-
"noncedVerificationDataTypeHash": "41817b5c5b0c3dcda70ccb43ba175fdcd7e586f9e0484422a2c6bba678fdf4a3"
10+
"noncedVerificationDataTypeHash": "0x41817b5c5b0c3dcda70ccb43ba175fdcd7e586f9e0484422a2c6bba678fdf4a3"
1511
}
1612
}

‎docs/3_guides/setup_holesky.md‎

Lines changed: 68 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,27 @@ These contracts are not deployed by Aligned. Current EigenLayer contracts:
77
- [Holesky Contracts](https://github.com/Layr-Labs/eigenlayer-contracts/blob/testnet-holesky/script/configs/holesky/Holesky_current_deployment.config.json)
88
- [Mainnet Contracts](https://github.com/Layr-Labs/eigenlayer-contracts/blob/mainnet/script/configs/mainnet/Mainnet_current_deployment.config.json)
99

10-
### Aligned Contracts: Holesky/Mainnet
10+
## Aligned Contracts: Holesky/Mainnet
1111

12-
To deploy the contracts to Testnet/Mainnet, you will need to set environment variables in a `.env` file in the same
12+
### Deploy Service Manager
13+
14+
To deploy the AlignedLayer contracts to Testnet/Mainnet, you will need to set environment variables in a `.env` file in the same
1315
directory as the deployment script (`contracts/scripts/`).
1416

1517
The necessary environment variables are:
1618

17-
| Variable Name | Description |
18-
|---------------------------------|-----------------------------------------------------------------------|
19-
| `RPC_URL` | The RPC URL of the network you want to deploy to. |
20-
| `PRIVATE_KEY` | The private key of the account you want to deploy the contracts with. |
21-
| `EXISTING_DEPLOYMENT_INFO_PATH` | The path to the file containing the deployment info about EigenLayer. |
22-
| `DEPLOY_CONFIG_PATH` | The path to the deployment config file. |
23-
| `OUTPUT_PATH` | The path to the file where the deployment info will be saved. |
19+
| Variable Name | Description |
20+
|---------------------------------------|-------------------------------------------------------------------------|
21+
| `RPC_URL` | The RPC URL of the network you want to deploy to. |
22+
| `PRIVATE_KEY` | The private key of the account you want to deploy the contracts with. |
23+
| `EXISTING_DEPLOYMENT_INFO_PATH` | The path to the file containing the deployment info about EigenLayer. |
24+
| `DEPLOY_CONFIG_PATH` | The path to the deployment config file for the Service Manager. |
25+
| `OUTPUT_PATH` | The path to the file where the deployment info will be saved. |
26+
| `ETHERSCAN_API_KEY` | API KEY to verify the contracts in Etherscan. |
27+
| `MULTISIG` | This is required for upgrade to specify is you are using a multisig. |
2428

2529
You can find an example `.env` file in [.env.example.holesky](../../contracts/scripts/.env.example.holesky)
2630

27-
Then run the following command:
28-
29-
```bash
30-
make deploy_aligned_contracts
31-
```
32-
3331
You need to complete the `DEPLOY_CONFIG_PATH` file with the following information:
3432

3533
```json
@@ -55,12 +53,67 @@ You need to complete the `DEPLOY_CONFIG_PATH` file with the following informatio
5553

5654
You can find an example config file in `contracts/script/deploy/config/holesky/aligned.holesky.config.json`.
5755

56+
Then run the following command:
57+
58+
```bash
59+
make deploy_aligned_contracts
60+
```
61+
62+
### Deploy Batcher Payment Service
63+
64+
### Deploy Service Manager
65+
66+
To deploy the Batcher Payment Service contract to Testnet/Mainnet, you will need to set environment variables in a `.env` file in the same
67+
directory as the deployment script (`contracts/scripts/`).
68+
69+
The necessary environment variables are:
70+
71+
| Variable Name | Description |
72+
|---------------------------------------|-------------------------------------------------------------------------|
73+
| `RPC_URL` | The RPC URL of the network you want to deploy to. |
74+
| `PRIVATE_KEY` | The private key of the account you want to deploy the contracts with. |
75+
| `EXISTING_DEPLOYMENT_INFO_PATH` | The path to the file containing the deployment info about EigenLayer. |
76+
| `DEPLOY_CONFIG_PATH` | The path to the deployment config file for the Service Manager. |
77+
| `BATCHER_PAYMENT_SERVICE_CONFIG_PATH` | The path to the deployment config file for the Batcher Payment Service. |
78+
| `OUTPUT_PATH` | The path to the file where the deployment info will be saved. |
79+
| `ETHERSCAN_API_KEY` | API KEY to verify the contracts in Etherscan. |
80+
| `MULTISIG` | This is required for upgrade to specify is you are using a multisig. |
81+
82+
You can find an example `.env` file in [.env.example.holesky](../../contracts/scripts/.env.example.holesky)
83+
84+
You need to complete the `BATCHER_PAYMENT_SERVICE_CONFIG_PATH` file with the following information:
85+
86+
```json
87+
{
88+
"address": {
89+
"batcherWallet": "<batcher_wallet_address>",
90+
"alignedLayerServiceManager": "<aligned_layer_service_manager_address>"
91+
},
92+
"permissions": {
93+
"owner": "<owner_address>"
94+
},
95+
"eip712": {
96+
"noncedVerificationDataTypeHash": "0x41817b5c5b0c3dcda70ccb43ba175fdcd7e586f9e0484422a2c6bba678fdf4a3"
97+
}
98+
}
99+
```
100+
101+
Then run the following command:
102+
103+
```bash
104+
make deploy_batcher_payment_service
105+
```
106+
107+
### Upgrade Service Manager
108+
58109
To upgrade the Service Manager Contract in Testnet/Mainnet, run:
59110

60111
```bash
61112
make upgrade_aligned_contracts
62113
```
63114

115+
### Upgrade Registry Coordinator
116+
64117
To upgrade the Registry Coordinator in Testnet/Mainnet, run:
65118

66119
```bash

‎docs/multisig.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
1+
This file temporarily holds the previous multisig docs:
2+
3+
## Multisig Usage
4+
15
> [!WARNING]
26
> Safe Multisig Wallet is not currently supported in Holesky Testnet.
3-
> This guide is ran in Sepolia
7+
> For this reason, we deployed EigenLayer contracts in Sepolia to test the upgrade on AlignedLayer Contracts.
8+
9+
> [!NOTE]
10+
> EigenLayer Sepolia contracts information is available in `contracts/script/output/sepolia/eigenlayer_deployment_output.json`.
411
5-
# Multisig
12+
> [!NOTE]
13+
> You can find a guide on how to Deploy or Upgrade the contracts [here](./3_guides/setup_holesky.md).
614
715
In this guide we make an upgrade of Aligned Layer Service Manager contract using a multisig wallet. This is important to ensure not one party can do an upgrade, and helps ensure the team is not locked out of upgrading the network due to a loss of keys.
816

0 commit comments

Comments
 (0)