Skip to content

Commit a1019b1

Browse files
committed
docs: improve propose_upgrade and approve_upgrade
1 parent 22230bd commit a1019b1

File tree

2 files changed

+32
-41
lines changed

2 files changed

+32
-41
lines changed

docs/0_internal/3_b_2_propose_upgrade.md

Lines changed: 30 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,78 +6,72 @@ After deploying a new implementation candidate for the upgrade, you need to prop
66

77
To propose the upgrade transaction you can follow the steps below:
88

9-
1. If you want to upgrade the ```alignedLayerServiceManager``` get the ```alignedLayerServiceManager``` and ```alignedServiceManagerImplementation``` address from ```contracts/script/output/mainnet/alignedlayer_deployment_output.json``` or ```contracts/script/output/holesky/alignedlayer_deployment_output.json``` or ```contracts/script/output/sepolia/alignedlayer_deployment_output.json```.
10-
11-
If you want to upgrade the ```batcherPaymentService``` get the ```batcherPaymentServiceImplementation``` address from ```contracts/script/output/mainnet/alignedlayer_deployment_output.json``` or ```contracts/script/output/holesky/alignedlayer_deployment_output.json``` or ```contracts/script/output/sepolia/alignedlayer_deployment_output.json```.
9+
1. Go to [Safe](https://app.safe.global/home)
1210

13-
2. If you want to upgrade the ```alignedLayerServiceManager``` generate the `calldata` for the upgrade transaction by running:
14-
15-
```bash
16-
cast calldata "upgrade(address, address)" <alignedLayerServiceManager> <alignedLayerServiceManagerImplementation>
17-
```
18-
19-
If you want to upgrade the ```batcherPaymentService``` generate the `calldata` for the upgrade transaction by running:
20-
21-
```bash
22-
cast calldata "upgradeTo(address)" <batcherPaymentServiceImplementation>
23-
```
24-
25-
3. Verify the contract bytecode running the following command:
26-
27-
```
28-
TODO
29-
```
30-
31-
4. Once the proposed upgrade is validated, you can create the upgrade transaction on [Safe](https://app.safe.global/home)
32-
33-
5. Click on `New transaction` -> `Transaction Builder`
11+
2. Click on `New transaction` -> `Transaction Builder`
3412

3513
![New transaction](./images/3_b_2_multisig_1.png)
3614

3715
![Transaction Builder](./images/3_b_2_multisig_2.png)
3816

39-
6. Enable `Custom data`
17+
3. Enable `Custom data`
4018

41-
7. Get the `ProxyAdmin` address from ```contracts/script/output/mainnet/alignedlayer_deployment_output.json``` or ```contracts/script/output/holesky/alignedlayer_deployment_output.json``` or ```contracts/script/output/sepolia/alignedlayer_deployment_output.json```, and paste it on `Enter Address or ENS Name`
19+
4. Get the `alignedLayerProxyAdmin` address from ```contracts/script/output/mainnet/alignedlayer_deployment_output.json``` or ```contracts/script/output/holesky/alignedlayer_deployment_output.json``` or ```contracts/script/output/sepolia/alignedlayer_deployment_output.json```, and paste it on `Enter Address or ENS Name`
4220

43-
8. Once you paste the `ProxyAdmin` address, the ABI should be automatically filled.
21+
5. Once you paste the `alignedLayerProxyAdmin` address, the ABI should be automatically filled.
4422

4523
![Enter Address or ENS Name](./images/3_b_2_multisig_3.png)
4624

4725
![Enter ABI](./images/3_b_2_multisig_4.png)
4826

49-
9. Set the `ETH Value` as 0
27+
6. Set the `ETH Value` as 0
5028

5129
![ETH Value](./images/3_b_2_multisig_5.png)
5230

53-
10. Paste the calldata obtained from the deployment of the new implementation on the `Data` box and click on `+ Add new transaction`.
31+
7. If you want to upgrade the ```alignedLayerServiceManager``` get the ```alignedLayerServiceManager``` and ```alignedServiceManagerImplementation``` address from ```contracts/script/output/mainnet/alignedlayer_deployment_output.json``` or ```contracts/script/output/holesky/alignedlayer_deployment_output.json``` or ```contracts/script/output/sepolia/alignedlayer_deployment_output.json```.
32+
33+
If you want to upgrade the ```batcherPaymentService``` get the ```batcherPaymentServiceImplementation``` address from ```contracts/script/output/mainnet/alignedlayer_deployment_output.json``` or ```contracts/script/output/holesky/alignedlayer_deployment_output.json``` or ```contracts/script/output/sepolia/alignedlayer_deployment_output.json```.
34+
35+
8. If you want to upgrade the ```alignedLayerServiceManager``` generate the `calldata` for the upgrade transaction by running:
36+
37+
```bash
38+
cast calldata "upgrade(address, address)" <alignedLayerServiceManager> <alignedLayerServiceManagerImplementation>
39+
```
40+
41+
If you want to upgrade the ```batcherPaymentService``` generate the `calldata` for the upgrade transaction by running:
42+
43+
```bash
44+
cast calldata "upgradeTo(address)" <batcherPaymentServiceImplementation>
45+
```
46+
47+
9. Paste the calldata obtained from the deployment of the new implementation on the `Data` box and click on `+ Add new transaction`.
5448

55-
![Data](./images/3_b_2_multisig_6.png)
49+
![Data](./images/3_b_2_multisig_6.png)
5650

57-
You should see the new transaction to be executed on the right side.
51+
You should see the new transaction to be executed on the right side.
5852

59-
11. Click on `Create batch` to create the transaction.
53+
10. Click on `Create batch` to create the transaction.
6054

6155
![Create batch](./images/3_b_2_multisig_7.png)
6256

63-
12. Review and confirm the transaction.
57+
11. Review and confirm the transaction.
6458

6559
To make sure everything is fine, simulate the transaction by clicking on `Simulate batch`
6660

6761
Once the simulation is successful, click on `Send Batch` to send the transaction.
6862

6963
![Simulate batch](./images/3_b_2_multisig_8.png)
7064

71-
13. Confirm the transaction checking the function being called is correct and the contract address is the one you deployed.
65+
12. Confirm the transaction checking the function being called is correct and the contract address is the one you deployed.
7266

7367
If everything is correct, click on `Sign` to send the transaction.
7468

7569
![Confirm transaction](./images/3_b_2_multisig_9.png)
7670

77-
14. Now in your transactions, you should be able to see the newly created transaction.
71+
13. Now in your transactions, you should be able to see the newly created transaction.
7872

7973
![New transaction](./images/3_b_2_multisig_10.png)
8074

81-
15. If the transaction is correctly created, you have to wait until the required Multisig member signs the transaction to send it.
75+
14. If the transaction is correctly created, you have to wait until the required Multisig member signs the transaction to send it.
8276

8377
A guide on how to sign the transaction can be found [here](./3_b_3_approve_upgrade.md)

docs/0_internal/3_b_3_approve_upgrade.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22

33
Once the transaction is proposed, the multisig owners must approve the transaction.
44

5-
## Prerequisites
6-
7-
- One of the multisig owners must have proposed the upgrade transaction using the `calldata` obtained from the deployment of the new implementation.
85

96
## Approve the Upgrade
107

@@ -16,11 +13,11 @@ To approve the upgrade transaction, you can follow the steps below:
1613

1714
3. Click on the transaction and validate the data is correct.
1815

19-
If you are upgrading the AlignedLayerServiceManager or the RegistryCoordinator, the called function must be `upgrade(address, address)`.
16+
If you are upgrading the AlignedLayerServiceManager, the called function must be `upgrade(address, address)`.
2017

2118
Else, if you are upgrading the BatcherPaymentService, the called function must be `upgradeTo(address)`.
2219

23-
Also check contract addresses are the ones you received from the deployment.
20+
Verify the contracts addresses are correct.
2421

2522
![Check details](images/3_b_3_approve_1.png)
2623

0 commit comments

Comments
 (0)