Skip to content

Commit 12e50db

Browse files
committed
docs: improve deploy_new_impl guide
1 parent 328a4f8 commit 12e50db

File tree

2 files changed

+44
-59
lines changed

2 files changed

+44
-59
lines changed

Makefile

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -572,9 +572,9 @@ deploy_pauser_registry: ## Deploy Pauser Registry
572572
@echo "Deploying Pauser Registry..."
573573
@. contracts/scripts/.env && . contracts/scripts/deploy_pauser_registry.sh
574574

575-
upgrade_aligned_contracts: ## Upgrade Aligned Contracts
576-
@echo "Upgrading Aligned Contracts..."
577-
@. contracts/scripts/.env && . contracts/scripts/upgrade_aligned_contracts.sh
575+
upgrade_aligned_contracts: ## Upgrade Aligned Contracts. Parameters: NETWORK=<mainnet|holesky|sepolia>
576+
@echo "Upgrading Aligned Contracts on $(NETWORK) network..."
577+
@. contracts/scripts/.env.$(NETWORK) && . contracts/scripts/upgrade_aligned_contracts.sh
578578

579579
upgrade_pauser_aligned_contracts: ## Upgrade Aligned Contracts with Pauser initialization
580580
@echo "Upgrading Aligned Contracts with Pauser initialization..."
@@ -612,9 +612,9 @@ deploy_batcher_payment_service: ## Deploy BatcherPayments contract. Parameters:
612612
@echo "Deploying BatcherPayments contract on $(NETWORK) network..."
613613
@. contracts/scripts/.env.$(NETWORK) && . contracts/scripts/deploy_batcher_payment_service.sh
614614

615-
upgrade_batcher_payment_service:
616-
@echo "Upgrading BatcherPayments contract..."
617-
@. contracts/scripts/.env && . contracts/scripts/upgrade_batcher_payment_service.sh
615+
upgrade_batcher_payment_service: ## Upgrade BatcherPayments contract. Parameters: NETWORK=<mainnet|holesky|sepolia
616+
@echo "Upgrading BatcherPayments Contract on $(NETWORK) network..."
617+
@. contracts/scripts/.env.$(NETWORK) && . contracts/scripts/upgrade_batcher_payment_service.sh
618618

619619
build_aligned_contracts:
620620
@cd contracts/src/core && forge build

docs/0_internal/3_b_1_deploy_new_impl.md

Lines changed: 38 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,38 @@ To deploy a new implementation, you can follow the steps below.
66

77
1. Make sure you have set variables as specified in the [Deploy Contracts Guide](./2_deploy_contracts.md).
88

9-
2. Add the following variables to the `.env` file:
10-
11-
```makefile
12-
MULTISIG=true
13-
```
9+
2. Set ```MULTISIG=true``` on the ```.env``` used to deploy. ```contracts/scripts/.env.mainnet``` or ```contracts/scripts/.env.holesky``` or ```contracts/scripts/.env.sepolia```
1410

1511
## What contracts can be upgraded?
1612

1713
You can deploy the new implementation of the following contracts:
1814

1915
- AlignedLayerServiceManager
2016
- BatcherPaymentService
21-
- RegistryCoordinator
2217

23-
### Deploy New Implementation for AlignedLayerServiceManager
18+
## Deploy New Implementation for AlignedLayerServiceManager
2419

2520
1. Deploy the new implementation by running:
2621

27-
```sh
28-
make upgrade_aligned_contracts
22+
For **Mainnet** deployment:
23+
24+
```bash
25+
make upgrade_aligned_contracts NETWORK=mainnet
2926
```
3027

31-
If the new implementation is correctly deployed, the script will show the following message:
28+
For **Holesky** deployment:
29+
30+
```bash
31+
make upgrade_aligned_contracts NETWORK=holesky
32+
```
33+
34+
For **Sepolia** deployment:
35+
36+
```bash
37+
make upgrade_aligned_contracts NETWORK=sepolia
38+
```
39+
40+
If the new implementation is correctly deployed, the terminal will show the following message:
3241

3342
```sh
3443
The new aligned layer service manager implementation is <new_aligned_layer_service_manager_implementation>
@@ -60,18 +69,31 @@ You can deploy the new implementation of the following contracts:
6069
>
6170
> Make sure the `alignedServiceManagerImplementation` address is the same as the one you deployed in this guide.
6271

63-
### Deploy New Implementation for BatcherPaymentService
72+
## Deploy New Implementation for BatcherPaymentService
6473

6574
1. Deploy the new implementation by running:
6675

67-
```shell
68-
make upgrade_batcher_payment_service
76+
For **Mainnet** deployment:
77+
78+
```bash
79+
make upgrade_batcher_payment_service NETWORK=mainnet
6980
```
81+
82+
For **Holesky** deployment:
83+
84+
```bash
85+
make upgrade_batcher_payment_service NETWORK=holesky
86+
```
87+
88+
For **Sepolia** deployment:
89+
90+
```bash
91+
make upgrade_batcher_payment_service NETWORK=sepolia
92+
```
7093

71-
If the new implementation is correctly deployed, the script will show the following message:
94+
If the new implementation is correctly deployed, the script will show the following message:
7295

73-
`You can propose the upgrade transaction with the multisig using this calldata
74-
<calldata>`
96+
`You can propose the upgrade transaction with the multisig using this calldata <calldata>`
7597

7698
You should save this `calldata` for later use.
7799

@@ -94,43 +116,6 @@ You can deploy the new implementation of the following contracts:
94116
> [!NOTE]
95117
> Make sure the `batcherPaymentServiceImplementation` address is the same as the one you deployed in this guide.
96118

97-
### Deploy New Implementation for RegistryCoordinator
98-
99-
1. Deploy the new implementation by running:
100-
101-
```sh
102-
make upgrade_registry_coordinator
103-
```
104-
105-
If the new implementation is correctly deployed, the script will show the following message:
106-
107-
`
108-
You can propose the upgrade transaction with the multisig using this calldata
109-
<calldata>
110-
`
111-
112-
You should save this `calldata` for later use.
113-
114-
2. Get the `upgrade` function signature:
115-
116-
```bash
117-
cast sig "upgrade(address, address)"
118-
```
119-
120-
This will show the `upgrade` signature hash: `0x99a88ec4`.
121-
122-
3. Validate the `calldata` by running:
123-
124-
```sh
125-
cast calldata-decode "upgrade(address, address)" <calldata>
126-
```
127-
128-
This will show two addresses. The first one is the `registryCoordinator` address, and the second one is the new implementation address of `registryCoordinatorImplementation`.
129-
130-
> [!NOTE]
131-
> Make sure the `registryCoordinator` address is the same as the one you deployed in the [Deploy Contracts Guide](./2_deploy_contracts.md).
132-
>
133-
> Make sure the `registryCoordinatorImplementation` address is the same as the one you deployed in this guide.
134119

135120
## Next Steps
136121

0 commit comments

Comments
 (0)